@openfn/language-asana 4.0.12 → 4.1.0

package/ast.json

@@ -17,7 +17,8 @@
           },
           {
             "title": "example",
-            "description": "getTask(\"1206933955023739\", {\n  opt_fields: \"name,notes,assignee\",\n});"
+            "description": "getTask(\"1206933955023739\", {\n  opt_fields: \"name,notes,assignee\",\n});",
+            "caption": "Get a task"
           },
           {
             "title": "function",
@@ -42,6 +43,15 @@
             },
             "name": "params"
           },
+          {
+            "title": "param",
+            "description": "The fields to return.",
+            "type": {
+              "type": "NameExpression",
+              "name": "string"
+            },
+            "name": "params.opt_fields"
+          },
           {
             "title": "param",
             "description": "(Optional) callback function",
@@ -61,7 +71,7 @@
           }
         ]
       },
-      "valid": true
+      "valid": false
     },
     {
       "name": "getTasks",
@@ -80,7 +90,13 @@
           },
           {
             "title": "example",
-            "description": "getTasks(\"1206933955023739\", {\n  opt_fields: \"name,notes,assignee\",\n});"
+            "description": "getTasks(\"1206933955023739\", {\n  opt_fields: \"name,notes,assignee\",\n});",
+            "caption": "Get all tasks"
+          },
+          {
+            "title": "example",
+            "description": "getTasks(\"1206933955023739\", {\n  opt_fields: \"name,notes,assignee\",\n  limit: 100,\n});",
+            "caption": "Limit the number of tasks returned"
           },
           {
             "title": "function",
@@ -105,6 +121,24 @@
             },
             "name": "params"
           },
+          {
+            "title": "param",
+            "description": "The maximum number of tasks to return.",
+            "type": {
+              "type": "NameExpression",
+              "name": "number"
+            },
+            "name": "params.limit"
+          },
+          {
+            "title": "param",
+            "description": "The fields to return.",
+            "type": {
+              "type": "NameExpression",
+              "name": "string"
+            },
+            "name": "params.opt_fields"
+          },
           {
             "title": "param",
             "description": "(Optional) callback function",
@@ -124,13 +158,13 @@
           }
         ]
       },
-      "valid": true
+      "valid": false
     },
     {
       "name": "updateTask",
       "params": [
         "taskGid",
-        "params",
+        "data",
         "callback"
       ],
       "docs": {
@@ -143,7 +177,8 @@
           },
           {
             "title": "example",
-            "description": "updateTask(\"1206933955023739\", {\n  name: \"test\",\n  approval_status: \"pending\",\n  assignee: \"12345\",\n});"
+            "description": "updateTask(\"1206933955023739\", {\n  name: \"test\",\n  approval_status: \"pending\",\n  assignee: \"12345\",\n});",
+            "caption": "Update a task"
           },
           {
             "title": "function",
@@ -161,12 +196,12 @@
           },
           {
             "title": "param",
-            "description": "Body parameters",
+            "description": "Body data to update the task with",
             "type": {
               "type": "NameExpression",
               "name": "object"
             },
-            "name": "params"
+            "name": "data"
           },
           {
             "title": "param",
@@ -259,7 +294,8 @@
           },
           {
             "title": "example",
-            "description": "upsertTask(\"1201382240880\", {\n  externalId: \"name\",\n  data: {\n    name: \"test\",\n    approval_status: \"pending\",\n    projects: [\"1201382240880\"],\n    assignee: \"12345\",\n  },\n});"
+            "description": "upsertTask(\"1201382240880\", {\n  externalId: \"name\",\n  data: {\n    name: \"test\",\n    approval_status: \"pending\",\n    projects: [\"1201382240880\"],\n    assignee: \"12345\",\n  },\n});",
+            "caption": "Upsert a task"
           },
           {
             "title": "function",
@@ -284,6 +320,24 @@
             },
             "name": "params"
           },
+          {
+            "title": "param",
+            "description": "The external id field name",
+            "type": {
+              "type": "NameExpression",
+              "name": "string"
+            },
+            "name": "params.externalId"
+          },
+          {
+            "title": "param",
+            "description": "The data to upsert.",
+            "type": {
+              "type": "NameExpression",
+              "name": "object"
+            },
+            "name": "params.data"
+          },
           {
             "title": "param",
             "description": "(Optional) callback function",
@@ -303,7 +357,7 @@
           }
         ]
       },
-      "valid": true
+      "valid": false
     },
     {
       "name": "createTaskStory",

package/configuration-schema.json

@@ -7,7 +7,8 @@
       "description": "The API version",
       "examples": [
         "1.0"
-      ]
+      ],
+      "default": "1.0"
     },
     "token": {
       "title": "Token",
@@ -20,5 +21,7 @@
   },
   "type": "object",
   "additionalProperties": true,
-  "required": ["apiVersion", "token"]
-}
+  "required": [
+    "token"
+  ]
+}

package/dist/index.cjs

@@ -74,34 +74,33 @@ __export(Adaptor_exports, {
 var import_language_common2 = require("@openfn/language-common");
 var import_util2 = require("@openfn/language-common/util");
 
-// src/Utils.js
-var import_language_common = require("@openfn/language-common");
+// src/util.js
 var import_util = require("@openfn/language-common/util");
-function addAuth(headers, configuration = {}) {
-  const { token } = configuration;
+var import_node_path = require("path");
+var import_language_common = require("@openfn/language-common");
+var baseUrl = "https://app.asana.com";
+function addAuth(headers, token) {
   if (token) {
     Object.assign(headers, { Authorization: `Bearer ${token}` });
   }
 }
-function request(state, path, params, callback = (s) => s) {
-  var _a;
-  let { body, headers = {}, method = "GET", ...rest } = params;
-  const baseUrl = `https://app.asana.com/api/${(_a = state.configuration) == null ? void 0 : _a.apiVersion}`;
-  addAuth(headers, state.configuration);
+function request(state, path, params = {}, callback = (s) => s) {
+  (0, import_util.assertRelativeUrl)(path);
+  const { token, apiVersion = "1.0" } = state.configuration ?? {};
+  const currentPath = (0, import_node_path.join)("/api", apiVersion, path);
+  const {
+    method = "GET",
+    headers = { accept: "application/json" },
+    ...rest
+  } = params;
+  addAuth(headers, token);
   const options = {
     ...rest,
     headers,
     baseUrl,
-    body
+    parseAs: "json"
   };
-  return (0, import_util.request)(method, path, options).then((response) => {
-    (0, import_util.logResponse)(response);
-    const { body: body2, ...responseWithoutBody } = response;
-    return {
-      ...(0, import_language_common.composeNextState)(state, body2 == null ? void 0 : body2.data),
-      response: responseWithoutBody
-    };
-  }).then(callback).catch((err) => {
+  return (0, import_util.request)(method, currentPath, options).then(import_util.logResponse).then(callback).catch((err) => {
     if (err.code !== "BASE_URL_MISMATCH") {
       console.log("Asana says:");
       (0, import_util.logResponse)(err);
@@ -109,6 +108,41 @@ function request(state, path, params, callback = (s) => s) {
     throw err;
   });
 }
+var DEFAULT_PAGE_LIMIT = 100;
+async function requestWithPagination(state, path, params = {}) {
+  var _a, _b;
+  let { body, headers, query = {}, ...rest } = params;
+  const { limit, ...restQuery } = query;
+  const options = {
+    ...rest,
+    headers,
+    body,
+    query: { limit: limit ?? DEFAULT_PAGE_LIMIT, ...restQuery }
+  };
+  const results = [];
+  const didUserPassLimit = Boolean(limit);
+  let shouldFetchNextPage = false;
+  let currentPath = path;
+  do {
+    const response = await request(state, currentPath, options);
+    results.push(...(_a = response == null ? void 0 : response.body) == null ? void 0 : _a.data);
+    const nextPage = (_b = response == null ? void 0 : response.body) == null ? void 0 : _b.next_page;
+    const hasNextPage = (nextPage == null ? void 0 : nextPage.path) && (nextPage == null ? void 0 : nextPage.offset) !== void 0;
+    shouldFetchNextPage = !didUserPassLimit && hasNextPage;
+    if (shouldFetchNextPage) {
+      currentPath = nextPage.path;
+    }
+  } while (shouldFetchNextPage);
+  return results;
+}
+function prepareNextState(state, response) {
+  const { body, ...responseWithoutBody } = response;
+  const { data, next_page } = body ?? {};
+  return {
+    ...(0, import_language_common.composeNextState)(state, data),
+    response: { next_page, ...responseWithoutBody }
+  };
+}
 
 // src/Adaptor.js
 var import_language_common3 = require("@openfn/language-common");
@@ -125,59 +159,64 @@ function execute(...operations) {
   };
 }
 function getTask(taskGid, params, callback) {
-  return (state) => {
+  return async (state) => {
     const [resolvedTaskGid, resolvedParams] = (0, import_util2.expandReferences)(
       state,
       taskGid,
       params
     );
-    return request(
+    const response = await request(
       state,
       `tasks/${resolvedTaskGid}`,
       { query: resolvedParams },
       callback
     );
+    return prepareNextState(state, response);
   };
 }
 function getTasks(projectGid, params, callback) {
-  return (state) => {
+  return async (state) => {
     const [resolvedProjectGid, resolvedParams] = (0, import_util2.expandReferences)(
       state,
       projectGid,
       params
     );
-    return request(
+    const results = await requestWithPagination(
       state,
       `projects/${resolvedProjectGid}/tasks`,
       { query: resolvedParams },
       callback
     );
+    console.log(`Fetched ${results.length} tasks`);
+    return (0, import_language_common2.composeNextState)(state, results);
   };
 }
-function updateTask(taskGid, params, callback) {
-  return (state) => {
-    const [resolvedTaskGid, resolvedParams] = (0, import_util2.expandReferences)(
+function updateTask(taskGid, data, callback) {
+  return async (state) => {
+    const [resolvedTaskGid, resolvedData] = (0, import_util2.expandReferences)(
       state,
       taskGid,
-      params
+      data
     );
-    return request(
+    const response = await request(
       state,
       `tasks/${resolvedTaskGid}`,
-      { body: { data: resolvedParams }, method: "PUT" },
+      { body: { data: resolvedData }, method: "PUT" },
       callback
     );
+    return prepareNextState(state, response);
   };
 }
 function createTask(params, callback) {
-  return (state) => {
+  return async (state) => {
     const [resolvedParams] = (0, import_util2.expandReferences)(state, params);
-    return request(
+    const response = await request(
       state,
       "tasks",
       { body: { data: resolvedParams }, method: "POST" },
       callback
     );
+    return prepareNextState(state, response);
   };
 }
 function upsertTask(projectGid, params, callback) {
@@ -187,29 +226,26 @@ function upsertTask(projectGid, params, callback) {
       projectGid,
       params
     );
-    return request(
-      state,
-      `projects/${resolvedProjectGid}/tasks`,
-      { query: { opt_fields: `${externalId}` } },
-      (next) => {
-        const matchingTask = next.data.find(
-          (task) => task[externalId] === data[externalId]
-        );
-        if (matchingTask) {
-          console.log("Matching task found. Performing update.");
-          console.log("Data to update", data);
-          const { projects, workspace, ...remainingData } = data;
-          return updateTask(matchingTask.gid, remainingData, callback)(state);
-        } else {
-          console.log("No matching task found. Performing create.");
-          return createTask(data, callback)(state);
-        }
+    return requestWithPagination(state, `projects/${resolvedProjectGid}/tasks`, {
+      query: { opt_fields: `${externalId}` }
+    }).then((next) => {
+      const matchingTask = next.find(
+        (task) => task[externalId] === data[externalId]
+      );
+      if (matchingTask) {
+        console.log("Matching task found. Performing update.");
+        console.log("Data to update", data);
+        const { projects, workspace, ...remainingData } = data;
+        return updateTask(matchingTask.gid, remainingData, callback)(state);
+      } else {
+        console.log("No matching task found. Performing create.");
+        return createTask(data, callback)(state);
       }
-    );
+    });
   };
 }
 function createTaskStory(taskGid, params, callback) {
-  return (state) => {
+  return async (state) => {
     const [
       resolvedTaskGid,
       {
@@ -222,7 +258,7 @@ function createTaskStory(taskGid, params, callback) {
       }
     ] = (0, import_util2.expandReferences)(state, taskGid, params);
     const story = { text, html_text, is_pinned, sticker_name };
-    return request(
+    const response = await request(
       state,
       `tasks/${resolvedTaskGid}/stories`,
       {
@@ -232,22 +268,24 @@ function createTaskStory(taskGid, params, callback) {
       },
       callback
     );
+    return prepareNextState(state, response);
   };
 }
 function request2(path, params = {}, callback) {
-  return (state) => {
+  return async (state) => {
     const [resolvedPath, resolvedParams] = (0, import_util2.expandReferences)(
       state,
       path,
       params
     );
-    const { body = {}, query = {}, method = "GET" } = resolvedParams;
-    return request(
+    const { body, query, method } = resolvedParams;
+    const response = await request(
       state,
       resolvedPath,
       { method, body, query },
       callback
     );
+    return prepareNextState(state, response);
   };
 }
 

package/dist/index.js

@@ -30,40 +30,43 @@ __export(Adaptor_exports, {
   updateTask: () => updateTask,
   upsertTask: () => upsertTask
 });
-import { execute as commonExecute } from "@openfn/language-common";
+import {
+  execute as commonExecute,
+  composeNextState as composeNextState2
+} from "@openfn/language-common";
 import { expandReferences } from "@openfn/language-common/util";
 
-// src/Utils.js
-import { composeNextState } from "@openfn/language-common";
+// src/util.js
 import {
   request as commonRequest,
-  logResponse
+  logResponse,
+  assertRelativeUrl
 } from "@openfn/language-common/util";
-function addAuth(headers, configuration = {}) {
-  const { token } = configuration;
+import { join } from "path";
+import { composeNextState } from "@openfn/language-common";
+var baseUrl = "https://app.asana.com";
+function addAuth(headers, token) {
   if (token) {
     Object.assign(headers, { Authorization: `Bearer ${token}` });
   }
 }
-function request(state, path, params, callback = (s) => s) {
-  var _a;
-  let { body, headers = {}, method = "GET", ...rest } = params;
-  const baseUrl = `https://app.asana.com/api/${(_a = state.configuration) == null ? void 0 : _a.apiVersion}`;
-  addAuth(headers, state.configuration);
+function request(state, path, params = {}, callback = (s) => s) {
+  assertRelativeUrl(path);
+  const { token, apiVersion = "1.0" } = state.configuration ?? {};
+  const currentPath = join("/api", apiVersion, path);
+  const {
+    method = "GET",
+    headers = { accept: "application/json" },
+    ...rest
+  } = params;
+  addAuth(headers, token);
   const options = {
     ...rest,
     headers,
     baseUrl,
-    body
+    parseAs: "json"
   };
-  return commonRequest(method, path, options).then((response) => {
-    logResponse(response);
-    const { body: body2, ...responseWithoutBody } = response;
-    return {
-      ...composeNextState(state, body2 == null ? void 0 : body2.data),
-      response: responseWithoutBody
-    };
-  }).then(callback).catch((err) => {
+  return commonRequest(method, currentPath, options).then(logResponse).then(callback).catch((err) => {
     if (err.code !== "BASE_URL_MISMATCH") {
       console.log("Asana says:");
       logResponse(err);
@@ -71,6 +74,41 @@ function request(state, path, params, callback = (s) => s) {
     throw err;
   });
 }
+var DEFAULT_PAGE_LIMIT = 100;
+async function requestWithPagination(state, path, params = {}) {
+  var _a, _b;
+  let { body, headers, query = {}, ...rest } = params;
+  const { limit, ...restQuery } = query;
+  const options = {
+    ...rest,
+    headers,
+    body,
+    query: { limit: limit ?? DEFAULT_PAGE_LIMIT, ...restQuery }
+  };
+  const results = [];
+  const didUserPassLimit = Boolean(limit);
+  let shouldFetchNextPage = false;
+  let currentPath = path;
+  do {
+    const response = await request(state, currentPath, options);
+    results.push(...(_a = response == null ? void 0 : response.body) == null ? void 0 : _a.data);
+    const nextPage = (_b = response == null ? void 0 : response.body) == null ? void 0 : _b.next_page;
+    const hasNextPage = (nextPage == null ? void 0 : nextPage.path) && (nextPage == null ? void 0 : nextPage.offset) !== void 0;
+    shouldFetchNextPage = !didUserPassLimit && hasNextPage;
+    if (shouldFetchNextPage) {
+      currentPath = nextPage.path;
+    }
+  } while (shouldFetchNextPage);
+  return results;
+}
+function prepareNextState(state, response) {
+  const { body, ...responseWithoutBody } = response;
+  const { data, next_page } = body ?? {};
+  return {
+    ...composeNextState(state, data),
+    response: { next_page, ...responseWithoutBody }
+  };
+}
 
 // src/Adaptor.js
 import {
@@ -102,59 +140,64 @@ function execute(...operations) {
   };
 }
 function getTask(taskGid, params, callback) {
-  return (state) => {
+  return async (state) => {
     const [resolvedTaskGid, resolvedParams] = expandReferences(
       state,
       taskGid,
       params
     );
-    return request(
+    const response = await request(
       state,
       `tasks/${resolvedTaskGid}`,
       { query: resolvedParams },
       callback
     );
+    return prepareNextState(state, response);
   };
 }
 function getTasks(projectGid, params, callback) {
-  return (state) => {
+  return async (state) => {
     const [resolvedProjectGid, resolvedParams] = expandReferences(
       state,
       projectGid,
       params
     );
-    return request(
+    const results = await requestWithPagination(
       state,
       `projects/${resolvedProjectGid}/tasks`,
       { query: resolvedParams },
       callback
     );
+    console.log(`Fetched ${results.length} tasks`);
+    return composeNextState2(state, results);
   };
 }
-function updateTask(taskGid, params, callback) {
-  return (state) => {
-    const [resolvedTaskGid, resolvedParams] = expandReferences(
+function updateTask(taskGid, data, callback) {
+  return async (state) => {
+    const [resolvedTaskGid, resolvedData] = expandReferences(
       state,
       taskGid,
-      params
+      data
     );
-    return request(
+    const response = await request(
       state,
       `tasks/${resolvedTaskGid}`,
-      { body: { data: resolvedParams }, method: "PUT" },
+      { body: { data: resolvedData }, method: "PUT" },
       callback
     );
+    return prepareNextState(state, response);
   };
 }
 function createTask(params, callback) {
-  return (state) => {
+  return async (state) => {
     const [resolvedParams] = expandReferences(state, params);
-    return request(
+    const response = await request(
       state,
       "tasks",
       { body: { data: resolvedParams }, method: "POST" },
       callback
     );
+    return prepareNextState(state, response);
   };
 }
 function upsertTask(projectGid, params, callback) {
@@ -164,29 +207,26 @@ function upsertTask(projectGid, params, callback) {
       projectGid,
       params
     );
-    return request(
-      state,
-      `projects/${resolvedProjectGid}/tasks`,
-      { query: { opt_fields: `${externalId}` } },
-      (next) => {
-        const matchingTask = next.data.find(
-          (task) => task[externalId] === data[externalId]
-        );
-        if (matchingTask) {
-          console.log("Matching task found. Performing update.");
-          console.log("Data to update", data);
-          const { projects, workspace, ...remainingData } = data;
-          return updateTask(matchingTask.gid, remainingData, callback)(state);
-        } else {
-          console.log("No matching task found. Performing create.");
-          return createTask(data, callback)(state);
-        }
+    return requestWithPagination(state, `projects/${resolvedProjectGid}/tasks`, {
+      query: { opt_fields: `${externalId}` }
+    }).then((next) => {
+      const matchingTask = next.find(
+        (task) => task[externalId] === data[externalId]
+      );
+      if (matchingTask) {
+        console.log("Matching task found. Performing update.");
+        console.log("Data to update", data);
+        const { projects, workspace, ...remainingData } = data;
+        return updateTask(matchingTask.gid, remainingData, callback)(state);
+      } else {
+        console.log("No matching task found. Performing create.");
+        return createTask(data, callback)(state);
       }
-    );
+    });
   };
 }
 function createTaskStory(taskGid, params, callback) {
-  return (state) => {
+  return async (state) => {
     const [
       resolvedTaskGid,
       {
@@ -199,7 +239,7 @@ function createTaskStory(taskGid, params, callback) {
       }
     ] = expandReferences(state, taskGid, params);
     const story = { text, html_text, is_pinned, sticker_name };
-    return request(
+    const response = await request(
       state,
       `tasks/${resolvedTaskGid}/stories`,
       {
@@ -209,22 +249,24 @@ function createTaskStory(taskGid, params, callback) {
       },
       callback
     );
+    return prepareNextState(state, response);
   };
 }
 function request2(path, params = {}, callback) {
-  return (state) => {
+  return async (state) => {
     const [resolvedPath, resolvedParams] = expandReferences(
       state,
       path,
       params
     );
-    const { body = {}, query = {}, method = "GET" } = resolvedParams;
-    return request(
+    const { body, query, method } = resolvedParams;
+    const response = await request(
       state,
       resolvedPath,
       { method, body, query },
       callback
     );
+    return prepareNextState(state, response);
   };
 }
 

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@openfn/language-asana",
-  "version": "4.0.12",
+  "version": "4.1.0",
+  "label": "Asana",
   "description": "An adaptor to access objects in Asana",
   "homepage": "https://docs.openfn.org",
   "repository": {
@@ -28,10 +29,8 @@
   },
   "devDependencies": {
     "assertion-error": "2.0.0",
-    "chai": "4.3.6",
+    "chai": "^5.2.0",
     "deep-eql": "4.1.1",
-    "esno": "^0.16.3",
-    "nock": "13.2.9",
     "rimraf": "3.0.2"
   },
   "type": "module",
@@ -39,8 +38,9 @@
   "main": "dist/index.cjs",
   "scripts": {
     "build": "pnpm clean && build-adaptor asana",
-    "test": "mocha --experimental-specifier-resolution=node --no-warnings",
-    "test:watch": "mocha -w --experimental-specifier-resolution=node --no-warnings",
+    "test": "mocha --experimental-specifier-resolution=node --no-warnings --exclude test/integration.js --recursive",
+    "test:watch": "mocha -w --experimental-specifier-resolution=node --no-warnings --exclude test/integration.js --recursive",
+    "test:integration": "mocha --experimental-specifier-resolution=node --no-warnings test/integration.js",
     "clean": "rimraf dist types docs",
     "pack": "pnpm pack --pack-destination ../../dist",
     "lint": "eslint src"

package/types/Adaptor.d.ts

@@ -14,35 +14,48 @@ export function execute(...operations: Operations): Operation;
 /**
  * Get a single task of a given project.
  * @public
- * @example
+ * @example <caption>Get a task</caption>
  * getTask("1206933955023739", {
  *   opt_fields: "name,notes,assignee",
  * });
  * @function
  * @param {string} taskGid - Globally unique identifier for the task
  * @param {object} params - Query params to include.
+ * @param {string} params.opt_fields - The fields to return.
  * @param {function} callback - (Optional) callback function
  * @returns {Operation}
  */
-export function getTask(taskGid: string, params: object, callback: Function): Operation;
+export function getTask(taskGid: string, params: {
+    opt_fields: string;
+}, callback: Function): Operation;
 /**
  * Get the list of tasks for a given project.
  * @public
- * @example
+ * @example <caption>Get all tasks</caption>
+ * getTasks("1206933955023739", {
+ *   opt_fields: "name,notes,assignee",
+ * });
+ * @example <caption>Limit the number of tasks returned</caption>
  * getTasks("1206933955023739", {
  *   opt_fields: "name,notes,assignee",
+ *   limit: 100,
  * });
  * @function
  * @param {string} projectGid - Globally unique identifier for the project
  * @param {object} params - Query params to include.
+ * @param {number} params.limit - The maximum number of tasks to return.
+ * @param {string} params.opt_fields - The fields to return.
  * @param {function} callback - (Optional) callback function
  * @returns {Operation}
  */
-export function getTasks(projectGid: string, params: object, callback: Function): Operation;
+export function getTasks(projectGid: string, params: {
+    limit: number;
+    opt_fields: string;
+}, callback: Function): Operation;
 /**
  * Update a specific task.
  * @public
- * @example
+ * @example <caption>Update a task</caption>
  * updateTask("1206933955023739", {
  *   name: "test",
  *   approval_status: "pending",
@@ -50,11 +63,11 @@ export function getTasks(projectGid: string, params: object, callback: Function)
  * });
  * @function
  * @param {string} taskGid - Globally unique identifier for the task
- * @param {object} params - Body parameters
+ * @param {object} data - Body data to update the task with
  * @param {function} callback - (Optional) callback function
  * @returns {Operation}
  */
-export function updateTask(taskGid: string, params: object, callback: Function): Operation;
+export function updateTask(taskGid: string, data: object, callback: Function): Operation;
 /**
  * Create a task.
  * @public
@@ -74,7 +87,7 @@ export function createTask(params: object, callback: Function): Operation;
 /**
  * Update or create a task.
  * @public
- * @example
+ * @example <caption>Upsert a task</caption>
  * upsertTask("1201382240880", {
  *   externalId: "name",
  *   data: {
@@ -87,10 +100,15 @@ export function createTask(params: object, callback: Function): Operation;
  * @function
  * @param {string} projectGid - Globally unique identifier for the project
  * @param {object} params - an object with an externalId and some task data.
+ * @param {string} params.externalId - The external id field name
+ * @param {object} params.data - The data to upsert.
  * @param {function} callback - (Optional) callback function
  * @returns {Operation}
  */
-export function upsertTask(projectGid: string, params: object, callback: Function): Operation;
+export function upsertTask(projectGid: string, params: {
+    externalId: string;
+    data: object;
+}, callback: Function): Operation;
 /**
  * Options provided to the createTaskStory request
  * @typedef {Object} StoryOptions

package/types/util.d.ts

@@ -0,0 +1,5 @@
+export function addAuth(headers: any, token: any): void;
+export function request(state: any, path: any, params?: {}, callback?: (s: any) => any): any;
+export function requestWithPagination(state: any, path: any, params?: {}): Promise<any[]>;
+export function prepareNextState(state: any, response: any): any;
+export const DEFAULT_PAGE_LIMIT: 100;

package/types/Utils.d.ts

@@ -1,2 +0,0 @@
-export function addAuth(headers: any, configuration?: {}): void;
-export function request(state: any, path: any, params: any, callback?: (s: any) => any): any;