(async)
diff --git a/docs/Checklists.html b/docs/Checklists.html
index f6d08cb..c9b03c5 100644
--- a/docs/Checklists.html
+++ b/docs/Checklists.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -1036,7 +1036,7 @@ Parameters:
diff --git a/docs/Clickup.html b/docs/Clickup.html
index e991c56..21f3cea 100644
--- a/docs/Clickup.html
+++ b/docs/Clickup.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -1441,7 +1441,7 @@ Properties
diff --git a/docs/Comments.html b/docs/Comments.html
index 508ea48..1f95496 100644
--- a/docs/Comments.html
+++ b/docs/Comments.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -536,7 +536,7 @@ Parameters:
diff --git a/docs/Folders.html b/docs/Folders.html
index 85a5966..f52e6fb 100644
--- a/docs/Folders.html
+++ b/docs/Folders.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -1658,7 +1658,7 @@ Parameters:
diff --git a/docs/Goals.html b/docs/Goals.html
index 6f71c07..e0c566a 100644
--- a/docs/Goals.html
+++ b/docs/Goals.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -831,7 +831,7 @@ Parameters:
diff --git a/docs/KeyResults.html b/docs/KeyResults.html
index 7d6ed2a..4643c70 100644
--- a/docs/KeyResults.html
+++ b/docs/KeyResults.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -536,7 +536,7 @@ Parameters:
diff --git a/docs/Lists.html b/docs/Lists.html
index e698835..c9c03bd 100644
--- a/docs/Lists.html
+++ b/docs/Lists.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -563,6 +563,165 @@ Parameters:
+
+
+
+
+ (async) addTaskToList(listId, taskId)
+
+
+
+
+
+
+
+
+
+ - Source:
+ -
+ routes/Lists.js, line 190
+
+
+
+
+
+
+
+ Add task to a list
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ listId
+
+
+String
+
+
+
+
+
+
+
+
+
+ The list id
+
+
+
+
+
+ taskId
+
+
+String
+
+
+
+
+
+
+
+
+
+ The task id
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -1607,6 +1766,142 @@ Parameters:
+
+
+
+
+ (async) getListMembers(listId)
+
+
+
+
+
+
+
+
+
+ - Source:
+ -
+ routes/Lists.js, line 213
+
+
+
+
+
+
+
+ Get list members
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ listId
+
+
+String
+
+
+
+
+
+
+
+
+
+ The list id
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -2217,6 +2512,165 @@ Parameters:
+
+
+
+
+ (async) removeTaskFromList(listId, taskId)
+
+
+
+
+
+
+
+
+
+ - Source:
+ -
+ routes/Lists.js, line 202
+
+
+
+
+
+
+
+ Remove a task from a list
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ listId
+
+
+Sting
+
+
+
+
+
+
+
+
+
+ The list id
+
+
+
+
+
+ taskId
+
+
+String
+
+
+
+
+
+
+
+
+
+ The task id
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -2395,7 +2849,7 @@ Parameters:
diff --git a/docs/Spaces.html b/docs/Spaces.html
index 87df243..ab2000e 100644
--- a/docs/Spaces.html
+++ b/docs/Spaces.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -2280,7 +2280,7 @@ Parameters:
diff --git a/docs/Tasks.html b/docs/Tasks.html
index feb774b..5400460 100644
--- a/docs/Tasks.html
+++ b/docs/Tasks.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -226,7 +226,7 @@ Methods
- (async) addAttachment(taskId, pathToFile, fileNameopt, optionsopt)
+ (async) addAttachment(taskId, fileSettings, optionsopt)
@@ -238,7 +238,7 @@ (async)
Source:
Parameters:
- Default
-
Description
@@ -343,10 +341,6 @@ Parameters:
-
-
-
-
The task id
Parameters:
- pathToFilefileSettings
-String
+Object
@@ -378,19 +372,34 @@ Parameters:
-
+
+ The file settings
+ Properties
- The path to the file
+
+
+
+
+ Name
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
- fileNamefilePath
@@ -403,26 +412,40 @@ Parameters:
-
-
- <optional>
-
-
+
-
-
+ The path to the file
+
+
+
+
+
+ fileName
-
-
- 'attachment'
-
+String
+
+
+
+
+
- The file name
The name of the attachment file along with its extension type. Example: 'notes.txt'
+
+
+
+
+
+
@@ -454,10 +477,6 @@ Parameters:
-
-
-
-
The parameter options to pass in
(async) add
Source:
(async)
Source:
(async) addGu
Source:
(async) addTag<
Source:
(async) ad
Source:
(async) Source:
(async
Source:
Parameters:
- (async) deleteDependency(taskId, data, optionsopt)
+ (async) deleteDependency(taskId, options)
@@ -2181,7 +2200,7 @@ (async) Source:
Parameters:
Type
- Attributes
-
@@ -2274,14 +2291,6 @@ Parameters:
-
-
-
-
-
-
-
-
@@ -2290,37 +2299,6 @@ Parameters:
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The dependency data
-
-
-
optionsParameters:
-
-
- <optional>
-
-
-
-
-
-
-
@@ -2391,7 +2359,7 @@ (async) Source:
(async) Source:
(async) Source:
Parameters:
+
+
+
+
+ (async) getBulkTimeInStatus(options)
+
+
+
+
+
+
+
+
+
+ - Source:
+ -
+ routes/Tasks.js, line 368
+
+
+
+
+
+
+
+ Get bulk tasks time in status
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+
+ The parameter options to pass in
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -3231,7 +3335,7 @@ (async) ge
Source:
(async) get
Source:
Parameters:
+
+
+
+
+ (async) getTimeInStatus(taskId, options)
+
+
+
+
+
+
+
+
+
+ - Source:
+ -
+ routes/Tasks.js, line 356
+
+
+
+
+
+
+
+ Get tasks time in status
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ taskId
+
+
+String
+
+
+
+
+
+
+
+
+
+ The task id
+
+
+
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+
+ The parameter options to pass in
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -3546,7 +3809,7 @@ (async) Source:
(async) re
Source:
(async) remo
Source:
(async) <
Source:
(async) trac
Source:
Parameters:
diff --git a/docs/Teams.html b/docs/Teams.html
index e1bfb10..b167170 100644
--- a/docs/Teams.html
+++ b/docs/Teams.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -5551,7 +5551,7 @@ Parameters:
diff --git a/docs/Views.html b/docs/Views.html
index 3dd5980..2d23dd6 100644
--- a/docs/Views.html
+++ b/docs/Views.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -1158,7 +1158,7 @@ Parameters:
diff --git a/docs/Webhooks.html b/docs/Webhooks.html
index 78b5adc..b27ddae 100644
--- a/docs/Webhooks.html
+++ b/docs/Webhooks.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -536,7 +536,7 @@ Parameters:
diff --git a/docs/index.html b/docs/index.html
index 1ee651c..1e7fea3 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -191,7 +191,7 @@ License
diff --git a/docs/index.js.html b/docs/index.js.html
index 45c4abd..4b1371f 100644
--- a/docs/index.js.html
+++ b/docs/index.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -236,7 +236,7 @@ index.js
diff --git a/docs/routes_Authorization.js.html b/docs/routes_Authorization.js.html
index 162039a..99eff42 100644
--- a/docs/routes_Authorization.js.html
+++ b/docs/routes_Authorization.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -117,7 +117,7 @@ routes/Authorization.js
diff --git a/docs/routes_Checklists.js.html b/docs/routes_Checklists.js.html
index 3e08aab..7ffcbc2 100644
--- a/docs/routes_Checklists.js.html
+++ b/docs/routes_Checklists.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -145,7 +145,7 @@ routes/Checklists.js
diff --git a/docs/routes_Comments.js.html b/docs/routes_Comments.js.html
index 5beb234..1b63066 100644
--- a/docs/routes_Comments.js.html
+++ b/docs/routes_Comments.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -106,7 +106,7 @@ routes/Comments.js
diff --git a/docs/routes_Folders.js.html b/docs/routes_Folders.js.html
index 4d4a587..b1a501a 100644
--- a/docs/routes_Folders.js.html
+++ b/docs/routes_Folders.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -195,7 +195,7 @@ routes/Folders.js
diff --git a/docs/routes_Goals.js.html b/docs/routes_Goals.js.html
index acd396e..036be9f 100644
--- a/docs/routes_Goals.js.html
+++ b/docs/routes_Goals.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -130,7 +130,7 @@ routes/Goals.js
diff --git a/docs/routes_KeyResults.js.html b/docs/routes_KeyResults.js.html
index f3c77ff..715438c 100644
--- a/docs/routes_KeyResults.js.html
+++ b/docs/routes_KeyResults.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -105,7 +105,7 @@ routes/KeyResults.js
diff --git a/docs/routes_Lists.js.html b/docs/routes_Lists.js.html
index e3a8b2f..f217b39 100644
--- a/docs/routes_Lists.js.html
+++ b/docs/routes_Lists.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -238,6 +238,41 @@ routes/Lists.js
endpoint: `${this.route}/${listId}/view`,
});
}
+
+ /**
+ * Add task to a list
+ *
+ * @param {String} listId The list id
+ * @param {String} taskId The task id
+ */
+ async addTaskToList(listId, taskId) {
+ return this._client.post({
+ endpoint: `${this.route}/${listId}/task/${taskId}`,
+ });
+ }
+
+ /**
+ * Remove a task from a list
+ *
+ * @param {Sting} listId The list id
+ * @param {String} taskId The task id
+ */
+ async removeTaskFromList(listId, taskId) {
+ return this._client.delete({
+ endpoint: `${this.route}/${listId}/task/${taskId}`,
+ });
+ }
+
+ /**
+ * Get list members
+ *
+ * @param {String} listId The list id
+ */
+ async getListMembers(listId) {
+ return this._client.get({
+ endpoint: `${this.route}/${listId}/member`,
+ });
+ }
}
module.exports = Lists;
@@ -255,7 +290,7 @@ routes/Lists.js
diff --git a/docs/routes_Spaces.js.html b/docs/routes_Spaces.js.html
index 8ade311..4c5818e 100644
--- a/docs/routes_Spaces.js.html
+++ b/docs/routes_Spaces.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -245,7 +245,7 @@ routes/Spaces.js
diff --git a/docs/routes_Tasks.js.html b/docs/routes_Tasks.js.html
index cefed6b..8c28fc8 100644
--- a/docs/routes_Tasks.js.html
+++ b/docs/routes_Tasks.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -65,7 +65,7 @@ routes/Tasks.js
* @param {Client} client A client instance
*/
constructor(client) {
- this.client = client;
+ this._client = client;
this.route = 'task';
}
@@ -76,7 +76,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async get(taskId, options) {
- return this.client.get({
+ return this._client.get({
endpoint: `${this.route}/${taskId}`,
params: options,
});
@@ -90,7 +90,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async update(taskId, data, options) {
- return this.client.put({
+ return this._client.put({
endpoint: `${this.route}/${taskId}`,
params: options,
data,
@@ -104,7 +104,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async delete(taskId, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}`,
params: options,
});
@@ -114,21 +114,34 @@ routes/Tasks.js
* Add an attachment to a task
*
* @param {String} taskId The task id
- * @param {String} pathToFile The path to the file
- * @param {String} [fileName='attachment'] The file name
+ * @param {Object} fileSettings The file settings
+ * @param {String} fileSettings.filePath The path to the file
+ * @param {String} fileSettings.fileName The name of the attachment file along with its extension type. Example: 'notes.txt'
* @param {Object} [options] The parameter options to pass in
*/
- async addAttachment(taskId, pathToFile, fileName = 'attachment', options) {
+ async addAttachment(taskId, fileSettings, options) {
+ // ensure fileSettings are provided
+ if (fileSettings) {
+ if (!fileSettings.filePath) {
+ throw new Error('A file path must be provided');
+ }
+ if (!fileSettings.fileName) {
+ throw new Error('A file name must be provided');
+ }
+ } else {
+ throw new Error('File settings must be provided');
+ }
+
// building form-data
const form = new FormData();
- form.append('filename', fileName);
- form.append('attachment', createReadStream(pathToFile));
+ form.append('filename', fileSettings.fileName);
+ form.append('attachment', createReadStream(fileSettings.filePath));
// setting headers
const headers = form.getHeaders();
- headers.authorization = this.client._token;
+ headers.authorization = this._client._token;
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/attachment`,
params: options,
data: form,
@@ -144,7 +157,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async addComment(taskId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/comment`,
params: options,
data,
@@ -158,7 +171,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async getComments(taskId, options) {
- return this.client.get({
+ return this._client.get({
endpoint: `${this.route}/${taskId}/comment`,
params: options,
});
@@ -172,7 +185,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async createChecklist(taskId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/checklist`,
params: options,
data,
@@ -188,7 +201,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async setCustomFieldValue(taskId, fieldId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/field/${fieldId}`,
params: options,
data,
@@ -203,7 +216,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async deleteCustomFieldValue(taskId, fieldId, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/field/${fieldId}`,
params: options,
});
@@ -217,7 +230,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async addDependency(taskId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/dependency`,
params: options,
data,
@@ -228,14 +241,12 @@ routes/Tasks.js
* Delete a dependancy for a task
*
* @param {String} taskId The task id
- * @param {Object} data The dependency data
- * @param {Object} [options] The parameter options to pass in
+ * @param {Object} options The parameter options to pass in
*/
- async deleteDependency(taskId, data, options) {
- return this.client.delete({
+ async deleteDependency(taskId, options) {
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/dependency`,
params: options,
- data,
});
}
@@ -247,7 +258,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async addTaskLink(taskId, linksTo, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/link/${linksTo}`,
params: options,
});
@@ -261,7 +272,7 @@ routes/Tasks.js
* @param {String} [options] The parameter options to pass in
*/
async deleteTaskLink(taskId, linksTo, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/link/${linksTo}`,
params: options,
});
@@ -276,7 +287,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async addGuest(taskId, guestId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/guest/${guestId}`,
params: options,
data,
@@ -291,7 +302,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async removeGuest(taskId, guestId, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/guest/${guestId}`,
params: options,
});
@@ -303,7 +314,7 @@ routes/Tasks.js
* @param {String} taskId The task id
*/
async getMembers(taskId) {
- return this.client.get({
+ return this._client.get({
endpoint: `${this.route}/${taskId}/member`,
});
}
@@ -316,7 +327,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async addTag(taskId, tagName, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/tag/${tagName}`,
params: options,
});
@@ -330,7 +341,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async removeTag(taskId, tagName, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/tag/${tagName}`,
params: options,
});
@@ -344,7 +355,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async trackTime(taskId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/time`,
params: options,
data,
@@ -358,7 +369,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async getTrackedTime(taskId, options) {
- return this.client.get({
+ return this._client.get({
endpoint: `${this.route}/${taskId}/time`,
params: options,
});
@@ -373,7 +384,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async editTrackedTime(taskId, intervalId, data, options) {
- return this.client.put({
+ return this._client.put({
endpoint: `${this.route}/${taskId}/time/${intervalId}`,
params: options,
data,
@@ -388,11 +399,36 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async deleteTrackedTime(taskId, intervalId, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/time/${intervalId}`,
params: options,
});
}
+
+ /**
+ * Get tasks time in status
+ *
+ * @param {String} taskId The task id
+ * @param {Object} options The parameter options to pass in
+ */
+ async getTimeInStatus(taskId, options) {
+ return this._client.get({
+ endpoint: `${this.route}/${taskId}/time_in_status`,
+ params: options,
+ });
+ }
+
+ /**
+ * Get bulk tasks time in status
+ *
+ * @param {Object} options The parameter options to pass in
+ */
+ async getBulkTimeInStatus(options) {
+ return this._client.get({
+ endpoint: `${this.route}/bulk_time_in_status/task_ids`,
+ params: options,
+ });
+ }
}
module.exports = Tasks;
@@ -410,7 +446,7 @@ routes/Tasks.js
diff --git a/docs/routes_Teams.js.html b/docs/routes_Teams.js.html
index a6b0292..f94b0e5 100644
--- a/docs/routes_Teams.js.html
+++ b/docs/routes_Teams.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -492,7 +492,7 @@ routes/Teams.js
diff --git a/docs/routes_Views.js.html b/docs/routes_Views.js.html
index 78b49f5..926ddd0 100644
--- a/docs/routes_Views.js.html
+++ b/docs/routes_Views.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -156,7 +156,7 @@ routes/Views.js
diff --git a/docs/routes_Webhooks.js.html b/docs/routes_Webhooks.js.html
index 3c63132..d293778 100644
--- a/docs/routes_Webhooks.js.html
+++ b/docs/routes_Webhooks.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -106,7 +106,7 @@ routes/Webhooks.js
Parameters:
diff --git a/docs/Clickup.html b/docs/Clickup.html index e991c56..21f3cea 100644 --- a/docs/Clickup.html +++ b/docs/Clickup.html @@ -41,7 +41,7 @@ -
Home
Github Repo
Classes
+Home
Github Repo
Classes
@@ -1441,7 +1441,7 @@
diff --git a/docs/Comments.html b/docs/Comments.html index 508ea48..1f95496 100644 --- a/docs/Comments.html +++ b/docs/Comments.html @@ -41,7 +41,7 @@ -
Properties
diff --git a/docs/Comments.html b/docs/Comments.html index 508ea48..1f95496 100644 --- a/docs/Comments.html +++ b/docs/Comments.html @@ -41,7 +41,7 @@ -
Home
Github Repo
Classes
+Home
Github Repo
Classes
@@ -536,7 +536,7 @@
diff --git a/docs/Folders.html b/docs/Folders.html index 85a5966..f52e6fb 100644 --- a/docs/Folders.html +++ b/docs/Folders.html @@ -41,7 +41,7 @@ -
Parameters:
diff --git a/docs/Folders.html b/docs/Folders.html index 85a5966..f52e6fb 100644 --- a/docs/Folders.html +++ b/docs/Folders.html @@ -41,7 +41,7 @@ -
Home
Github Repo
Classes
+Home
Github Repo
Classes
@@ -1658,7 +1658,7 @@
diff --git a/docs/Goals.html b/docs/Goals.html index 6f71c07..e0c566a 100644 --- a/docs/Goals.html +++ b/docs/Goals.html @@ -41,7 +41,7 @@ -
Parameters:
diff --git a/docs/Goals.html b/docs/Goals.html index 6f71c07..e0c566a 100644 --- a/docs/Goals.html +++ b/docs/Goals.html @@ -41,7 +41,7 @@ -
Home
Github Repo
Classes
+Home
Github Repo
Classes
@@ -831,7 +831,7 @@
diff --git a/docs/KeyResults.html b/docs/KeyResults.html index 7d6ed2a..4643c70 100644 --- a/docs/KeyResults.html +++ b/docs/KeyResults.html @@ -41,7 +41,7 @@ -
Parameters:
diff --git a/docs/KeyResults.html b/docs/KeyResults.html index 7d6ed2a..4643c70 100644 --- a/docs/KeyResults.html +++ b/docs/KeyResults.html @@ -41,7 +41,7 @@ -
Home
Github Repo
Classes
+Home
Github Repo
Classes
@@ -536,7 +536,7 @@
diff --git a/docs/Lists.html b/docs/Lists.html index e698835..c9c03bd 100644 --- a/docs/Lists.html +++ b/docs/Lists.html @@ -41,7 +41,7 @@ -
Parameters:
diff --git a/docs/Lists.html b/docs/Lists.html index e698835..c9c03bd 100644 --- a/docs/Lists.html +++ b/docs/Lists.html @@ -41,7 +41,7 @@ -
Home
Github Repo
Classes
+Home
Github Repo
Classes
@@ -563,6 +563,165 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -1607,6 +1766,142 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -2217,6 +2512,165 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -2395,7 +2849,7 @@
diff --git a/docs/Spaces.html b/docs/Spaces.html index 87df243..ab2000e 100644 --- a/docs/Spaces.html +++ b/docs/Spaces.html @@ -41,7 +41,7 @@ -
Parameters:
+ + + + +(async) addTaskToList(listId, taskId)
+ + + + + + +-
+
+
+
- Source: +
- + routes/Lists.js, line 190 +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Add task to a list
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
listId |
+
+
+ + + +String + + + + | + + + + + +The list id |
+
taskId |
+
+
+ + + +String + + + + | + + + + + +The task id |
+
Parameters:
+ + + + +(async) getListMembers(listId)
+ + + + + + +-
+
+
+
- Source: +
- + routes/Lists.js, line 213 +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Get list members
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
listId |
+
+
+ + + +String + + + + | + + + + + +The list id |
+
Parameters:
+ + + + +(async) removeTaskFromList(listId, taskId)
+ + + + + + +-
+
+
+
- Source: +
- + routes/Lists.js, line 202 +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Remove a task from a list
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
listId |
+
+
+ + + +Sting + + + + | + + + + + +The list id |
+
taskId |
+
+
+ + + +String + + + + | + + + + + +The task id |
+
Parameters:
diff --git a/docs/Spaces.html b/docs/Spaces.html index 87df243..ab2000e 100644 --- a/docs/Spaces.html +++ b/docs/Spaces.html @@ -41,7 +41,7 @@ -
Home
Github Repo
Classes
+Home
Github Repo
Classes
@@ -2280,7 +2280,7 @@
diff --git a/docs/Tasks.html b/docs/Tasks.html index feb774b..5400460 100644 --- a/docs/Tasks.html +++ b/docs/Tasks.html @@ -41,7 +41,7 @@ -
Parameters:
diff --git a/docs/Tasks.html b/docs/Tasks.html index feb774b..5400460 100644 --- a/docs/Tasks.html +++ b/docs/Tasks.html @@ -41,7 +41,7 @@ -
Home
Github Repo
Classes
+Home
Github Repo
Classes
@@ -226,7 +226,7 @@ (async)
+
+
+
+
@@ -454,10 +477,6 @@
-
-
-
(async) add
Methods
-(async) addAttachment(taskId, pathToFile, fileNameopt, optionsopt)
+(async) addAttachment(taskId, fileSettings, optionsopt)
@@ -238,7 +238,7 @@(async)
Source:
Parameters:
- Default
-
Description
@@ -343,10 +341,6 @@ Parameters:
-
-
-
-
The task id
Parameters:
- pathToFilefileSettings
-String
+Object
@@ -378,19 +372,34 @@ Parameters:
-
+
+ The file settings
+ Properties
- The path to the file
+
The task id
pathToFilefileSettingsParameters:
-The file settings
+Properties
-The path to the file
| Name | + +Type | + + + + + +Description | +||
|---|---|---|---|---|
fileName |
+ filePath |
@@ -403,26 +412,40 @@ Parameters: |
-
-
- <optional> - - + - - |
+ The path to the file |
+
fileName |
+ - |
-
- 'attachment'
- |
+String
+
+
+
+
+
- The file name |
+
+
+ The name of the attachment file along with its extension type. Example: 'notes.txt' |
+
Parameters:
-The parameter options to pass in
(async) add
Source:
(async)
Source:
(async) addGu
Source:
(async) addTag<
Source:
(async) ad
Source:
(async) Source:
(async
Source:
Parameters:
- (async) deleteDependency(taskId, data, optionsopt)
+ (async) deleteDependency(taskId, options)
@@ -2181,7 +2200,7 @@ (async) Source:
Parameters:
Type
- Attributes
-
@@ -2274,14 +2291,6 @@ Parameters:
-
-
-
-
-
-
-
-
@@ -2290,37 +2299,6 @@ Parameters:
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The dependency data
-
-
-
optionsParameters:
-
-
- <optional>
-
-
-
-
-
-
-
@@ -2391,7 +2359,7 @@ (async) Source:
(async) Source:
(async) Source:
Parameters:
+
+
+
+
+ (async) getBulkTimeInStatus(options)
+
+
+
+
+
+
+
+
+
+ - Source:
+ -
+ routes/Tasks.js, line 368
+
+
+
+
+
+
+
+ Get bulk tasks time in status
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+
+ The parameter options to pass in
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -3231,7 +3335,7 @@ (async) ge
Source:
(async) get
Source:
Parameters:
+
+
+
+
+ (async) getTimeInStatus(taskId, options)
+
+
+
+
+
+
+
+
+
+ - Source:
+ -
+ routes/Tasks.js, line 356
+
+
+
+
+
+
+
+ Get tasks time in status
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ taskId
+
+
+String
+
+
+
+
+
+
+
+
+
+ The task id
+
+
+
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+
+ The parameter options to pass in
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -3546,7 +3809,7 @@ (async) Source:
(async) re
Source:
(async) remo
Source:
(async) <
Source:
(async) trac
Source:
Parameters:
diff --git a/docs/Teams.html b/docs/Teams.html
index e1bfb10..b167170 100644
--- a/docs/Teams.html
+++ b/docs/Teams.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -5551,7 +5551,7 @@ Parameters:
diff --git a/docs/Views.html b/docs/Views.html
index 3dd5980..2d23dd6 100644
--- a/docs/Views.html
+++ b/docs/Views.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -1158,7 +1158,7 @@ Parameters:
diff --git a/docs/Webhooks.html b/docs/Webhooks.html
index 78b5adc..b27ddae 100644
--- a/docs/Webhooks.html
+++ b/docs/Webhooks.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -536,7 +536,7 @@ Parameters:
diff --git a/docs/index.html b/docs/index.html
index 1ee651c..1e7fea3 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -191,7 +191,7 @@ License
diff --git a/docs/index.js.html b/docs/index.js.html
index 45c4abd..4b1371f 100644
--- a/docs/index.js.html
+++ b/docs/index.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -236,7 +236,7 @@ index.js
diff --git a/docs/routes_Authorization.js.html b/docs/routes_Authorization.js.html
index 162039a..99eff42 100644
--- a/docs/routes_Authorization.js.html
+++ b/docs/routes_Authorization.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -117,7 +117,7 @@ routes/Authorization.js
diff --git a/docs/routes_Checklists.js.html b/docs/routes_Checklists.js.html
index 3e08aab..7ffcbc2 100644
--- a/docs/routes_Checklists.js.html
+++ b/docs/routes_Checklists.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -145,7 +145,7 @@ routes/Checklists.js
diff --git a/docs/routes_Comments.js.html b/docs/routes_Comments.js.html
index 5beb234..1b63066 100644
--- a/docs/routes_Comments.js.html
+++ b/docs/routes_Comments.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -106,7 +106,7 @@ routes/Comments.js
diff --git a/docs/routes_Folders.js.html b/docs/routes_Folders.js.html
index 4d4a587..b1a501a 100644
--- a/docs/routes_Folders.js.html
+++ b/docs/routes_Folders.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -195,7 +195,7 @@ routes/Folders.js
diff --git a/docs/routes_Goals.js.html b/docs/routes_Goals.js.html
index acd396e..036be9f 100644
--- a/docs/routes_Goals.js.html
+++ b/docs/routes_Goals.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -130,7 +130,7 @@ routes/Goals.js
diff --git a/docs/routes_KeyResults.js.html b/docs/routes_KeyResults.js.html
index f3c77ff..715438c 100644
--- a/docs/routes_KeyResults.js.html
+++ b/docs/routes_KeyResults.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -105,7 +105,7 @@ routes/KeyResults.js
diff --git a/docs/routes_Lists.js.html b/docs/routes_Lists.js.html
index e3a8b2f..f217b39 100644
--- a/docs/routes_Lists.js.html
+++ b/docs/routes_Lists.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -238,6 +238,41 @@ routes/Lists.js
endpoint: `${this.route}/${listId}/view`,
});
}
+
+ /**
+ * Add task to a list
+ *
+ * @param {String} listId The list id
+ * @param {String} taskId The task id
+ */
+ async addTaskToList(listId, taskId) {
+ return this._client.post({
+ endpoint: `${this.route}/${listId}/task/${taskId}`,
+ });
+ }
+
+ /**
+ * Remove a task from a list
+ *
+ * @param {Sting} listId The list id
+ * @param {String} taskId The task id
+ */
+ async removeTaskFromList(listId, taskId) {
+ return this._client.delete({
+ endpoint: `${this.route}/${listId}/task/${taskId}`,
+ });
+ }
+
+ /**
+ * Get list members
+ *
+ * @param {String} listId The list id
+ */
+ async getListMembers(listId) {
+ return this._client.get({
+ endpoint: `${this.route}/${listId}/member`,
+ });
+ }
}
module.exports = Lists;
@@ -255,7 +290,7 @@ routes/Lists.js
diff --git a/docs/routes_Spaces.js.html b/docs/routes_Spaces.js.html
index 8ade311..4c5818e 100644
--- a/docs/routes_Spaces.js.html
+++ b/docs/routes_Spaces.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -245,7 +245,7 @@ routes/Spaces.js
diff --git a/docs/routes_Tasks.js.html b/docs/routes_Tasks.js.html
index cefed6b..8c28fc8 100644
--- a/docs/routes_Tasks.js.html
+++ b/docs/routes_Tasks.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -65,7 +65,7 @@ routes/Tasks.js
* @param {Client} client A client instance
*/
constructor(client) {
- this.client = client;
+ this._client = client;
this.route = 'task';
}
@@ -76,7 +76,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async get(taskId, options) {
- return this.client.get({
+ return this._client.get({
endpoint: `${this.route}/${taskId}`,
params: options,
});
@@ -90,7 +90,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async update(taskId, data, options) {
- return this.client.put({
+ return this._client.put({
endpoint: `${this.route}/${taskId}`,
params: options,
data,
@@ -104,7 +104,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async delete(taskId, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}`,
params: options,
});
@@ -114,21 +114,34 @@ routes/Tasks.js
* Add an attachment to a task
*
* @param {String} taskId The task id
- * @param {String} pathToFile The path to the file
- * @param {String} [fileName='attachment'] The file name
+ * @param {Object} fileSettings The file settings
+ * @param {String} fileSettings.filePath The path to the file
+ * @param {String} fileSettings.fileName The name of the attachment file along with its extension type. Example: 'notes.txt'
* @param {Object} [options] The parameter options to pass in
*/
- async addAttachment(taskId, pathToFile, fileName = 'attachment', options) {
+ async addAttachment(taskId, fileSettings, options) {
+ // ensure fileSettings are provided
+ if (fileSettings) {
+ if (!fileSettings.filePath) {
+ throw new Error('A file path must be provided');
+ }
+ if (!fileSettings.fileName) {
+ throw new Error('A file name must be provided');
+ }
+ } else {
+ throw new Error('File settings must be provided');
+ }
+
// building form-data
const form = new FormData();
- form.append('filename', fileName);
- form.append('attachment', createReadStream(pathToFile));
+ form.append('filename', fileSettings.fileName);
+ form.append('attachment', createReadStream(fileSettings.filePath));
// setting headers
const headers = form.getHeaders();
- headers.authorization = this.client._token;
+ headers.authorization = this._client._token;
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/attachment`,
params: options,
data: form,
@@ -144,7 +157,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async addComment(taskId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/comment`,
params: options,
data,
@@ -158,7 +171,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async getComments(taskId, options) {
- return this.client.get({
+ return this._client.get({
endpoint: `${this.route}/${taskId}/comment`,
params: options,
});
@@ -172,7 +185,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async createChecklist(taskId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/checklist`,
params: options,
data,
@@ -188,7 +201,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async setCustomFieldValue(taskId, fieldId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/field/${fieldId}`,
params: options,
data,
@@ -203,7 +216,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async deleteCustomFieldValue(taskId, fieldId, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/field/${fieldId}`,
params: options,
});
@@ -217,7 +230,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async addDependency(taskId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/dependency`,
params: options,
data,
@@ -228,14 +241,12 @@ routes/Tasks.js
* Delete a dependancy for a task
*
* @param {String} taskId The task id
- * @param {Object} data The dependency data
- * @param {Object} [options] The parameter options to pass in
+ * @param {Object} options The parameter options to pass in
*/
- async deleteDependency(taskId, data, options) {
- return this.client.delete({
+ async deleteDependency(taskId, options) {
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/dependency`,
params: options,
- data,
});
}
@@ -247,7 +258,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async addTaskLink(taskId, linksTo, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/link/${linksTo}`,
params: options,
});
@@ -261,7 +272,7 @@ routes/Tasks.js
* @param {String} [options] The parameter options to pass in
*/
async deleteTaskLink(taskId, linksTo, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/link/${linksTo}`,
params: options,
});
@@ -276,7 +287,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async addGuest(taskId, guestId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/guest/${guestId}`,
params: options,
data,
@@ -291,7 +302,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async removeGuest(taskId, guestId, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/guest/${guestId}`,
params: options,
});
@@ -303,7 +314,7 @@ routes/Tasks.js
* @param {String} taskId The task id
*/
async getMembers(taskId) {
- return this.client.get({
+ return this._client.get({
endpoint: `${this.route}/${taskId}/member`,
});
}
@@ -316,7 +327,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async addTag(taskId, tagName, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/tag/${tagName}`,
params: options,
});
@@ -330,7 +341,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async removeTag(taskId, tagName, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/tag/${tagName}`,
params: options,
});
@@ -344,7 +355,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async trackTime(taskId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/time`,
params: options,
data,
@@ -358,7 +369,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async getTrackedTime(taskId, options) {
- return this.client.get({
+ return this._client.get({
endpoint: `${this.route}/${taskId}/time`,
params: options,
});
@@ -373,7 +384,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async editTrackedTime(taskId, intervalId, data, options) {
- return this.client.put({
+ return this._client.put({
endpoint: `${this.route}/${taskId}/time/${intervalId}`,
params: options,
data,
@@ -388,11 +399,36 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async deleteTrackedTime(taskId, intervalId, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/time/${intervalId}`,
params: options,
});
}
+
+ /**
+ * Get tasks time in status
+ *
+ * @param {String} taskId The task id
+ * @param {Object} options The parameter options to pass in
+ */
+ async getTimeInStatus(taskId, options) {
+ return this._client.get({
+ endpoint: `${this.route}/${taskId}/time_in_status`,
+ params: options,
+ });
+ }
+
+ /**
+ * Get bulk tasks time in status
+ *
+ * @param {Object} options The parameter options to pass in
+ */
+ async getBulkTimeInStatus(options) {
+ return this._client.get({
+ endpoint: `${this.route}/bulk_time_in_status/task_ids`,
+ params: options,
+ });
+ }
}
module.exports = Tasks;
@@ -410,7 +446,7 @@ routes/Tasks.js
diff --git a/docs/routes_Teams.js.html b/docs/routes_Teams.js.html
index a6b0292..f94b0e5 100644
--- a/docs/routes_Teams.js.html
+++ b/docs/routes_Teams.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -492,7 +492,7 @@ routes/Teams.js
diff --git a/docs/routes_Views.js.html b/docs/routes_Views.js.html
index 78b49f5..926ddd0 100644
--- a/docs/routes_Views.js.html
+++ b/docs/routes_Views.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -156,7 +156,7 @@ routes/Views.js
diff --git a/docs/routes_Webhooks.js.html b/docs/routes_Webhooks.js.html
index 3c63132..d293778 100644
--- a/docs/routes_Webhooks.js.html
+++ b/docs/routes_Webhooks.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -106,7 +106,7 @@ routes/Webhooks.js
(async) addGu
Source:
(async) addTag<
Source:
(async) ad
Source:
(async) Source:
(async
Source:
Parameters:
- (async) deleteDependency(taskId, data, optionsopt)
+ (async) deleteDependency(taskId, options)
@@ -2181,7 +2200,7 @@ (async) Source:
Parameters:
Type
- Attributes
-
@@ -2274,14 +2291,6 @@ Parameters:
-
-
-
-
-
-
-
-
@@ -2290,37 +2299,6 @@ Parameters:
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The dependency data
-
-
-
optionsParameters:
-
-
- <optional>
-
-
-
-
-
-
-
@@ -2391,7 +2359,7 @@ (async) Source:
(async) Source:
(async) Source:
Parameters:
+
+
+
+
+ (async) getBulkTimeInStatus(options)
+
+
+
+
+
+
+
+
+
+ - Source:
+ -
+ routes/Tasks.js, line 368
+
+
+
+
+
+
+
+ Get bulk tasks time in status
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+
+ The parameter options to pass in
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -3231,7 +3335,7 @@ (async) ge
Source:
(async) get
Source:
Parameters:
+
+
+
+
+ (async) getTimeInStatus(taskId, options)
+
+
+
+
+
+
+
+
+
+ - Source:
+ -
+ routes/Tasks.js, line 356
+
+
+
+
+
+
+
+ Get tasks time in status
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ taskId
+
+
+String
+
+
+
+
+
+
+
+
+
+ The task id
+
+
+
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+
+ The parameter options to pass in
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -3546,7 +3809,7 @@ (async) Source:
(async) re
Source:
(async) remo
Source:
(async) <
Source:
(async) trac
Source:
Parameters:
diff --git a/docs/Teams.html b/docs/Teams.html
index e1bfb10..b167170 100644
--- a/docs/Teams.html
+++ b/docs/Teams.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -5551,7 +5551,7 @@ Parameters:
diff --git a/docs/Views.html b/docs/Views.html
index 3dd5980..2d23dd6 100644
--- a/docs/Views.html
+++ b/docs/Views.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -1158,7 +1158,7 @@ Parameters:
diff --git a/docs/Webhooks.html b/docs/Webhooks.html
index 78b5adc..b27ddae 100644
--- a/docs/Webhooks.html
+++ b/docs/Webhooks.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -536,7 +536,7 @@ Parameters:
diff --git a/docs/index.html b/docs/index.html
index 1ee651c..1e7fea3 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -191,7 +191,7 @@ License
diff --git a/docs/index.js.html b/docs/index.js.html
index 45c4abd..4b1371f 100644
--- a/docs/index.js.html
+++ b/docs/index.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -236,7 +236,7 @@ index.js
diff --git a/docs/routes_Authorization.js.html b/docs/routes_Authorization.js.html
index 162039a..99eff42 100644
--- a/docs/routes_Authorization.js.html
+++ b/docs/routes_Authorization.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -117,7 +117,7 @@ routes/Authorization.js
diff --git a/docs/routes_Checklists.js.html b/docs/routes_Checklists.js.html
index 3e08aab..7ffcbc2 100644
--- a/docs/routes_Checklists.js.html
+++ b/docs/routes_Checklists.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -145,7 +145,7 @@ routes/Checklists.js
diff --git a/docs/routes_Comments.js.html b/docs/routes_Comments.js.html
index 5beb234..1b63066 100644
--- a/docs/routes_Comments.js.html
+++ b/docs/routes_Comments.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -106,7 +106,7 @@ routes/Comments.js
diff --git a/docs/routes_Folders.js.html b/docs/routes_Folders.js.html
index 4d4a587..b1a501a 100644
--- a/docs/routes_Folders.js.html
+++ b/docs/routes_Folders.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -195,7 +195,7 @@ routes/Folders.js
diff --git a/docs/routes_Goals.js.html b/docs/routes_Goals.js.html
index acd396e..036be9f 100644
--- a/docs/routes_Goals.js.html
+++ b/docs/routes_Goals.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -130,7 +130,7 @@ routes/Goals.js
diff --git a/docs/routes_KeyResults.js.html b/docs/routes_KeyResults.js.html
index f3c77ff..715438c 100644
--- a/docs/routes_KeyResults.js.html
+++ b/docs/routes_KeyResults.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -105,7 +105,7 @@ routes/KeyResults.js
diff --git a/docs/routes_Lists.js.html b/docs/routes_Lists.js.html
index e3a8b2f..f217b39 100644
--- a/docs/routes_Lists.js.html
+++ b/docs/routes_Lists.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -238,6 +238,41 @@ routes/Lists.js
endpoint: `${this.route}/${listId}/view`,
});
}
+
+ /**
+ * Add task to a list
+ *
+ * @param {String} listId The list id
+ * @param {String} taskId The task id
+ */
+ async addTaskToList(listId, taskId) {
+ return this._client.post({
+ endpoint: `${this.route}/${listId}/task/${taskId}`,
+ });
+ }
+
+ /**
+ * Remove a task from a list
+ *
+ * @param {Sting} listId The list id
+ * @param {String} taskId The task id
+ */
+ async removeTaskFromList(listId, taskId) {
+ return this._client.delete({
+ endpoint: `${this.route}/${listId}/task/${taskId}`,
+ });
+ }
+
+ /**
+ * Get list members
+ *
+ * @param {String} listId The list id
+ */
+ async getListMembers(listId) {
+ return this._client.get({
+ endpoint: `${this.route}/${listId}/member`,
+ });
+ }
}
module.exports = Lists;
@@ -255,7 +290,7 @@ routes/Lists.js
diff --git a/docs/routes_Spaces.js.html b/docs/routes_Spaces.js.html
index 8ade311..4c5818e 100644
--- a/docs/routes_Spaces.js.html
+++ b/docs/routes_Spaces.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -245,7 +245,7 @@ routes/Spaces.js
diff --git a/docs/routes_Tasks.js.html b/docs/routes_Tasks.js.html
index cefed6b..8c28fc8 100644
--- a/docs/routes_Tasks.js.html
+++ b/docs/routes_Tasks.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -65,7 +65,7 @@ routes/Tasks.js
* @param {Client} client A client instance
*/
constructor(client) {
- this.client = client;
+ this._client = client;
this.route = 'task';
}
@@ -76,7 +76,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async get(taskId, options) {
- return this.client.get({
+ return this._client.get({
endpoint: `${this.route}/${taskId}`,
params: options,
});
@@ -90,7 +90,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async update(taskId, data, options) {
- return this.client.put({
+ return this._client.put({
endpoint: `${this.route}/${taskId}`,
params: options,
data,
@@ -104,7 +104,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async delete(taskId, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}`,
params: options,
});
@@ -114,21 +114,34 @@ routes/Tasks.js
* Add an attachment to a task
*
* @param {String} taskId The task id
- * @param {String} pathToFile The path to the file
- * @param {String} [fileName='attachment'] The file name
+ * @param {Object} fileSettings The file settings
+ * @param {String} fileSettings.filePath The path to the file
+ * @param {String} fileSettings.fileName The name of the attachment file along with its extension type. Example: 'notes.txt'
* @param {Object} [options] The parameter options to pass in
*/
- async addAttachment(taskId, pathToFile, fileName = 'attachment', options) {
+ async addAttachment(taskId, fileSettings, options) {
+ // ensure fileSettings are provided
+ if (fileSettings) {
+ if (!fileSettings.filePath) {
+ throw new Error('A file path must be provided');
+ }
+ if (!fileSettings.fileName) {
+ throw new Error('A file name must be provided');
+ }
+ } else {
+ throw new Error('File settings must be provided');
+ }
+
// building form-data
const form = new FormData();
- form.append('filename', fileName);
- form.append('attachment', createReadStream(pathToFile));
+ form.append('filename', fileSettings.fileName);
+ form.append('attachment', createReadStream(fileSettings.filePath));
// setting headers
const headers = form.getHeaders();
- headers.authorization = this.client._token;
+ headers.authorization = this._client._token;
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/attachment`,
params: options,
data: form,
@@ -144,7 +157,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async addComment(taskId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/comment`,
params: options,
data,
@@ -158,7 +171,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async getComments(taskId, options) {
- return this.client.get({
+ return this._client.get({
endpoint: `${this.route}/${taskId}/comment`,
params: options,
});
@@ -172,7 +185,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async createChecklist(taskId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/checklist`,
params: options,
data,
@@ -188,7 +201,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async setCustomFieldValue(taskId, fieldId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/field/${fieldId}`,
params: options,
data,
@@ -203,7 +216,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async deleteCustomFieldValue(taskId, fieldId, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/field/${fieldId}`,
params: options,
});
@@ -217,7 +230,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async addDependency(taskId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/dependency`,
params: options,
data,
@@ -228,14 +241,12 @@ routes/Tasks.js
* Delete a dependancy for a task
*
* @param {String} taskId The task id
- * @param {Object} data The dependency data
- * @param {Object} [options] The parameter options to pass in
+ * @param {Object} options The parameter options to pass in
*/
- async deleteDependency(taskId, data, options) {
- return this.client.delete({
+ async deleteDependency(taskId, options) {
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/dependency`,
params: options,
- data,
});
}
@@ -247,7 +258,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async addTaskLink(taskId, linksTo, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/link/${linksTo}`,
params: options,
});
@@ -261,7 +272,7 @@ routes/Tasks.js
* @param {String} [options] The parameter options to pass in
*/
async deleteTaskLink(taskId, linksTo, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/link/${linksTo}`,
params: options,
});
@@ -276,7 +287,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async addGuest(taskId, guestId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/guest/${guestId}`,
params: options,
data,
@@ -291,7 +302,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async removeGuest(taskId, guestId, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/guest/${guestId}`,
params: options,
});
@@ -303,7 +314,7 @@ routes/Tasks.js
* @param {String} taskId The task id
*/
async getMembers(taskId) {
- return this.client.get({
+ return this._client.get({
endpoint: `${this.route}/${taskId}/member`,
});
}
@@ -316,7 +327,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async addTag(taskId, tagName, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/tag/${tagName}`,
params: options,
});
@@ -330,7 +341,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async removeTag(taskId, tagName, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/tag/${tagName}`,
params: options,
});
@@ -344,7 +355,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async trackTime(taskId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/time`,
params: options,
data,
@@ -358,7 +369,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async getTrackedTime(taskId, options) {
- return this.client.get({
+ return this._client.get({
endpoint: `${this.route}/${taskId}/time`,
params: options,
});
@@ -373,7 +384,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async editTrackedTime(taskId, intervalId, data, options) {
- return this.client.put({
+ return this._client.put({
endpoint: `${this.route}/${taskId}/time/${intervalId}`,
params: options,
data,
@@ -388,11 +399,36 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async deleteTrackedTime(taskId, intervalId, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/time/${intervalId}`,
params: options,
});
}
+
+ /**
+ * Get tasks time in status
+ *
+ * @param {String} taskId The task id
+ * @param {Object} options The parameter options to pass in
+ */
+ async getTimeInStatus(taskId, options) {
+ return this._client.get({
+ endpoint: `${this.route}/${taskId}/time_in_status`,
+ params: options,
+ });
+ }
+
+ /**
+ * Get bulk tasks time in status
+ *
+ * @param {Object} options The parameter options to pass in
+ */
+ async getBulkTimeInStatus(options) {
+ return this._client.get({
+ endpoint: `${this.route}/bulk_time_in_status/task_ids`,
+ params: options,
+ });
+ }
}
module.exports = Tasks;
@@ -410,7 +446,7 @@ routes/Tasks.js
diff --git a/docs/routes_Teams.js.html b/docs/routes_Teams.js.html
index a6b0292..f94b0e5 100644
--- a/docs/routes_Teams.js.html
+++ b/docs/routes_Teams.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -492,7 +492,7 @@ routes/Teams.js
diff --git a/docs/routes_Views.js.html b/docs/routes_Views.js.html
index 78b49f5..926ddd0 100644
--- a/docs/routes_Views.js.html
+++ b/docs/routes_Views.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -156,7 +156,7 @@ routes/Views.js
diff --git a/docs/routes_Webhooks.js.html b/docs/routes_Webhooks.js.html
index 3c63132..d293778 100644
--- a/docs/routes_Webhooks.js.html
+++ b/docs/routes_Webhooks.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -106,7 +106,7 @@ routes/Webhooks.js
(async) ad
Source:
(async) Source:
(async
Source:
Parameters:
- (async) deleteDependency(taskId, data, optionsopt)
+ (async) deleteDependency(taskId, options)
@@ -2181,7 +2200,7 @@ (async) Source:
Parameters:
Type
- Attributes
-
@@ -2274,14 +2291,6 @@ Parameters:
-
-
-
-
-
-
-
-
@@ -2290,37 +2299,6 @@ Parameters:
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The dependency data
-
-
-
optionsParameters:
-
-
- <optional>
-
-
-
-
-
-
-
@@ -2391,7 +2359,7 @@ (async) Source:
(async) Source:
(async) Source:
Parameters:
+
+
+
+
+ (async) getBulkTimeInStatus(options)
+
+
+
+
+
+
+
+
+
+ - Source:
+ -
+ routes/Tasks.js, line 368
+
+
+
+
+
+
+
+ Get bulk tasks time in status
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+
+ The parameter options to pass in
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -3231,7 +3335,7 @@ (async) ge
Source:
(async) get
Source:
Parameters:
+
+
+
+
+ (async) getTimeInStatus(taskId, options)
+
+
+
+
+
+
+
+
+
+ - Source:
+ -
+ routes/Tasks.js, line 356
+
+
+
+
+
+
+
+ Get tasks time in status
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ taskId
+
+
+String
+
+
+
+
+
+
+
+
+
+ The task id
+
+
+
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+
+ The parameter options to pass in
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -3546,7 +3809,7 @@ (async) Source:
(async) re
Source:
(async) remo
Source:
(async) <
Source:
(async) trac
Source:
Parameters:
diff --git a/docs/Teams.html b/docs/Teams.html
index e1bfb10..b167170 100644
--- a/docs/Teams.html
+++ b/docs/Teams.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -5551,7 +5551,7 @@ Parameters:
diff --git a/docs/Views.html b/docs/Views.html
index 3dd5980..2d23dd6 100644
--- a/docs/Views.html
+++ b/docs/Views.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -1158,7 +1158,7 @@ Parameters:
diff --git a/docs/Webhooks.html b/docs/Webhooks.html
index 78b5adc..b27ddae 100644
--- a/docs/Webhooks.html
+++ b/docs/Webhooks.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -536,7 +536,7 @@ Parameters:
diff --git a/docs/index.html b/docs/index.html
index 1ee651c..1e7fea3 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -191,7 +191,7 @@ License
diff --git a/docs/index.js.html b/docs/index.js.html
index 45c4abd..4b1371f 100644
--- a/docs/index.js.html
+++ b/docs/index.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -236,7 +236,7 @@ index.js
diff --git a/docs/routes_Authorization.js.html b/docs/routes_Authorization.js.html
index 162039a..99eff42 100644
--- a/docs/routes_Authorization.js.html
+++ b/docs/routes_Authorization.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -117,7 +117,7 @@ routes/Authorization.js
diff --git a/docs/routes_Checklists.js.html b/docs/routes_Checklists.js.html
index 3e08aab..7ffcbc2 100644
--- a/docs/routes_Checklists.js.html
+++ b/docs/routes_Checklists.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -145,7 +145,7 @@ routes/Checklists.js
diff --git a/docs/routes_Comments.js.html b/docs/routes_Comments.js.html
index 5beb234..1b63066 100644
--- a/docs/routes_Comments.js.html
+++ b/docs/routes_Comments.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -106,7 +106,7 @@ routes/Comments.js
diff --git a/docs/routes_Folders.js.html b/docs/routes_Folders.js.html
index 4d4a587..b1a501a 100644
--- a/docs/routes_Folders.js.html
+++ b/docs/routes_Folders.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -195,7 +195,7 @@ routes/Folders.js
diff --git a/docs/routes_Goals.js.html b/docs/routes_Goals.js.html
index acd396e..036be9f 100644
--- a/docs/routes_Goals.js.html
+++ b/docs/routes_Goals.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -130,7 +130,7 @@ routes/Goals.js
diff --git a/docs/routes_KeyResults.js.html b/docs/routes_KeyResults.js.html
index f3c77ff..715438c 100644
--- a/docs/routes_KeyResults.js.html
+++ b/docs/routes_KeyResults.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -105,7 +105,7 @@ routes/KeyResults.js
diff --git a/docs/routes_Lists.js.html b/docs/routes_Lists.js.html
index e3a8b2f..f217b39 100644
--- a/docs/routes_Lists.js.html
+++ b/docs/routes_Lists.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -238,6 +238,41 @@ routes/Lists.js
endpoint: `${this.route}/${listId}/view`,
});
}
+
+ /**
+ * Add task to a list
+ *
+ * @param {String} listId The list id
+ * @param {String} taskId The task id
+ */
+ async addTaskToList(listId, taskId) {
+ return this._client.post({
+ endpoint: `${this.route}/${listId}/task/${taskId}`,
+ });
+ }
+
+ /**
+ * Remove a task from a list
+ *
+ * @param {Sting} listId The list id
+ * @param {String} taskId The task id
+ */
+ async removeTaskFromList(listId, taskId) {
+ return this._client.delete({
+ endpoint: `${this.route}/${listId}/task/${taskId}`,
+ });
+ }
+
+ /**
+ * Get list members
+ *
+ * @param {String} listId The list id
+ */
+ async getListMembers(listId) {
+ return this._client.get({
+ endpoint: `${this.route}/${listId}/member`,
+ });
+ }
}
module.exports = Lists;
@@ -255,7 +290,7 @@ routes/Lists.js
diff --git a/docs/routes_Spaces.js.html b/docs/routes_Spaces.js.html
index 8ade311..4c5818e 100644
--- a/docs/routes_Spaces.js.html
+++ b/docs/routes_Spaces.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -245,7 +245,7 @@ routes/Spaces.js
diff --git a/docs/routes_Tasks.js.html b/docs/routes_Tasks.js.html
index cefed6b..8c28fc8 100644
--- a/docs/routes_Tasks.js.html
+++ b/docs/routes_Tasks.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -65,7 +65,7 @@ routes/Tasks.js
* @param {Client} client A client instance
*/
constructor(client) {
- this.client = client;
+ this._client = client;
this.route = 'task';
}
@@ -76,7 +76,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async get(taskId, options) {
- return this.client.get({
+ return this._client.get({
endpoint: `${this.route}/${taskId}`,
params: options,
});
@@ -90,7 +90,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async update(taskId, data, options) {
- return this.client.put({
+ return this._client.put({
endpoint: `${this.route}/${taskId}`,
params: options,
data,
@@ -104,7 +104,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async delete(taskId, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}`,
params: options,
});
@@ -114,21 +114,34 @@ routes/Tasks.js
* Add an attachment to a task
*
* @param {String} taskId The task id
- * @param {String} pathToFile The path to the file
- * @param {String} [fileName='attachment'] The file name
+ * @param {Object} fileSettings The file settings
+ * @param {String} fileSettings.filePath The path to the file
+ * @param {String} fileSettings.fileName The name of the attachment file along with its extension type. Example: 'notes.txt'
* @param {Object} [options] The parameter options to pass in
*/
- async addAttachment(taskId, pathToFile, fileName = 'attachment', options) {
+ async addAttachment(taskId, fileSettings, options) {
+ // ensure fileSettings are provided
+ if (fileSettings) {
+ if (!fileSettings.filePath) {
+ throw new Error('A file path must be provided');
+ }
+ if (!fileSettings.fileName) {
+ throw new Error('A file name must be provided');
+ }
+ } else {
+ throw new Error('File settings must be provided');
+ }
+
// building form-data
const form = new FormData();
- form.append('filename', fileName);
- form.append('attachment', createReadStream(pathToFile));
+ form.append('filename', fileSettings.fileName);
+ form.append('attachment', createReadStream(fileSettings.filePath));
// setting headers
const headers = form.getHeaders();
- headers.authorization = this.client._token;
+ headers.authorization = this._client._token;
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/attachment`,
params: options,
data: form,
@@ -144,7 +157,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async addComment(taskId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/comment`,
params: options,
data,
@@ -158,7 +171,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async getComments(taskId, options) {
- return this.client.get({
+ return this._client.get({
endpoint: `${this.route}/${taskId}/comment`,
params: options,
});
@@ -172,7 +185,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async createChecklist(taskId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/checklist`,
params: options,
data,
@@ -188,7 +201,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async setCustomFieldValue(taskId, fieldId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/field/${fieldId}`,
params: options,
data,
@@ -203,7 +216,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async deleteCustomFieldValue(taskId, fieldId, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/field/${fieldId}`,
params: options,
});
@@ -217,7 +230,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async addDependency(taskId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/dependency`,
params: options,
data,
@@ -228,14 +241,12 @@ routes/Tasks.js
* Delete a dependancy for a task
*
* @param {String} taskId The task id
- * @param {Object} data The dependency data
- * @param {Object} [options] The parameter options to pass in
+ * @param {Object} options The parameter options to pass in
*/
- async deleteDependency(taskId, data, options) {
- return this.client.delete({
+ async deleteDependency(taskId, options) {
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/dependency`,
params: options,
- data,
});
}
@@ -247,7 +258,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async addTaskLink(taskId, linksTo, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/link/${linksTo}`,
params: options,
});
@@ -261,7 +272,7 @@ routes/Tasks.js
* @param {String} [options] The parameter options to pass in
*/
async deleteTaskLink(taskId, linksTo, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/link/${linksTo}`,
params: options,
});
@@ -276,7 +287,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async addGuest(taskId, guestId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/guest/${guestId}`,
params: options,
data,
@@ -291,7 +302,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async removeGuest(taskId, guestId, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/guest/${guestId}`,
params: options,
});
@@ -303,7 +314,7 @@ routes/Tasks.js
* @param {String} taskId The task id
*/
async getMembers(taskId) {
- return this.client.get({
+ return this._client.get({
endpoint: `${this.route}/${taskId}/member`,
});
}
@@ -316,7 +327,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async addTag(taskId, tagName, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/tag/${tagName}`,
params: options,
});
@@ -330,7 +341,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async removeTag(taskId, tagName, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/tag/${tagName}`,
params: options,
});
@@ -344,7 +355,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async trackTime(taskId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/time`,
params: options,
data,
@@ -358,7 +369,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async getTrackedTime(taskId, options) {
- return this.client.get({
+ return this._client.get({
endpoint: `${this.route}/${taskId}/time`,
params: options,
});
@@ -373,7 +384,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async editTrackedTime(taskId, intervalId, data, options) {
- return this.client.put({
+ return this._client.put({
endpoint: `${this.route}/${taskId}/time/${intervalId}`,
params: options,
data,
@@ -388,11 +399,36 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async deleteTrackedTime(taskId, intervalId, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/time/${intervalId}`,
params: options,
});
}
+
+ /**
+ * Get tasks time in status
+ *
+ * @param {String} taskId The task id
+ * @param {Object} options The parameter options to pass in
+ */
+ async getTimeInStatus(taskId, options) {
+ return this._client.get({
+ endpoint: `${this.route}/${taskId}/time_in_status`,
+ params: options,
+ });
+ }
+
+ /**
+ * Get bulk tasks time in status
+ *
+ * @param {Object} options The parameter options to pass in
+ */
+ async getBulkTimeInStatus(options) {
+ return this._client.get({
+ endpoint: `${this.route}/bulk_time_in_status/task_ids`,
+ params: options,
+ });
+ }
}
module.exports = Tasks;
@@ -410,7 +446,7 @@ routes/Tasks.js
diff --git a/docs/routes_Teams.js.html b/docs/routes_Teams.js.html
index a6b0292..f94b0e5 100644
--- a/docs/routes_Teams.js.html
+++ b/docs/routes_Teams.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -492,7 +492,7 @@ routes/Teams.js
diff --git a/docs/routes_Views.js.html b/docs/routes_Views.js.html
index 78b49f5..926ddd0 100644
--- a/docs/routes_Views.js.html
+++ b/docs/routes_Views.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -156,7 +156,7 @@ routes/Views.js
diff --git a/docs/routes_Webhooks.js.html b/docs/routes_Webhooks.js.html
index 3c63132..d293778 100644
--- a/docs/routes_Webhooks.js.html
+++ b/docs/routes_Webhooks.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -106,7 +106,7 @@ routes/Webhooks.js
(async
Source:
Parameters:
- (async) deleteDependency(taskId, data, optionsopt)
+ (async) deleteDependency(taskId, options)
@@ -2181,7 +2200,7 @@ (async) Source:
Parameters:
Type
- Attributes
-
@@ -2274,14 +2291,6 @@ Parameters:
-
-
-
-
-
-
-
-
@@ -2290,37 +2299,6 @@ Parameters:
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The dependency data
-
-
-
optionsParameters:
-
-
- <optional>
-
-
-
-
-
-
-
@@ -2391,7 +2359,7 @@ (async) Source:
(async) Source:
(async) Source:
Parameters:
+
+
+
+
+ (async) getBulkTimeInStatus(options)
+
+
+
+
+
+
+
+
+
+ - Source:
+ -
+ routes/Tasks.js, line 368
+
+
+
+
+
+
+
+ Get bulk tasks time in status
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+
+ The parameter options to pass in
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -3231,7 +3335,7 @@ (async) ge
Source:
(async) get
Source:
Parameters:
+
+
+
+
+ (async) getTimeInStatus(taskId, options)
+
+
+
+
+
+
+
+
+
+ - Source:
+ -
+ routes/Tasks.js, line 356
+
+
+
+
+
+
+
+ Get tasks time in status
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ taskId
+
+
+String
+
+
+
+
+
+
+
+
+
+ The task id
+
+
+
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+
+ The parameter options to pass in
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -3546,7 +3809,7 @@ (async) Source:
(async) re
Source:
(async) remo
Source:
(async) <
Source:
(async) trac
Source:
Parameters:
diff --git a/docs/Teams.html b/docs/Teams.html
index e1bfb10..b167170 100644
--- a/docs/Teams.html
+++ b/docs/Teams.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -5551,7 +5551,7 @@ Parameters:
diff --git a/docs/Views.html b/docs/Views.html
index 3dd5980..2d23dd6 100644
--- a/docs/Views.html
+++ b/docs/Views.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -1158,7 +1158,7 @@ Parameters:
diff --git a/docs/Webhooks.html b/docs/Webhooks.html
index 78b5adc..b27ddae 100644
--- a/docs/Webhooks.html
+++ b/docs/Webhooks.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -536,7 +536,7 @@ Parameters:
diff --git a/docs/index.html b/docs/index.html
index 1ee651c..1e7fea3 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -191,7 +191,7 @@ License
diff --git a/docs/index.js.html b/docs/index.js.html
index 45c4abd..4b1371f 100644
--- a/docs/index.js.html
+++ b/docs/index.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -236,7 +236,7 @@ index.js
diff --git a/docs/routes_Authorization.js.html b/docs/routes_Authorization.js.html
index 162039a..99eff42 100644
--- a/docs/routes_Authorization.js.html
+++ b/docs/routes_Authorization.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -117,7 +117,7 @@ routes/Authorization.js
diff --git a/docs/routes_Checklists.js.html b/docs/routes_Checklists.js.html
index 3e08aab..7ffcbc2 100644
--- a/docs/routes_Checklists.js.html
+++ b/docs/routes_Checklists.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -145,7 +145,7 @@ routes/Checklists.js
diff --git a/docs/routes_Comments.js.html b/docs/routes_Comments.js.html
index 5beb234..1b63066 100644
--- a/docs/routes_Comments.js.html
+++ b/docs/routes_Comments.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -106,7 +106,7 @@ routes/Comments.js
diff --git a/docs/routes_Folders.js.html b/docs/routes_Folders.js.html
index 4d4a587..b1a501a 100644
--- a/docs/routes_Folders.js.html
+++ b/docs/routes_Folders.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -195,7 +195,7 @@ routes/Folders.js
diff --git a/docs/routes_Goals.js.html b/docs/routes_Goals.js.html
index acd396e..036be9f 100644
--- a/docs/routes_Goals.js.html
+++ b/docs/routes_Goals.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -130,7 +130,7 @@ routes/Goals.js
diff --git a/docs/routes_KeyResults.js.html b/docs/routes_KeyResults.js.html
index f3c77ff..715438c 100644
--- a/docs/routes_KeyResults.js.html
+++ b/docs/routes_KeyResults.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -105,7 +105,7 @@ routes/KeyResults.js
diff --git a/docs/routes_Lists.js.html b/docs/routes_Lists.js.html
index e3a8b2f..f217b39 100644
--- a/docs/routes_Lists.js.html
+++ b/docs/routes_Lists.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -238,6 +238,41 @@ routes/Lists.js
endpoint: `${this.route}/${listId}/view`,
});
}
+
+ /**
+ * Add task to a list
+ *
+ * @param {String} listId The list id
+ * @param {String} taskId The task id
+ */
+ async addTaskToList(listId, taskId) {
+ return this._client.post({
+ endpoint: `${this.route}/${listId}/task/${taskId}`,
+ });
+ }
+
+ /**
+ * Remove a task from a list
+ *
+ * @param {Sting} listId The list id
+ * @param {String} taskId The task id
+ */
+ async removeTaskFromList(listId, taskId) {
+ return this._client.delete({
+ endpoint: `${this.route}/${listId}/task/${taskId}`,
+ });
+ }
+
+ /**
+ * Get list members
+ *
+ * @param {String} listId The list id
+ */
+ async getListMembers(listId) {
+ return this._client.get({
+ endpoint: `${this.route}/${listId}/member`,
+ });
+ }
}
module.exports = Lists;
@@ -255,7 +290,7 @@ routes/Lists.js
diff --git a/docs/routes_Spaces.js.html b/docs/routes_Spaces.js.html
index 8ade311..4c5818e 100644
--- a/docs/routes_Spaces.js.html
+++ b/docs/routes_Spaces.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -245,7 +245,7 @@ routes/Spaces.js
diff --git a/docs/routes_Tasks.js.html b/docs/routes_Tasks.js.html
index cefed6b..8c28fc8 100644
--- a/docs/routes_Tasks.js.html
+++ b/docs/routes_Tasks.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -65,7 +65,7 @@ routes/Tasks.js
* @param {Client} client A client instance
*/
constructor(client) {
- this.client = client;
+ this._client = client;
this.route = 'task';
}
@@ -76,7 +76,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async get(taskId, options) {
- return this.client.get({
+ return this._client.get({
endpoint: `${this.route}/${taskId}`,
params: options,
});
@@ -90,7 +90,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async update(taskId, data, options) {
- return this.client.put({
+ return this._client.put({
endpoint: `${this.route}/${taskId}`,
params: options,
data,
@@ -104,7 +104,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async delete(taskId, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}`,
params: options,
});
@@ -114,21 +114,34 @@ routes/Tasks.js
* Add an attachment to a task
*
* @param {String} taskId The task id
- * @param {String} pathToFile The path to the file
- * @param {String} [fileName='attachment'] The file name
+ * @param {Object} fileSettings The file settings
+ * @param {String} fileSettings.filePath The path to the file
+ * @param {String} fileSettings.fileName The name of the attachment file along with its extension type. Example: 'notes.txt'
* @param {Object} [options] The parameter options to pass in
*/
- async addAttachment(taskId, pathToFile, fileName = 'attachment', options) {
+ async addAttachment(taskId, fileSettings, options) {
+ // ensure fileSettings are provided
+ if (fileSettings) {
+ if (!fileSettings.filePath) {
+ throw new Error('A file path must be provided');
+ }
+ if (!fileSettings.fileName) {
+ throw new Error('A file name must be provided');
+ }
+ } else {
+ throw new Error('File settings must be provided');
+ }
+
// building form-data
const form = new FormData();
- form.append('filename', fileName);
- form.append('attachment', createReadStream(pathToFile));
+ form.append('filename', fileSettings.fileName);
+ form.append('attachment', createReadStream(fileSettings.filePath));
// setting headers
const headers = form.getHeaders();
- headers.authorization = this.client._token;
+ headers.authorization = this._client._token;
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/attachment`,
params: options,
data: form,
@@ -144,7 +157,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async addComment(taskId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/comment`,
params: options,
data,
@@ -158,7 +171,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async getComments(taskId, options) {
- return this.client.get({
+ return this._client.get({
endpoint: `${this.route}/${taskId}/comment`,
params: options,
});
@@ -172,7 +185,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async createChecklist(taskId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/checklist`,
params: options,
data,
@@ -188,7 +201,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async setCustomFieldValue(taskId, fieldId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/field/${fieldId}`,
params: options,
data,
@@ -203,7 +216,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async deleteCustomFieldValue(taskId, fieldId, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/field/${fieldId}`,
params: options,
});
@@ -217,7 +230,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async addDependency(taskId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/dependency`,
params: options,
data,
@@ -228,14 +241,12 @@ routes/Tasks.js
* Delete a dependancy for a task
*
* @param {String} taskId The task id
- * @param {Object} data The dependency data
- * @param {Object} [options] The parameter options to pass in
+ * @param {Object} options The parameter options to pass in
*/
- async deleteDependency(taskId, data, options) {
- return this.client.delete({
+ async deleteDependency(taskId, options) {
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/dependency`,
params: options,
- data,
});
}
@@ -247,7 +258,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async addTaskLink(taskId, linksTo, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/link/${linksTo}`,
params: options,
});
@@ -261,7 +272,7 @@ routes/Tasks.js
* @param {String} [options] The parameter options to pass in
*/
async deleteTaskLink(taskId, linksTo, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/link/${linksTo}`,
params: options,
});
@@ -276,7 +287,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async addGuest(taskId, guestId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/guest/${guestId}`,
params: options,
data,
@@ -291,7 +302,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async removeGuest(taskId, guestId, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/guest/${guestId}`,
params: options,
});
@@ -303,7 +314,7 @@ routes/Tasks.js
* @param {String} taskId The task id
*/
async getMembers(taskId) {
- return this.client.get({
+ return this._client.get({
endpoint: `${this.route}/${taskId}/member`,
});
}
@@ -316,7 +327,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async addTag(taskId, tagName, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/tag/${tagName}`,
params: options,
});
@@ -330,7 +341,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async removeTag(taskId, tagName, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/tag/${tagName}`,
params: options,
});
@@ -344,7 +355,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async trackTime(taskId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/time`,
params: options,
data,
@@ -358,7 +369,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async getTrackedTime(taskId, options) {
- return this.client.get({
+ return this._client.get({
endpoint: `${this.route}/${taskId}/time`,
params: options,
});
@@ -373,7 +384,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async editTrackedTime(taskId, intervalId, data, options) {
- return this.client.put({
+ return this._client.put({
endpoint: `${this.route}/${taskId}/time/${intervalId}`,
params: options,
data,
@@ -388,11 +399,36 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async deleteTrackedTime(taskId, intervalId, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/time/${intervalId}`,
params: options,
});
}
+
+ /**
+ * Get tasks time in status
+ *
+ * @param {String} taskId The task id
+ * @param {Object} options The parameter options to pass in
+ */
+ async getTimeInStatus(taskId, options) {
+ return this._client.get({
+ endpoint: `${this.route}/${taskId}/time_in_status`,
+ params: options,
+ });
+ }
+
+ /**
+ * Get bulk tasks time in status
+ *
+ * @param {Object} options The parameter options to pass in
+ */
+ async getBulkTimeInStatus(options) {
+ return this._client.get({
+ endpoint: `${this.route}/bulk_time_in_status/task_ids`,
+ params: options,
+ });
+ }
}
module.exports = Tasks;
@@ -410,7 +446,7 @@ routes/Tasks.js
diff --git a/docs/routes_Teams.js.html b/docs/routes_Teams.js.html
index a6b0292..f94b0e5 100644
--- a/docs/routes_Teams.js.html
+++ b/docs/routes_Teams.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -492,7 +492,7 @@ routes/Teams.js
diff --git a/docs/routes_Views.js.html b/docs/routes_Views.js.html
index 78b49f5..926ddd0 100644
--- a/docs/routes_Views.js.html
+++ b/docs/routes_Views.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -156,7 +156,7 @@ routes/Views.js
diff --git a/docs/routes_Webhooks.js.html b/docs/routes_Webhooks.js.html
index 3c63132..d293778 100644
--- a/docs/routes_Webhooks.js.html
+++ b/docs/routes_Webhooks.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -106,7 +106,7 @@ routes/Webhooks.js
Parameters:
Parameters:
-Parameters:
-dataThe dependency data
optionsParameters:
-- - - - - -
(async) Source:
(async) Source:
(async) Source:
Parameters:
+
+
+
+
+ (async) getBulkTimeInStatus(options)
+
+
+
+
+
+
+
+
+
+ - Source:
+ -
+ routes/Tasks.js, line 368
+
+
+
+
+
+
+
+ Get bulk tasks time in status
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+
+ The parameter options to pass in
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -3231,7 +3335,7 @@ (async) ge
Source:
(async) get
Source:
Parameters:
+
+
+
+
+ (async) getTimeInStatus(taskId, options)
+
+
+
+
+
+
+
+
+
+ - Source:
+ -
+ routes/Tasks.js, line 356
+
+
+
+
+
+
+
+ Get tasks time in status
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ taskId
+
+
+String
+
+
+
+
+
+
+
+
+
+ The task id
+
+
+
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+
+ The parameter options to pass in
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -3546,7 +3809,7 @@ (async) Source:
(async) re
Source:
(async) remo
Source:
(async) <
Source:
(async) trac
Source:
Parameters:
diff --git a/docs/Teams.html b/docs/Teams.html
index e1bfb10..b167170 100644
--- a/docs/Teams.html
+++ b/docs/Teams.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -5551,7 +5551,7 @@ Parameters:
diff --git a/docs/Views.html b/docs/Views.html
index 3dd5980..2d23dd6 100644
--- a/docs/Views.html
+++ b/docs/Views.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -1158,7 +1158,7 @@ Parameters:
diff --git a/docs/Webhooks.html b/docs/Webhooks.html
index 78b5adc..b27ddae 100644
--- a/docs/Webhooks.html
+++ b/docs/Webhooks.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -536,7 +536,7 @@ Parameters:
diff --git a/docs/index.html b/docs/index.html
index 1ee651c..1e7fea3 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -191,7 +191,7 @@ License
diff --git a/docs/index.js.html b/docs/index.js.html
index 45c4abd..4b1371f 100644
--- a/docs/index.js.html
+++ b/docs/index.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -236,7 +236,7 @@ index.js
diff --git a/docs/routes_Authorization.js.html b/docs/routes_Authorization.js.html
index 162039a..99eff42 100644
--- a/docs/routes_Authorization.js.html
+++ b/docs/routes_Authorization.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -117,7 +117,7 @@ routes/Authorization.js
diff --git a/docs/routes_Checklists.js.html b/docs/routes_Checklists.js.html
index 3e08aab..7ffcbc2 100644
--- a/docs/routes_Checklists.js.html
+++ b/docs/routes_Checklists.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -145,7 +145,7 @@ routes/Checklists.js
diff --git a/docs/routes_Comments.js.html b/docs/routes_Comments.js.html
index 5beb234..1b63066 100644
--- a/docs/routes_Comments.js.html
+++ b/docs/routes_Comments.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -106,7 +106,7 @@ routes/Comments.js
diff --git a/docs/routes_Folders.js.html b/docs/routes_Folders.js.html
index 4d4a587..b1a501a 100644
--- a/docs/routes_Folders.js.html
+++ b/docs/routes_Folders.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -195,7 +195,7 @@ routes/Folders.js
diff --git a/docs/routes_Goals.js.html b/docs/routes_Goals.js.html
index acd396e..036be9f 100644
--- a/docs/routes_Goals.js.html
+++ b/docs/routes_Goals.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -130,7 +130,7 @@ routes/Goals.js
diff --git a/docs/routes_KeyResults.js.html b/docs/routes_KeyResults.js.html
index f3c77ff..715438c 100644
--- a/docs/routes_KeyResults.js.html
+++ b/docs/routes_KeyResults.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -105,7 +105,7 @@ routes/KeyResults.js
diff --git a/docs/routes_Lists.js.html b/docs/routes_Lists.js.html
index e3a8b2f..f217b39 100644
--- a/docs/routes_Lists.js.html
+++ b/docs/routes_Lists.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -238,6 +238,41 @@ routes/Lists.js
endpoint: `${this.route}/${listId}/view`,
});
}
+
+ /**
+ * Add task to a list
+ *
+ * @param {String} listId The list id
+ * @param {String} taskId The task id
+ */
+ async addTaskToList(listId, taskId) {
+ return this._client.post({
+ endpoint: `${this.route}/${listId}/task/${taskId}`,
+ });
+ }
+
+ /**
+ * Remove a task from a list
+ *
+ * @param {Sting} listId The list id
+ * @param {String} taskId The task id
+ */
+ async removeTaskFromList(listId, taskId) {
+ return this._client.delete({
+ endpoint: `${this.route}/${listId}/task/${taskId}`,
+ });
+ }
+
+ /**
+ * Get list members
+ *
+ * @param {String} listId The list id
+ */
+ async getListMembers(listId) {
+ return this._client.get({
+ endpoint: `${this.route}/${listId}/member`,
+ });
+ }
}
module.exports = Lists;
@@ -255,7 +290,7 @@ routes/Lists.js
diff --git a/docs/routes_Spaces.js.html b/docs/routes_Spaces.js.html
index 8ade311..4c5818e 100644
--- a/docs/routes_Spaces.js.html
+++ b/docs/routes_Spaces.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -245,7 +245,7 @@ routes/Spaces.js
diff --git a/docs/routes_Tasks.js.html b/docs/routes_Tasks.js.html
index cefed6b..8c28fc8 100644
--- a/docs/routes_Tasks.js.html
+++ b/docs/routes_Tasks.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -65,7 +65,7 @@ routes/Tasks.js
* @param {Client} client A client instance
*/
constructor(client) {
- this.client = client;
+ this._client = client;
this.route = 'task';
}
@@ -76,7 +76,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async get(taskId, options) {
- return this.client.get({
+ return this._client.get({
endpoint: `${this.route}/${taskId}`,
params: options,
});
@@ -90,7 +90,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async update(taskId, data, options) {
- return this.client.put({
+ return this._client.put({
endpoint: `${this.route}/${taskId}`,
params: options,
data,
@@ -104,7 +104,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async delete(taskId, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}`,
params: options,
});
@@ -114,21 +114,34 @@ routes/Tasks.js
* Add an attachment to a task
*
* @param {String} taskId The task id
- * @param {String} pathToFile The path to the file
- * @param {String} [fileName='attachment'] The file name
+ * @param {Object} fileSettings The file settings
+ * @param {String} fileSettings.filePath The path to the file
+ * @param {String} fileSettings.fileName The name of the attachment file along with its extension type. Example: 'notes.txt'
* @param {Object} [options] The parameter options to pass in
*/
- async addAttachment(taskId, pathToFile, fileName = 'attachment', options) {
+ async addAttachment(taskId, fileSettings, options) {
+ // ensure fileSettings are provided
+ if (fileSettings) {
+ if (!fileSettings.filePath) {
+ throw new Error('A file path must be provided');
+ }
+ if (!fileSettings.fileName) {
+ throw new Error('A file name must be provided');
+ }
+ } else {
+ throw new Error('File settings must be provided');
+ }
+
// building form-data
const form = new FormData();
- form.append('filename', fileName);
- form.append('attachment', createReadStream(pathToFile));
+ form.append('filename', fileSettings.fileName);
+ form.append('attachment', createReadStream(fileSettings.filePath));
// setting headers
const headers = form.getHeaders();
- headers.authorization = this.client._token;
+ headers.authorization = this._client._token;
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/attachment`,
params: options,
data: form,
@@ -144,7 +157,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async addComment(taskId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/comment`,
params: options,
data,
@@ -158,7 +171,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async getComments(taskId, options) {
- return this.client.get({
+ return this._client.get({
endpoint: `${this.route}/${taskId}/comment`,
params: options,
});
@@ -172,7 +185,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async createChecklist(taskId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/checklist`,
params: options,
data,
@@ -188,7 +201,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async setCustomFieldValue(taskId, fieldId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/field/${fieldId}`,
params: options,
data,
@@ -203,7 +216,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async deleteCustomFieldValue(taskId, fieldId, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/field/${fieldId}`,
params: options,
});
@@ -217,7 +230,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async addDependency(taskId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/dependency`,
params: options,
data,
@@ -228,14 +241,12 @@ routes/Tasks.js
* Delete a dependancy for a task
*
* @param {String} taskId The task id
- * @param {Object} data The dependency data
- * @param {Object} [options] The parameter options to pass in
+ * @param {Object} options The parameter options to pass in
*/
- async deleteDependency(taskId, data, options) {
- return this.client.delete({
+ async deleteDependency(taskId, options) {
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/dependency`,
params: options,
- data,
});
}
@@ -247,7 +258,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async addTaskLink(taskId, linksTo, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/link/${linksTo}`,
params: options,
});
@@ -261,7 +272,7 @@ routes/Tasks.js
* @param {String} [options] The parameter options to pass in
*/
async deleteTaskLink(taskId, linksTo, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/link/${linksTo}`,
params: options,
});
@@ -276,7 +287,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async addGuest(taskId, guestId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/guest/${guestId}`,
params: options,
data,
@@ -291,7 +302,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async removeGuest(taskId, guestId, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/guest/${guestId}`,
params: options,
});
@@ -303,7 +314,7 @@ routes/Tasks.js
* @param {String} taskId The task id
*/
async getMembers(taskId) {
- return this.client.get({
+ return this._client.get({
endpoint: `${this.route}/${taskId}/member`,
});
}
@@ -316,7 +327,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async addTag(taskId, tagName, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/tag/${tagName}`,
params: options,
});
@@ -330,7 +341,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async removeTag(taskId, tagName, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/tag/${tagName}`,
params: options,
});
@@ -344,7 +355,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async trackTime(taskId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/time`,
params: options,
data,
@@ -358,7 +369,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async getTrackedTime(taskId, options) {
- return this.client.get({
+ return this._client.get({
endpoint: `${this.route}/${taskId}/time`,
params: options,
});
@@ -373,7 +384,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async editTrackedTime(taskId, intervalId, data, options) {
- return this.client.put({
+ return this._client.put({
endpoint: `${this.route}/${taskId}/time/${intervalId}`,
params: options,
data,
@@ -388,11 +399,36 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async deleteTrackedTime(taskId, intervalId, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/time/${intervalId}`,
params: options,
});
}
+
+ /**
+ * Get tasks time in status
+ *
+ * @param {String} taskId The task id
+ * @param {Object} options The parameter options to pass in
+ */
+ async getTimeInStatus(taskId, options) {
+ return this._client.get({
+ endpoint: `${this.route}/${taskId}/time_in_status`,
+ params: options,
+ });
+ }
+
+ /**
+ * Get bulk tasks time in status
+ *
+ * @param {Object} options The parameter options to pass in
+ */
+ async getBulkTimeInStatus(options) {
+ return this._client.get({
+ endpoint: `${this.route}/bulk_time_in_status/task_ids`,
+ params: options,
+ });
+ }
}
module.exports = Tasks;
@@ -410,7 +446,7 @@ routes/Tasks.js
diff --git a/docs/routes_Teams.js.html b/docs/routes_Teams.js.html
index a6b0292..f94b0e5 100644
--- a/docs/routes_Teams.js.html
+++ b/docs/routes_Teams.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -492,7 +492,7 @@ routes/Teams.js
diff --git a/docs/routes_Views.js.html b/docs/routes_Views.js.html
index 78b49f5..926ddd0 100644
--- a/docs/routes_Views.js.html
+++ b/docs/routes_Views.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -156,7 +156,7 @@ routes/Views.js
diff --git a/docs/routes_Webhooks.js.html b/docs/routes_Webhooks.js.html
index 3c63132..d293778 100644
--- a/docs/routes_Webhooks.js.html
+++ b/docs/routes_Webhooks.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -106,7 +106,7 @@ routes/Webhooks.js
(async) Source:
Parameters:
+
+
+
+
+ (async) getBulkTimeInStatus(options)
+
+
+
+
+
+
+
+
+
+ - Source:
+ -
+ routes/Tasks.js, line 368
+
+
+
+
+
+
+
+ Get bulk tasks time in status
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+
+ The parameter options to pass in
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -3231,7 +3335,7 @@ (async) ge
Source:
(async) get
Source:
Parameters:
+
+
+
+
+ (async) getTimeInStatus(taskId, options)
+
+
+
+
+
+
+
+
+
+ - Source:
+ -
+ routes/Tasks.js, line 356
+
+
+
+
+
+
+
+ Get tasks time in status
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ taskId
+
+
+String
+
+
+
+
+
+
+
+
+
+ The task id
+
+
+
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+
+ The parameter options to pass in
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -3546,7 +3809,7 @@ (async) Source:
(async) re
Source:
(async) remo
Source:
(async) <
Source:
(async) trac
Source:
Parameters:
diff --git a/docs/Teams.html b/docs/Teams.html
index e1bfb10..b167170 100644
--- a/docs/Teams.html
+++ b/docs/Teams.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -5551,7 +5551,7 @@ Parameters:
diff --git a/docs/Views.html b/docs/Views.html
index 3dd5980..2d23dd6 100644
--- a/docs/Views.html
+++ b/docs/Views.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -1158,7 +1158,7 @@ Parameters:
diff --git a/docs/Webhooks.html b/docs/Webhooks.html
index 78b5adc..b27ddae 100644
--- a/docs/Webhooks.html
+++ b/docs/Webhooks.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -536,7 +536,7 @@ Parameters:
diff --git a/docs/index.html b/docs/index.html
index 1ee651c..1e7fea3 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -191,7 +191,7 @@ License
diff --git a/docs/index.js.html b/docs/index.js.html
index 45c4abd..4b1371f 100644
--- a/docs/index.js.html
+++ b/docs/index.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -236,7 +236,7 @@ index.js
diff --git a/docs/routes_Authorization.js.html b/docs/routes_Authorization.js.html
index 162039a..99eff42 100644
--- a/docs/routes_Authorization.js.html
+++ b/docs/routes_Authorization.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -117,7 +117,7 @@ routes/Authorization.js
diff --git a/docs/routes_Checklists.js.html b/docs/routes_Checklists.js.html
index 3e08aab..7ffcbc2 100644
--- a/docs/routes_Checklists.js.html
+++ b/docs/routes_Checklists.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -145,7 +145,7 @@ routes/Checklists.js
diff --git a/docs/routes_Comments.js.html b/docs/routes_Comments.js.html
index 5beb234..1b63066 100644
--- a/docs/routes_Comments.js.html
+++ b/docs/routes_Comments.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -106,7 +106,7 @@ routes/Comments.js
diff --git a/docs/routes_Folders.js.html b/docs/routes_Folders.js.html
index 4d4a587..b1a501a 100644
--- a/docs/routes_Folders.js.html
+++ b/docs/routes_Folders.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -195,7 +195,7 @@ routes/Folders.js
diff --git a/docs/routes_Goals.js.html b/docs/routes_Goals.js.html
index acd396e..036be9f 100644
--- a/docs/routes_Goals.js.html
+++ b/docs/routes_Goals.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -130,7 +130,7 @@ routes/Goals.js
diff --git a/docs/routes_KeyResults.js.html b/docs/routes_KeyResults.js.html
index f3c77ff..715438c 100644
--- a/docs/routes_KeyResults.js.html
+++ b/docs/routes_KeyResults.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -105,7 +105,7 @@ routes/KeyResults.js
diff --git a/docs/routes_Lists.js.html b/docs/routes_Lists.js.html
index e3a8b2f..f217b39 100644
--- a/docs/routes_Lists.js.html
+++ b/docs/routes_Lists.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -238,6 +238,41 @@ routes/Lists.js
endpoint: `${this.route}/${listId}/view`,
});
}
+
+ /**
+ * Add task to a list
+ *
+ * @param {String} listId The list id
+ * @param {String} taskId The task id
+ */
+ async addTaskToList(listId, taskId) {
+ return this._client.post({
+ endpoint: `${this.route}/${listId}/task/${taskId}`,
+ });
+ }
+
+ /**
+ * Remove a task from a list
+ *
+ * @param {Sting} listId The list id
+ * @param {String} taskId The task id
+ */
+ async removeTaskFromList(listId, taskId) {
+ return this._client.delete({
+ endpoint: `${this.route}/${listId}/task/${taskId}`,
+ });
+ }
+
+ /**
+ * Get list members
+ *
+ * @param {String} listId The list id
+ */
+ async getListMembers(listId) {
+ return this._client.get({
+ endpoint: `${this.route}/${listId}/member`,
+ });
+ }
}
module.exports = Lists;
@@ -255,7 +290,7 @@ routes/Lists.js
diff --git a/docs/routes_Spaces.js.html b/docs/routes_Spaces.js.html
index 8ade311..4c5818e 100644
--- a/docs/routes_Spaces.js.html
+++ b/docs/routes_Spaces.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -245,7 +245,7 @@ routes/Spaces.js
diff --git a/docs/routes_Tasks.js.html b/docs/routes_Tasks.js.html
index cefed6b..8c28fc8 100644
--- a/docs/routes_Tasks.js.html
+++ b/docs/routes_Tasks.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -65,7 +65,7 @@ routes/Tasks.js
* @param {Client} client A client instance
*/
constructor(client) {
- this.client = client;
+ this._client = client;
this.route = 'task';
}
@@ -76,7 +76,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async get(taskId, options) {
- return this.client.get({
+ return this._client.get({
endpoint: `${this.route}/${taskId}`,
params: options,
});
@@ -90,7 +90,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async update(taskId, data, options) {
- return this.client.put({
+ return this._client.put({
endpoint: `${this.route}/${taskId}`,
params: options,
data,
@@ -104,7 +104,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async delete(taskId, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}`,
params: options,
});
@@ -114,21 +114,34 @@ routes/Tasks.js
* Add an attachment to a task
*
* @param {String} taskId The task id
- * @param {String} pathToFile The path to the file
- * @param {String} [fileName='attachment'] The file name
+ * @param {Object} fileSettings The file settings
+ * @param {String} fileSettings.filePath The path to the file
+ * @param {String} fileSettings.fileName The name of the attachment file along with its extension type. Example: 'notes.txt'
* @param {Object} [options] The parameter options to pass in
*/
- async addAttachment(taskId, pathToFile, fileName = 'attachment', options) {
+ async addAttachment(taskId, fileSettings, options) {
+ // ensure fileSettings are provided
+ if (fileSettings) {
+ if (!fileSettings.filePath) {
+ throw new Error('A file path must be provided');
+ }
+ if (!fileSettings.fileName) {
+ throw new Error('A file name must be provided');
+ }
+ } else {
+ throw new Error('File settings must be provided');
+ }
+
// building form-data
const form = new FormData();
- form.append('filename', fileName);
- form.append('attachment', createReadStream(pathToFile));
+ form.append('filename', fileSettings.fileName);
+ form.append('attachment', createReadStream(fileSettings.filePath));
// setting headers
const headers = form.getHeaders();
- headers.authorization = this.client._token;
+ headers.authorization = this._client._token;
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/attachment`,
params: options,
data: form,
@@ -144,7 +157,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async addComment(taskId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/comment`,
params: options,
data,
@@ -158,7 +171,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async getComments(taskId, options) {
- return this.client.get({
+ return this._client.get({
endpoint: `${this.route}/${taskId}/comment`,
params: options,
});
@@ -172,7 +185,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async createChecklist(taskId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/checklist`,
params: options,
data,
@@ -188,7 +201,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async setCustomFieldValue(taskId, fieldId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/field/${fieldId}`,
params: options,
data,
@@ -203,7 +216,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async deleteCustomFieldValue(taskId, fieldId, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/field/${fieldId}`,
params: options,
});
@@ -217,7 +230,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async addDependency(taskId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/dependency`,
params: options,
data,
@@ -228,14 +241,12 @@ routes/Tasks.js
* Delete a dependancy for a task
*
* @param {String} taskId The task id
- * @param {Object} data The dependency data
- * @param {Object} [options] The parameter options to pass in
+ * @param {Object} options The parameter options to pass in
*/
- async deleteDependency(taskId, data, options) {
- return this.client.delete({
+ async deleteDependency(taskId, options) {
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/dependency`,
params: options,
- data,
});
}
@@ -247,7 +258,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async addTaskLink(taskId, linksTo, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/link/${linksTo}`,
params: options,
});
@@ -261,7 +272,7 @@ routes/Tasks.js
* @param {String} [options] The parameter options to pass in
*/
async deleteTaskLink(taskId, linksTo, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/link/${linksTo}`,
params: options,
});
@@ -276,7 +287,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async addGuest(taskId, guestId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/guest/${guestId}`,
params: options,
data,
@@ -291,7 +302,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async removeGuest(taskId, guestId, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/guest/${guestId}`,
params: options,
});
@@ -303,7 +314,7 @@ routes/Tasks.js
* @param {String} taskId The task id
*/
async getMembers(taskId) {
- return this.client.get({
+ return this._client.get({
endpoint: `${this.route}/${taskId}/member`,
});
}
@@ -316,7 +327,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async addTag(taskId, tagName, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/tag/${tagName}`,
params: options,
});
@@ -330,7 +341,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async removeTag(taskId, tagName, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/tag/${tagName}`,
params: options,
});
@@ -344,7 +355,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async trackTime(taskId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/time`,
params: options,
data,
@@ -358,7 +369,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async getTrackedTime(taskId, options) {
- return this.client.get({
+ return this._client.get({
endpoint: `${this.route}/${taskId}/time`,
params: options,
});
@@ -373,7 +384,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async editTrackedTime(taskId, intervalId, data, options) {
- return this.client.put({
+ return this._client.put({
endpoint: `${this.route}/${taskId}/time/${intervalId}`,
params: options,
data,
@@ -388,11 +399,36 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async deleteTrackedTime(taskId, intervalId, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/time/${intervalId}`,
params: options,
});
}
+
+ /**
+ * Get tasks time in status
+ *
+ * @param {String} taskId The task id
+ * @param {Object} options The parameter options to pass in
+ */
+ async getTimeInStatus(taskId, options) {
+ return this._client.get({
+ endpoint: `${this.route}/${taskId}/time_in_status`,
+ params: options,
+ });
+ }
+
+ /**
+ * Get bulk tasks time in status
+ *
+ * @param {Object} options The parameter options to pass in
+ */
+ async getBulkTimeInStatus(options) {
+ return this._client.get({
+ endpoint: `${this.route}/bulk_time_in_status/task_ids`,
+ params: options,
+ });
+ }
}
module.exports = Tasks;
@@ -410,7 +446,7 @@ routes/Tasks.js
diff --git a/docs/routes_Teams.js.html b/docs/routes_Teams.js.html
index a6b0292..f94b0e5 100644
--- a/docs/routes_Teams.js.html
+++ b/docs/routes_Teams.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -492,7 +492,7 @@ routes/Teams.js
diff --git a/docs/routes_Views.js.html b/docs/routes_Views.js.html
index 78b49f5..926ddd0 100644
--- a/docs/routes_Views.js.html
+++ b/docs/routes_Views.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -156,7 +156,7 @@ routes/Views.js
diff --git a/docs/routes_Webhooks.js.html b/docs/routes_Webhooks.js.html
index 3c63132..d293778 100644
--- a/docs/routes_Webhooks.js.html
+++ b/docs/routes_Webhooks.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -106,7 +106,7 @@ routes/Webhooks.js
- + routes/Tasks.js, line 368 +
Get bulk tasks time in status
+optionsThe parameter options to pass in
(async) get
Source:
Parameters:
+
+
+
+
+ (async) getTimeInStatus(taskId, options)
+
+
+
+
+
+
+
+
+
+ - Source:
+ -
+ routes/Tasks.js, line 356
+
+
+
+
+
+
+
+ Get tasks time in status
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
- + routes/Tasks.js, line 356 +
Get tasks time in status
+taskIdThe task id
optionsThe parameter options to pass in
(async) re
Source:
(async) remo
Source:
(async) <
Source:
(async) trac
Source:
Parameters:
diff --git a/docs/Teams.html b/docs/Teams.html
index e1bfb10..b167170 100644
--- a/docs/Teams.html
+++ b/docs/Teams.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -5551,7 +5551,7 @@ Parameters:
diff --git a/docs/Views.html b/docs/Views.html
index 3dd5980..2d23dd6 100644
--- a/docs/Views.html
+++ b/docs/Views.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -1158,7 +1158,7 @@ Parameters:
diff --git a/docs/Webhooks.html b/docs/Webhooks.html
index 78b5adc..b27ddae 100644
--- a/docs/Webhooks.html
+++ b/docs/Webhooks.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -536,7 +536,7 @@ Parameters:
diff --git a/docs/index.html b/docs/index.html
index 1ee651c..1e7fea3 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -191,7 +191,7 @@ License
diff --git a/docs/index.js.html b/docs/index.js.html
index 45c4abd..4b1371f 100644
--- a/docs/index.js.html
+++ b/docs/index.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -236,7 +236,7 @@ index.js
diff --git a/docs/routes_Authorization.js.html b/docs/routes_Authorization.js.html
index 162039a..99eff42 100644
--- a/docs/routes_Authorization.js.html
+++ b/docs/routes_Authorization.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -117,7 +117,7 @@ routes/Authorization.js
diff --git a/docs/routes_Checklists.js.html b/docs/routes_Checklists.js.html
index 3e08aab..7ffcbc2 100644
--- a/docs/routes_Checklists.js.html
+++ b/docs/routes_Checklists.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -145,7 +145,7 @@ routes/Checklists.js
diff --git a/docs/routes_Comments.js.html b/docs/routes_Comments.js.html
index 5beb234..1b63066 100644
--- a/docs/routes_Comments.js.html
+++ b/docs/routes_Comments.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -106,7 +106,7 @@ routes/Comments.js
diff --git a/docs/routes_Folders.js.html b/docs/routes_Folders.js.html
index 4d4a587..b1a501a 100644
--- a/docs/routes_Folders.js.html
+++ b/docs/routes_Folders.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -195,7 +195,7 @@ routes/Folders.js
diff --git a/docs/routes_Goals.js.html b/docs/routes_Goals.js.html
index acd396e..036be9f 100644
--- a/docs/routes_Goals.js.html
+++ b/docs/routes_Goals.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -130,7 +130,7 @@ routes/Goals.js
diff --git a/docs/routes_KeyResults.js.html b/docs/routes_KeyResults.js.html
index f3c77ff..715438c 100644
--- a/docs/routes_KeyResults.js.html
+++ b/docs/routes_KeyResults.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -105,7 +105,7 @@ routes/KeyResults.js
diff --git a/docs/routes_Lists.js.html b/docs/routes_Lists.js.html
index e3a8b2f..f217b39 100644
--- a/docs/routes_Lists.js.html
+++ b/docs/routes_Lists.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -238,6 +238,41 @@ routes/Lists.js
endpoint: `${this.route}/${listId}/view`,
});
}
+
+ /**
+ * Add task to a list
+ *
+ * @param {String} listId The list id
+ * @param {String} taskId The task id
+ */
+ async addTaskToList(listId, taskId) {
+ return this._client.post({
+ endpoint: `${this.route}/${listId}/task/${taskId}`,
+ });
+ }
+
+ /**
+ * Remove a task from a list
+ *
+ * @param {Sting} listId The list id
+ * @param {String} taskId The task id
+ */
+ async removeTaskFromList(listId, taskId) {
+ return this._client.delete({
+ endpoint: `${this.route}/${listId}/task/${taskId}`,
+ });
+ }
+
+ /**
+ * Get list members
+ *
+ * @param {String} listId The list id
+ */
+ async getListMembers(listId) {
+ return this._client.get({
+ endpoint: `${this.route}/${listId}/member`,
+ });
+ }
}
module.exports = Lists;
@@ -255,7 +290,7 @@ routes/Lists.js
diff --git a/docs/routes_Spaces.js.html b/docs/routes_Spaces.js.html
index 8ade311..4c5818e 100644
--- a/docs/routes_Spaces.js.html
+++ b/docs/routes_Spaces.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -245,7 +245,7 @@ routes/Spaces.js
diff --git a/docs/routes_Tasks.js.html b/docs/routes_Tasks.js.html
index cefed6b..8c28fc8 100644
--- a/docs/routes_Tasks.js.html
+++ b/docs/routes_Tasks.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -65,7 +65,7 @@ routes/Tasks.js
* @param {Client} client A client instance
*/
constructor(client) {
- this.client = client;
+ this._client = client;
this.route = 'task';
}
@@ -76,7 +76,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async get(taskId, options) {
- return this.client.get({
+ return this._client.get({
endpoint: `${this.route}/${taskId}`,
params: options,
});
@@ -90,7 +90,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async update(taskId, data, options) {
- return this.client.put({
+ return this._client.put({
endpoint: `${this.route}/${taskId}`,
params: options,
data,
@@ -104,7 +104,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async delete(taskId, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}`,
params: options,
});
@@ -114,21 +114,34 @@ routes/Tasks.js
* Add an attachment to a task
*
* @param {String} taskId The task id
- * @param {String} pathToFile The path to the file
- * @param {String} [fileName='attachment'] The file name
+ * @param {Object} fileSettings The file settings
+ * @param {String} fileSettings.filePath The path to the file
+ * @param {String} fileSettings.fileName The name of the attachment file along with its extension type. Example: 'notes.txt'
* @param {Object} [options] The parameter options to pass in
*/
- async addAttachment(taskId, pathToFile, fileName = 'attachment', options) {
+ async addAttachment(taskId, fileSettings, options) {
+ // ensure fileSettings are provided
+ if (fileSettings) {
+ if (!fileSettings.filePath) {
+ throw new Error('A file path must be provided');
+ }
+ if (!fileSettings.fileName) {
+ throw new Error('A file name must be provided');
+ }
+ } else {
+ throw new Error('File settings must be provided');
+ }
+
// building form-data
const form = new FormData();
- form.append('filename', fileName);
- form.append('attachment', createReadStream(pathToFile));
+ form.append('filename', fileSettings.fileName);
+ form.append('attachment', createReadStream(fileSettings.filePath));
// setting headers
const headers = form.getHeaders();
- headers.authorization = this.client._token;
+ headers.authorization = this._client._token;
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/attachment`,
params: options,
data: form,
@@ -144,7 +157,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async addComment(taskId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/comment`,
params: options,
data,
@@ -158,7 +171,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async getComments(taskId, options) {
- return this.client.get({
+ return this._client.get({
endpoint: `${this.route}/${taskId}/comment`,
params: options,
});
@@ -172,7 +185,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async createChecklist(taskId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/checklist`,
params: options,
data,
@@ -188,7 +201,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async setCustomFieldValue(taskId, fieldId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/field/${fieldId}`,
params: options,
data,
@@ -203,7 +216,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async deleteCustomFieldValue(taskId, fieldId, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/field/${fieldId}`,
params: options,
});
@@ -217,7 +230,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async addDependency(taskId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/dependency`,
params: options,
data,
@@ -228,14 +241,12 @@ routes/Tasks.js
* Delete a dependancy for a task
*
* @param {String} taskId The task id
- * @param {Object} data The dependency data
- * @param {Object} [options] The parameter options to pass in
+ * @param {Object} options The parameter options to pass in
*/
- async deleteDependency(taskId, data, options) {
- return this.client.delete({
+ async deleteDependency(taskId, options) {
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/dependency`,
params: options,
- data,
});
}
@@ -247,7 +258,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async addTaskLink(taskId, linksTo, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/link/${linksTo}`,
params: options,
});
@@ -261,7 +272,7 @@ routes/Tasks.js
* @param {String} [options] The parameter options to pass in
*/
async deleteTaskLink(taskId, linksTo, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/link/${linksTo}`,
params: options,
});
@@ -276,7 +287,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async addGuest(taskId, guestId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/guest/${guestId}`,
params: options,
data,
@@ -291,7 +302,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async removeGuest(taskId, guestId, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/guest/${guestId}`,
params: options,
});
@@ -303,7 +314,7 @@ routes/Tasks.js
* @param {String} taskId The task id
*/
async getMembers(taskId) {
- return this.client.get({
+ return this._client.get({
endpoint: `${this.route}/${taskId}/member`,
});
}
@@ -316,7 +327,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async addTag(taskId, tagName, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/tag/${tagName}`,
params: options,
});
@@ -330,7 +341,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async removeTag(taskId, tagName, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/tag/${tagName}`,
params: options,
});
@@ -344,7 +355,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async trackTime(taskId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/time`,
params: options,
data,
@@ -358,7 +369,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async getTrackedTime(taskId, options) {
- return this.client.get({
+ return this._client.get({
endpoint: `${this.route}/${taskId}/time`,
params: options,
});
@@ -373,7 +384,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async editTrackedTime(taskId, intervalId, data, options) {
- return this.client.put({
+ return this._client.put({
endpoint: `${this.route}/${taskId}/time/${intervalId}`,
params: options,
data,
@@ -388,11 +399,36 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async deleteTrackedTime(taskId, intervalId, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/time/${intervalId}`,
params: options,
});
}
+
+ /**
+ * Get tasks time in status
+ *
+ * @param {String} taskId The task id
+ * @param {Object} options The parameter options to pass in
+ */
+ async getTimeInStatus(taskId, options) {
+ return this._client.get({
+ endpoint: `${this.route}/${taskId}/time_in_status`,
+ params: options,
+ });
+ }
+
+ /**
+ * Get bulk tasks time in status
+ *
+ * @param {Object} options The parameter options to pass in
+ */
+ async getBulkTimeInStatus(options) {
+ return this._client.get({
+ endpoint: `${this.route}/bulk_time_in_status/task_ids`,
+ params: options,
+ });
+ }
}
module.exports = Tasks;
@@ -410,7 +446,7 @@ routes/Tasks.js
diff --git a/docs/routes_Teams.js.html b/docs/routes_Teams.js.html
index a6b0292..f94b0e5 100644
--- a/docs/routes_Teams.js.html
+++ b/docs/routes_Teams.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -492,7 +492,7 @@ routes/Teams.js
diff --git a/docs/routes_Views.js.html b/docs/routes_Views.js.html
index 78b49f5..926ddd0 100644
--- a/docs/routes_Views.js.html
+++ b/docs/routes_Views.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -156,7 +156,7 @@ routes/Views.js
diff --git a/docs/routes_Webhooks.js.html b/docs/routes_Webhooks.js.html
index 3c63132..d293778 100644
--- a/docs/routes_Webhooks.js.html
+++ b/docs/routes_Webhooks.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -106,7 +106,7 @@ routes/Webhooks.js
(async) <
Source:
(async) trac
Source:
Parameters:
diff --git a/docs/Teams.html b/docs/Teams.html
index e1bfb10..b167170 100644
--- a/docs/Teams.html
+++ b/docs/Teams.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -5551,7 +5551,7 @@ Parameters:
diff --git a/docs/Views.html b/docs/Views.html
index 3dd5980..2d23dd6 100644
--- a/docs/Views.html
+++ b/docs/Views.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -1158,7 +1158,7 @@ Parameters:
diff --git a/docs/Webhooks.html b/docs/Webhooks.html
index 78b5adc..b27ddae 100644
--- a/docs/Webhooks.html
+++ b/docs/Webhooks.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -536,7 +536,7 @@ Parameters:
diff --git a/docs/index.html b/docs/index.html
index 1ee651c..1e7fea3 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -191,7 +191,7 @@ License
diff --git a/docs/index.js.html b/docs/index.js.html
index 45c4abd..4b1371f 100644
--- a/docs/index.js.html
+++ b/docs/index.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -236,7 +236,7 @@ index.js
diff --git a/docs/routes_Authorization.js.html b/docs/routes_Authorization.js.html
index 162039a..99eff42 100644
--- a/docs/routes_Authorization.js.html
+++ b/docs/routes_Authorization.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -117,7 +117,7 @@ routes/Authorization.js
diff --git a/docs/routes_Checklists.js.html b/docs/routes_Checklists.js.html
index 3e08aab..7ffcbc2 100644
--- a/docs/routes_Checklists.js.html
+++ b/docs/routes_Checklists.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -145,7 +145,7 @@ routes/Checklists.js
diff --git a/docs/routes_Comments.js.html b/docs/routes_Comments.js.html
index 5beb234..1b63066 100644
--- a/docs/routes_Comments.js.html
+++ b/docs/routes_Comments.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -106,7 +106,7 @@ routes/Comments.js
diff --git a/docs/routes_Folders.js.html b/docs/routes_Folders.js.html
index 4d4a587..b1a501a 100644
--- a/docs/routes_Folders.js.html
+++ b/docs/routes_Folders.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -195,7 +195,7 @@ routes/Folders.js
diff --git a/docs/routes_Goals.js.html b/docs/routes_Goals.js.html
index acd396e..036be9f 100644
--- a/docs/routes_Goals.js.html
+++ b/docs/routes_Goals.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -130,7 +130,7 @@ routes/Goals.js
diff --git a/docs/routes_KeyResults.js.html b/docs/routes_KeyResults.js.html
index f3c77ff..715438c 100644
--- a/docs/routes_KeyResults.js.html
+++ b/docs/routes_KeyResults.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -105,7 +105,7 @@ routes/KeyResults.js
diff --git a/docs/routes_Lists.js.html b/docs/routes_Lists.js.html
index e3a8b2f..f217b39 100644
--- a/docs/routes_Lists.js.html
+++ b/docs/routes_Lists.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -238,6 +238,41 @@ routes/Lists.js
endpoint: `${this.route}/${listId}/view`,
});
}
+
+ /**
+ * Add task to a list
+ *
+ * @param {String} listId The list id
+ * @param {String} taskId The task id
+ */
+ async addTaskToList(listId, taskId) {
+ return this._client.post({
+ endpoint: `${this.route}/${listId}/task/${taskId}`,
+ });
+ }
+
+ /**
+ * Remove a task from a list
+ *
+ * @param {Sting} listId The list id
+ * @param {String} taskId The task id
+ */
+ async removeTaskFromList(listId, taskId) {
+ return this._client.delete({
+ endpoint: `${this.route}/${listId}/task/${taskId}`,
+ });
+ }
+
+ /**
+ * Get list members
+ *
+ * @param {String} listId The list id
+ */
+ async getListMembers(listId) {
+ return this._client.get({
+ endpoint: `${this.route}/${listId}/member`,
+ });
+ }
}
module.exports = Lists;
@@ -255,7 +290,7 @@ routes/Lists.js
diff --git a/docs/routes_Spaces.js.html b/docs/routes_Spaces.js.html
index 8ade311..4c5818e 100644
--- a/docs/routes_Spaces.js.html
+++ b/docs/routes_Spaces.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -245,7 +245,7 @@ routes/Spaces.js
diff --git a/docs/routes_Tasks.js.html b/docs/routes_Tasks.js.html
index cefed6b..8c28fc8 100644
--- a/docs/routes_Tasks.js.html
+++ b/docs/routes_Tasks.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -65,7 +65,7 @@ routes/Tasks.js
* @param {Client} client A client instance
*/
constructor(client) {
- this.client = client;
+ this._client = client;
this.route = 'task';
}
@@ -76,7 +76,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async get(taskId, options) {
- return this.client.get({
+ return this._client.get({
endpoint: `${this.route}/${taskId}`,
params: options,
});
@@ -90,7 +90,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async update(taskId, data, options) {
- return this.client.put({
+ return this._client.put({
endpoint: `${this.route}/${taskId}`,
params: options,
data,
@@ -104,7 +104,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async delete(taskId, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}`,
params: options,
});
@@ -114,21 +114,34 @@ routes/Tasks.js
* Add an attachment to a task
*
* @param {String} taskId The task id
- * @param {String} pathToFile The path to the file
- * @param {String} [fileName='attachment'] The file name
+ * @param {Object} fileSettings The file settings
+ * @param {String} fileSettings.filePath The path to the file
+ * @param {String} fileSettings.fileName The name of the attachment file along with its extension type. Example: 'notes.txt'
* @param {Object} [options] The parameter options to pass in
*/
- async addAttachment(taskId, pathToFile, fileName = 'attachment', options) {
+ async addAttachment(taskId, fileSettings, options) {
+ // ensure fileSettings are provided
+ if (fileSettings) {
+ if (!fileSettings.filePath) {
+ throw new Error('A file path must be provided');
+ }
+ if (!fileSettings.fileName) {
+ throw new Error('A file name must be provided');
+ }
+ } else {
+ throw new Error('File settings must be provided');
+ }
+
// building form-data
const form = new FormData();
- form.append('filename', fileName);
- form.append('attachment', createReadStream(pathToFile));
+ form.append('filename', fileSettings.fileName);
+ form.append('attachment', createReadStream(fileSettings.filePath));
// setting headers
const headers = form.getHeaders();
- headers.authorization = this.client._token;
+ headers.authorization = this._client._token;
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/attachment`,
params: options,
data: form,
@@ -144,7 +157,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async addComment(taskId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/comment`,
params: options,
data,
@@ -158,7 +171,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async getComments(taskId, options) {
- return this.client.get({
+ return this._client.get({
endpoint: `${this.route}/${taskId}/comment`,
params: options,
});
@@ -172,7 +185,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async createChecklist(taskId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/checklist`,
params: options,
data,
@@ -188,7 +201,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async setCustomFieldValue(taskId, fieldId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/field/${fieldId}`,
params: options,
data,
@@ -203,7 +216,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async deleteCustomFieldValue(taskId, fieldId, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/field/${fieldId}`,
params: options,
});
@@ -217,7 +230,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async addDependency(taskId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/dependency`,
params: options,
data,
@@ -228,14 +241,12 @@ routes/Tasks.js
* Delete a dependancy for a task
*
* @param {String} taskId The task id
- * @param {Object} data The dependency data
- * @param {Object} [options] The parameter options to pass in
+ * @param {Object} options The parameter options to pass in
*/
- async deleteDependency(taskId, data, options) {
- return this.client.delete({
+ async deleteDependency(taskId, options) {
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/dependency`,
params: options,
- data,
});
}
@@ -247,7 +258,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async addTaskLink(taskId, linksTo, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/link/${linksTo}`,
params: options,
});
@@ -261,7 +272,7 @@ routes/Tasks.js
* @param {String} [options] The parameter options to pass in
*/
async deleteTaskLink(taskId, linksTo, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/link/${linksTo}`,
params: options,
});
@@ -276,7 +287,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async addGuest(taskId, guestId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/guest/${guestId}`,
params: options,
data,
@@ -291,7 +302,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async removeGuest(taskId, guestId, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/guest/${guestId}`,
params: options,
});
@@ -303,7 +314,7 @@ routes/Tasks.js
* @param {String} taskId The task id
*/
async getMembers(taskId) {
- return this.client.get({
+ return this._client.get({
endpoint: `${this.route}/${taskId}/member`,
});
}
@@ -316,7 +327,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async addTag(taskId, tagName, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/tag/${tagName}`,
params: options,
});
@@ -330,7 +341,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async removeTag(taskId, tagName, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/tag/${tagName}`,
params: options,
});
@@ -344,7 +355,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async trackTime(taskId, data, options) {
- return this.client.post({
+ return this._client.post({
endpoint: `${this.route}/${taskId}/time`,
params: options,
data,
@@ -358,7 +369,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async getTrackedTime(taskId, options) {
- return this.client.get({
+ return this._client.get({
endpoint: `${this.route}/${taskId}/time`,
params: options,
});
@@ -373,7 +384,7 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async editTrackedTime(taskId, intervalId, data, options) {
- return this.client.put({
+ return this._client.put({
endpoint: `${this.route}/${taskId}/time/${intervalId}`,
params: options,
data,
@@ -388,11 +399,36 @@ routes/Tasks.js
* @param {Object} [options] The parameter options to pass in
*/
async deleteTrackedTime(taskId, intervalId, options) {
- return this.client.delete({
+ return this._client.delete({
endpoint: `${this.route}/${taskId}/time/${intervalId}`,
params: options,
});
}
+
+ /**
+ * Get tasks time in status
+ *
+ * @param {String} taskId The task id
+ * @param {Object} options The parameter options to pass in
+ */
+ async getTimeInStatus(taskId, options) {
+ return this._client.get({
+ endpoint: `${this.route}/${taskId}/time_in_status`,
+ params: options,
+ });
+ }
+
+ /**
+ * Get bulk tasks time in status
+ *
+ * @param {Object} options The parameter options to pass in
+ */
+ async getBulkTimeInStatus(options) {
+ return this._client.get({
+ endpoint: `${this.route}/bulk_time_in_status/task_ids`,
+ params: options,
+ });
+ }
}
module.exports = Tasks;
@@ -410,7 +446,7 @@ routes/Tasks.js
diff --git a/docs/routes_Teams.js.html b/docs/routes_Teams.js.html
index a6b0292..f94b0e5 100644
--- a/docs/routes_Teams.js.html
+++ b/docs/routes_Teams.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -492,7 +492,7 @@ routes/Teams.js
diff --git a/docs/routes_Views.js.html b/docs/routes_Views.js.html
index 78b49f5..926ddd0 100644
--- a/docs/routes_Views.js.html
+++ b/docs/routes_Views.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -156,7 +156,7 @@ routes/Views.js
diff --git a/docs/routes_Webhooks.js.html b/docs/routes_Webhooks.js.html
index 3c63132..d293778 100644
--- a/docs/routes_Webhooks.js.html
+++ b/docs/routes_Webhooks.js.html
@@ -41,7 +41,7 @@
- Home
Github Repo
Classes
+ Home
Github Repo
Classes
@@ -106,7 +106,7 @@ routes/Webhooks.js
Parameters:
diff --git a/docs/Teams.html b/docs/Teams.html index e1bfb10..b167170 100644 --- a/docs/Teams.html +++ b/docs/Teams.html @@ -41,7 +41,7 @@ -
Home
Github Repo
Classes
+Home
Github Repo
Classes
@@ -5551,7 +5551,7 @@
diff --git a/docs/Views.html b/docs/Views.html index 3dd5980..2d23dd6 100644 --- a/docs/Views.html +++ b/docs/Views.html @@ -41,7 +41,7 @@ -
Parameters:
diff --git a/docs/Views.html b/docs/Views.html index 3dd5980..2d23dd6 100644 --- a/docs/Views.html +++ b/docs/Views.html @@ -41,7 +41,7 @@ -
Home
Github Repo
Classes
+Home
Github Repo
Classes
@@ -1158,7 +1158,7 @@
diff --git a/docs/Webhooks.html b/docs/Webhooks.html index 78b5adc..b27ddae 100644 --- a/docs/Webhooks.html +++ b/docs/Webhooks.html @@ -41,7 +41,7 @@ -
Parameters:
diff --git a/docs/Webhooks.html b/docs/Webhooks.html index 78b5adc..b27ddae 100644 --- a/docs/Webhooks.html +++ b/docs/Webhooks.html @@ -41,7 +41,7 @@ -
Home
Github Repo
Classes
+Home
Github Repo
Classes
@@ -536,7 +536,7 @@
diff --git a/docs/index.html b/docs/index.html index 1ee651c..1e7fea3 100644 --- a/docs/index.html +++ b/docs/index.html @@ -41,7 +41,7 @@ -
Parameters:
diff --git a/docs/index.html b/docs/index.html index 1ee651c..1e7fea3 100644 --- a/docs/index.html +++ b/docs/index.html @@ -41,7 +41,7 @@ -
Home
Github Repo
Classes
+Home
Github Repo
Classes
@@ -191,7 +191,7 @@
diff --git a/docs/index.js.html b/docs/index.js.html index 45c4abd..4b1371f 100644 --- a/docs/index.js.html +++ b/docs/index.js.html @@ -41,7 +41,7 @@ -
License
diff --git a/docs/index.js.html b/docs/index.js.html index 45c4abd..4b1371f 100644 --- a/docs/index.js.html +++ b/docs/index.js.html @@ -41,7 +41,7 @@ -
Home
Github Repo
Classes
+Home
Github Repo
Classes
@@ -236,7 +236,7 @@
diff --git a/docs/routes_Authorization.js.html b/docs/routes_Authorization.js.html index 162039a..99eff42 100644 --- a/docs/routes_Authorization.js.html +++ b/docs/routes_Authorization.js.html @@ -41,7 +41,7 @@ -
index.js
diff --git a/docs/routes_Authorization.js.html b/docs/routes_Authorization.js.html index 162039a..99eff42 100644 --- a/docs/routes_Authorization.js.html +++ b/docs/routes_Authorization.js.html @@ -41,7 +41,7 @@ -
Home
Github Repo
Classes
+Home
Github Repo
Classes
@@ -117,7 +117,7 @@
diff --git a/docs/routes_Checklists.js.html b/docs/routes_Checklists.js.html index 3e08aab..7ffcbc2 100644 --- a/docs/routes_Checklists.js.html +++ b/docs/routes_Checklists.js.html @@ -41,7 +41,7 @@ -
routes/Authorization.js
diff --git a/docs/routes_Checklists.js.html b/docs/routes_Checklists.js.html index 3e08aab..7ffcbc2 100644 --- a/docs/routes_Checklists.js.html +++ b/docs/routes_Checklists.js.html @@ -41,7 +41,7 @@ -
Home
Github Repo
Classes
+Home
Github Repo
Classes
@@ -145,7 +145,7 @@
diff --git a/docs/routes_Comments.js.html b/docs/routes_Comments.js.html index 5beb234..1b63066 100644 --- a/docs/routes_Comments.js.html +++ b/docs/routes_Comments.js.html @@ -41,7 +41,7 @@ -
routes/Checklists.js
diff --git a/docs/routes_Comments.js.html b/docs/routes_Comments.js.html index 5beb234..1b63066 100644 --- a/docs/routes_Comments.js.html +++ b/docs/routes_Comments.js.html @@ -41,7 +41,7 @@ -
Home
Github Repo
Classes
+Home
Github Repo
Classes
@@ -106,7 +106,7 @@
diff --git a/docs/routes_Folders.js.html b/docs/routes_Folders.js.html index 4d4a587..b1a501a 100644 --- a/docs/routes_Folders.js.html +++ b/docs/routes_Folders.js.html @@ -41,7 +41,7 @@ -
routes/Comments.js
diff --git a/docs/routes_Folders.js.html b/docs/routes_Folders.js.html index 4d4a587..b1a501a 100644 --- a/docs/routes_Folders.js.html +++ b/docs/routes_Folders.js.html @@ -41,7 +41,7 @@ -
Home
Github Repo
Classes
+Home
Github Repo
Classes
@@ -195,7 +195,7 @@
diff --git a/docs/routes_Goals.js.html b/docs/routes_Goals.js.html index acd396e..036be9f 100644 --- a/docs/routes_Goals.js.html +++ b/docs/routes_Goals.js.html @@ -41,7 +41,7 @@ -
routes/Folders.js
diff --git a/docs/routes_Goals.js.html b/docs/routes_Goals.js.html index acd396e..036be9f 100644 --- a/docs/routes_Goals.js.html +++ b/docs/routes_Goals.js.html @@ -41,7 +41,7 @@ -
Home
Github Repo
Classes
+Home
Github Repo
Classes
@@ -130,7 +130,7 @@
diff --git a/docs/routes_KeyResults.js.html b/docs/routes_KeyResults.js.html index f3c77ff..715438c 100644 --- a/docs/routes_KeyResults.js.html +++ b/docs/routes_KeyResults.js.html @@ -41,7 +41,7 @@ -
routes/Goals.js
diff --git a/docs/routes_KeyResults.js.html b/docs/routes_KeyResults.js.html index f3c77ff..715438c 100644 --- a/docs/routes_KeyResults.js.html +++ b/docs/routes_KeyResults.js.html @@ -41,7 +41,7 @@ -
Home
Github Repo
Classes
+Home
Github Repo
Classes
@@ -105,7 +105,7 @@
diff --git a/docs/routes_Lists.js.html b/docs/routes_Lists.js.html index e3a8b2f..f217b39 100644 --- a/docs/routes_Lists.js.html +++ b/docs/routes_Lists.js.html @@ -41,7 +41,7 @@ -
routes/KeyResults.js
diff --git a/docs/routes_Lists.js.html b/docs/routes_Lists.js.html index e3a8b2f..f217b39 100644 --- a/docs/routes_Lists.js.html +++ b/docs/routes_Lists.js.html @@ -41,7 +41,7 @@ -
Home
Github Repo
Classes
+Home
Github Repo
Classes
@@ -238,6 +238,41 @@
diff --git a/docs/routes_Spaces.js.html b/docs/routes_Spaces.js.html index 8ade311..4c5818e 100644 --- a/docs/routes_Spaces.js.html +++ b/docs/routes_Spaces.js.html @@ -41,7 +41,7 @@ -
routes/Lists.js
endpoint: `${this.route}/${listId}/view`, }); } + + /** + * Add task to a list + * + * @param {String} listId The list id + * @param {String} taskId The task id + */ + async addTaskToList(listId, taskId) { + return this._client.post({ + endpoint: `${this.route}/${listId}/task/${taskId}`, + }); + } + + /** + * Remove a task from a list + * + * @param {Sting} listId The list id + * @param {String} taskId The task id + */ + async removeTaskFromList(listId, taskId) { + return this._client.delete({ + endpoint: `${this.route}/${listId}/task/${taskId}`, + }); + } + + /** + * Get list members + * + * @param {String} listId The list id + */ + async getListMembers(listId) { + return this._client.get({ + endpoint: `${this.route}/${listId}/member`, + }); + } } module.exports = Lists; @@ -255,7 +290,7 @@routes/Lists.js
diff --git a/docs/routes_Spaces.js.html b/docs/routes_Spaces.js.html index 8ade311..4c5818e 100644 --- a/docs/routes_Spaces.js.html +++ b/docs/routes_Spaces.js.html @@ -41,7 +41,7 @@ -
Home
Github Repo
Classes
+Home
Github Repo
Classes
@@ -245,7 +245,7 @@
diff --git a/docs/routes_Tasks.js.html b/docs/routes_Tasks.js.html index cefed6b..8c28fc8 100644 --- a/docs/routes_Tasks.js.html +++ b/docs/routes_Tasks.js.html @@ -41,7 +41,7 @@ -
routes/Spaces.js
diff --git a/docs/routes_Tasks.js.html b/docs/routes_Tasks.js.html index cefed6b..8c28fc8 100644 --- a/docs/routes_Tasks.js.html +++ b/docs/routes_Tasks.js.html @@ -41,7 +41,7 @@ -
Home
Github Repo
Classes
+Home
Github Repo
Classes
@@ -65,7 +65,7 @@
diff --git a/docs/routes_Teams.js.html b/docs/routes_Teams.js.html index a6b0292..f94b0e5 100644 --- a/docs/routes_Teams.js.html +++ b/docs/routes_Teams.js.html @@ -41,7 +41,7 @@ -
routes/Tasks.js
* @param {Client} client A client instance */ constructor(client) { - this.client = client; + this._client = client; this.route = 'task'; } @@ -76,7 +76,7 @@routes/Tasks.js
* @param {Object} [options] The parameter options to pass in */ async get(taskId, options) { - return this.client.get({ + return this._client.get({ endpoint: `${this.route}/${taskId}`, params: options, }); @@ -90,7 +90,7 @@routes/Tasks.js
* @param {Object} [options] The parameter options to pass in */ async update(taskId, data, options) { - return this.client.put({ + return this._client.put({ endpoint: `${this.route}/${taskId}`, params: options, data, @@ -104,7 +104,7 @@routes/Tasks.js
* @param {Object} [options] The parameter options to pass in */ async delete(taskId, options) { - return this.client.delete({ + return this._client.delete({ endpoint: `${this.route}/${taskId}`, params: options, }); @@ -114,21 +114,34 @@routes/Tasks.js
* Add an attachment to a task * * @param {String} taskId The task id - * @param {String} pathToFile The path to the file - * @param {String} [fileName='attachment'] The file name + * @param {Object} fileSettings The file settings + * @param {String} fileSettings.filePath The path to the file + * @param {String} fileSettings.fileName The name of the attachment file along with its extension type. Example: 'notes.txt' * @param {Object} [options] The parameter options to pass in */ - async addAttachment(taskId, pathToFile, fileName = 'attachment', options) { + async addAttachment(taskId, fileSettings, options) { + // ensure fileSettings are provided + if (fileSettings) { + if (!fileSettings.filePath) { + throw new Error('A file path must be provided'); + } + if (!fileSettings.fileName) { + throw new Error('A file name must be provided'); + } + } else { + throw new Error('File settings must be provided'); + } + // building form-data const form = new FormData(); - form.append('filename', fileName); - form.append('attachment', createReadStream(pathToFile)); + form.append('filename', fileSettings.fileName); + form.append('attachment', createReadStream(fileSettings.filePath)); // setting headers const headers = form.getHeaders(); - headers.authorization = this.client._token; + headers.authorization = this._client._token; - return this.client.post({ + return this._client.post({ endpoint: `${this.route}/${taskId}/attachment`, params: options, data: form, @@ -144,7 +157,7 @@routes/Tasks.js
* @param {Object} [options] The parameter options to pass in */ async addComment(taskId, data, options) { - return this.client.post({ + return this._client.post({ endpoint: `${this.route}/${taskId}/comment`, params: options, data, @@ -158,7 +171,7 @@routes/Tasks.js
* @param {Object} [options] The parameter options to pass in */ async getComments(taskId, options) { - return this.client.get({ + return this._client.get({ endpoint: `${this.route}/${taskId}/comment`, params: options, }); @@ -172,7 +185,7 @@routes/Tasks.js
* @param {Object} [options] The parameter options to pass in */ async createChecklist(taskId, data, options) { - return this.client.post({ + return this._client.post({ endpoint: `${this.route}/${taskId}/checklist`, params: options, data, @@ -188,7 +201,7 @@routes/Tasks.js
* @param {Object} [options] The parameter options to pass in */ async setCustomFieldValue(taskId, fieldId, data, options) { - return this.client.post({ + return this._client.post({ endpoint: `${this.route}/${taskId}/field/${fieldId}`, params: options, data, @@ -203,7 +216,7 @@routes/Tasks.js
* @param {Object} [options] The parameter options to pass in */ async deleteCustomFieldValue(taskId, fieldId, options) { - return this.client.delete({ + return this._client.delete({ endpoint: `${this.route}/${taskId}/field/${fieldId}`, params: options, }); @@ -217,7 +230,7 @@routes/Tasks.js
* @param {Object} [options] The parameter options to pass in */ async addDependency(taskId, data, options) { - return this.client.post({ + return this._client.post({ endpoint: `${this.route}/${taskId}/dependency`, params: options, data, @@ -228,14 +241,12 @@routes/Tasks.js
* Delete a dependancy for a task * * @param {String} taskId The task id - * @param {Object} data The dependency data - * @param {Object} [options] The parameter options to pass in + * @param {Object} options The parameter options to pass in */ - async deleteDependency(taskId, data, options) { - return this.client.delete({ + async deleteDependency(taskId, options) { + return this._client.delete({ endpoint: `${this.route}/${taskId}/dependency`, params: options, - data, }); } @@ -247,7 +258,7 @@routes/Tasks.js
* @param {Object} [options] The parameter options to pass in */ async addTaskLink(taskId, linksTo, options) { - return this.client.post({ + return this._client.post({ endpoint: `${this.route}/${taskId}/link/${linksTo}`, params: options, }); @@ -261,7 +272,7 @@routes/Tasks.js
* @param {String} [options] The parameter options to pass in */ async deleteTaskLink(taskId, linksTo, options) { - return this.client.delete({ + return this._client.delete({ endpoint: `${this.route}/${taskId}/link/${linksTo}`, params: options, }); @@ -276,7 +287,7 @@routes/Tasks.js
* @param {Object} [options] The parameter options to pass in */ async addGuest(taskId, guestId, data, options) { - return this.client.post({ + return this._client.post({ endpoint: `${this.route}/${taskId}/guest/${guestId}`, params: options, data, @@ -291,7 +302,7 @@routes/Tasks.js
* @param {Object} [options] The parameter options to pass in */ async removeGuest(taskId, guestId, options) { - return this.client.delete({ + return this._client.delete({ endpoint: `${this.route}/${taskId}/guest/${guestId}`, params: options, }); @@ -303,7 +314,7 @@routes/Tasks.js
* @param {String} taskId The task id */ async getMembers(taskId) { - return this.client.get({ + return this._client.get({ endpoint: `${this.route}/${taskId}/member`, }); } @@ -316,7 +327,7 @@routes/Tasks.js
* @param {Object} [options] The parameter options to pass in */ async addTag(taskId, tagName, options) { - return this.client.post({ + return this._client.post({ endpoint: `${this.route}/${taskId}/tag/${tagName}`, params: options, }); @@ -330,7 +341,7 @@routes/Tasks.js
* @param {Object} [options] The parameter options to pass in */ async removeTag(taskId, tagName, options) { - return this.client.delete({ + return this._client.delete({ endpoint: `${this.route}/${taskId}/tag/${tagName}`, params: options, }); @@ -344,7 +355,7 @@routes/Tasks.js
* @param {Object} [options] The parameter options to pass in */ async trackTime(taskId, data, options) { - return this.client.post({ + return this._client.post({ endpoint: `${this.route}/${taskId}/time`, params: options, data, @@ -358,7 +369,7 @@routes/Tasks.js
* @param {Object} [options] The parameter options to pass in */ async getTrackedTime(taskId, options) { - return this.client.get({ + return this._client.get({ endpoint: `${this.route}/${taskId}/time`, params: options, }); @@ -373,7 +384,7 @@routes/Tasks.js
* @param {Object} [options] The parameter options to pass in */ async editTrackedTime(taskId, intervalId, data, options) { - return this.client.put({ + return this._client.put({ endpoint: `${this.route}/${taskId}/time/${intervalId}`, params: options, data, @@ -388,11 +399,36 @@routes/Tasks.js
* @param {Object} [options] The parameter options to pass in */ async deleteTrackedTime(taskId, intervalId, options) { - return this.client.delete({ + return this._client.delete({ endpoint: `${this.route}/${taskId}/time/${intervalId}`, params: options, }); } + + /** + * Get tasks time in status + * + * @param {String} taskId The task id + * @param {Object} options The parameter options to pass in + */ + async getTimeInStatus(taskId, options) { + return this._client.get({ + endpoint: `${this.route}/${taskId}/time_in_status`, + params: options, + }); + } + + /** + * Get bulk tasks time in status + * + * @param {Object} options The parameter options to pass in + */ + async getBulkTimeInStatus(options) { + return this._client.get({ + endpoint: `${this.route}/bulk_time_in_status/task_ids`, + params: options, + }); + } } module.exports = Tasks; @@ -410,7 +446,7 @@routes/Tasks.js
diff --git a/docs/routes_Teams.js.html b/docs/routes_Teams.js.html index a6b0292..f94b0e5 100644 --- a/docs/routes_Teams.js.html +++ b/docs/routes_Teams.js.html @@ -41,7 +41,7 @@ -
Home
Github Repo
Classes
+Home
Github Repo
Classes
@@ -492,7 +492,7 @@
diff --git a/docs/routes_Views.js.html b/docs/routes_Views.js.html index 78b49f5..926ddd0 100644 --- a/docs/routes_Views.js.html +++ b/docs/routes_Views.js.html @@ -41,7 +41,7 @@ -
routes/Teams.js
diff --git a/docs/routes_Views.js.html b/docs/routes_Views.js.html index 78b49f5..926ddd0 100644 --- a/docs/routes_Views.js.html +++ b/docs/routes_Views.js.html @@ -41,7 +41,7 @@ -
Home
Github Repo
Classes
+Home
Github Repo
Classes
@@ -156,7 +156,7 @@
diff --git a/docs/routes_Webhooks.js.html b/docs/routes_Webhooks.js.html index 3c63132..d293778 100644 --- a/docs/routes_Webhooks.js.html +++ b/docs/routes_Webhooks.js.html @@ -41,7 +41,7 @@ -
routes/Views.js
diff --git a/docs/routes_Webhooks.js.html b/docs/routes_Webhooks.js.html index 3c63132..d293778 100644 --- a/docs/routes_Webhooks.js.html +++ b/docs/routes_Webhooks.js.html @@ -41,7 +41,7 @@ -
Home
Github Repo
Classes
+Home
Github Repo
Classes
@@ -106,7 +106,7 @@