@pipedream/harvest 0.0.5 → 0.1.0

package/README.md

@@ -1,16 +1,11 @@
 # Overview
 
-The Harvest API allows developers to programmatically access data and objects
-in Harvest, a web-based time tracking application. With the API, developers can
-create applications that submit and retrieve time tracking data, as well as
-automate various aspects of the Harvest user experience.
+Harvest is a time tracking and invoicing tool that can streamline the way freelancers and businesses record time for various projects and tasks. By leveraging the Harvest API on Pipedream, you can automate complex workflows that integrate time tracking data with other business tools. Generate reports, sync project data, and manage invoices with minimal manual intervention. Pipedream's serverless platform lets you create these automations using simple, code-driven components, enabling a seamless connection between Harvest and a multitude of other apps.
 
-Some examples of what you can build using the Harvest API include:
+# Example Use Cases
 
-- A time tracking application that automatically submits time tracking data to
-  Harvest on behalf of the user
-- A reporting application that retrieves time tracking data from Harvest and
-  presents it in various charts and graphs
-- An integration with a third-party project management application that pulls
-  in time tracking data from Harvest to provide a more complete picture of
-  project progress
+- **Automated Invoicing Workflow**: Create an automation that triggers at the end of each billing cycle. It compiles timesheet data from Harvest and generates invoices automatically. Then, it sends these invoices to clients via email using a service like SendGrid or directly through accounting software like QuickBooks.
+
+- **Slack Time Tracking Reminders**: Set up a Pipedream workflow that sends reminders to a Slack channel or directly to team members. Reminders prompt users to submit their timesheets if they haven't been completed by a certain time each day or week. The Harvest API checks for unsubmitted timesheets and triggers the Slack notifications accordingly.
+
+- **Project Management Sync**: Build a workflow that synchronizes project and task updates between Harvest and a project management tool such as Trello or Asana. When a new project is created or a task is updated in Harvest, the corresponding card or task in the project management app is created or updated, keeping both systems in sync and up-to-date.

package/actions/create-timesheet-entry/create-timesheet-entry.mjs

@@ -10,20 +10,37 @@ export default {
   description: `Creates a new time entry object. 
   [Create a time entry via duration documentation](https://help.getharvest.com/api-v2/timesheets-api/timesheets/time-entries/#create-a-time-entry-via-duration),
   [Create a time entry via start and end time documentation](https://help.getharvest.com/api-v2/timesheets-api/timesheets/time-entries/#create-a-time-entry-via-start-and-end-time)`,
-  version: "0.0.1",
+  version: "0.0.3",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
   type: "action",
   props: {
     harvest,
+    accountId: {
+      propDefinition: [
+        harvest,
+        "accountId",
+      ],
+    },
     projectId: {
       propDefinition: [
         harvest,
         "projectId",
+        (c) => ({
+          accountId: c.accountId,
+        }),
       ],
     },
     taskId: {
       propDefinition: [
         harvest,
         "taskId",
+        (c) => ({
+          accountId: c.accountId,
+        }),
       ],
     },
     spentDate: {
@@ -35,6 +52,9 @@ export default {
       propDefinition: [
         harvest,
         "userId",
+        (c) => ({
+          accountId: c.accountId,
+        }),
       ],
     },
     specifyStartEndTime: {
@@ -80,12 +100,13 @@ export default {
       task_id: this.taskId,
       user_id: this.userId,
       spent_date: this.spentDate,
-      started_time: this.startedTime.replace(/\s/g, ""),
-      ended_time: this.endedTime.replace(/\s/g, ""),
+      started_time: this.startedTime?.replace(/\s/g, ""),
+      ended_time: this.endedTime?.replace(/\s/g, ""),
     });
     const response = await this.harvest.createTimeEntry({
       $,
       params,
+      accountId: this.accountId,
     });
     response && $.export("$summary", "Successfully created time entry");
     return response;

package/actions/get-projects/get-projects.mjs

@@ -0,0 +1,69 @@
+import harvest from "../../harvest.app.mjs";
+import { ConfigurationError } from "@pipedream/platform";
+
+export default {
+  key: "harvest-get-projects",
+  name: "Get Projects",
+  description: "Retrieve data for a project or projects. [See docs here](https://help.getharvest.com/api-v2/projects-api/projects/projects/#list-all-projects)",
+  version: "0.0.2",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  type: "action",
+  props: {
+    harvest,
+    accountId: {
+      propDefinition: [
+        harvest,
+        "accountId",
+      ],
+    },
+    projectIds: {
+      propDefinition: [
+        harvest,
+        "projectId",
+        (c) => ({
+          accountId: c.accountId,
+        }),
+      ],
+      type: "string[]",
+      description: "Array of project IDs",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const {
+      accountId, projectIds,
+    } = this;
+
+    if (projectIds && !Array.isArray(projectIds)) {
+      throw new ConfigurationError("Project IDs must be an array");
+    }
+
+    const results = [];
+
+    if (projectIds) {
+      for (const projectId of projectIds) {
+        const project = await this.harvest.getProject({
+          $,
+          projectId,
+          accountId,
+        });
+        results.push(project);
+      }
+    } else {
+      const projects = await this.harvest.listProjectsPaginated({
+        page: 1,
+        accountId,
+      });
+      for await (const project of projects) {
+        results.push(project);
+      }
+    }
+
+    results && $.export("$summary", `Successfully retrieved ${results?.length} project(s).`);
+    return results;
+  },
+};

package/actions/list-account-id-options/list-account-id-options.mjs

@@ -0,0 +1,24 @@
+import harvest from "../../harvest.app.mjs";
+
+export default {
+  key: "harvest-list-account-id-options",
+  name: "List Account ID Options",
+  description: "Retrieves available options for the Account ID field.",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    harvest,
+  },
+  async run({ $ }) {
+    const options = await harvest.propDefinitions.accountId.options.call(this.harvest);
+    $.export("$summary", `Successfully retrieved ${options.length} option${options.length === 1
+      ? ""
+      : "s"}`);
+    return options;
+  },
+};

package/actions/start-timer/start-timer.mjs

@@ -4,16 +4,28 @@ export default {
   key: "harvest-start-timer",
   name: "Start Time Entry",
   description: "Restart a stopped timer entry. [See docs here](https://help.getharvest.com/api-v2/timesheets-api/timesheets/time-entries/#restart-a-stopped-time-entry)",
-  version: "0.0.1",
+  version: "0.0.3",
+  annotations: {
+    destructiveHint: true,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
   type: "action",
   props: {
     harvest,
+    accountId: {
+      propDefinition: [
+        harvest,
+        "accountId",
+      ],
+    },
     timeEntryId: {
       propDefinition: [
         harvest,
         "timeEntryId",
-        () => ({
+        (c) => ({
           isRunning: false,
+          accountId: c.accountId,
         }),
       ],
     },
@@ -22,6 +34,7 @@ export default {
     const response = await this.harvest.restartTimeEntry({
       $,
       id: this.timeEntryId,
+      accountId: this.accountId,
     });
     response && $.export("$summary", "Successfully started the time entry");
     return response;

package/actions/stop-timer/stop-timer.mjs

@@ -4,16 +4,28 @@ export default {
   key: "harvest-stop-timer",
   name: "Stop Time Entry",
   description: "Stop a timer entry. [See docs here](https://help.getharvest.com/api-v2/timesheets-api/timesheets/time-entries/#stop-a-running-time-entry)",
-  version: "0.0.2",
+  version: "0.0.4",
+  annotations: {
+    destructiveHint: true,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
   type: "action",
   props: {
     harvest,
+    accountId: {
+      propDefinition: [
+        harvest,
+        "accountId",
+      ],
+    },
     timeEntryId: {
       propDefinition: [
         harvest,
         "timeEntryId",
-        () => ({
+        (c) => ({
           isRunning: true,
+          accountId: c.accountId,
         }),
       ],
     },
@@ -22,6 +34,7 @@ export default {
     const response = await this.harvest.stopTimeEntry({
       $,
       id: this.timeEntryId,
+      accountId: this.accountId,
     });
     response && $.export("$summary", "Successfully ended the time entry");
     return response;

package/harvest.app.mjs

@@ -13,10 +13,13 @@ export default {
       label: "Project ID",
       description: "The ID of the project to associate with the time entry",
       useQuery: true,
-      async options({ page }) {
+      async options({
+        page, accountId,
+      }) {
         const response = await this.listProjects({
           perPage: constants.PAGE_SIZE,
           page: page + 1,
+          accountId,
         });
         return response.projects.map((project) => ({
           label: project.name,
@@ -29,10 +32,13 @@ export default {
       label: "Task ID",
       description: "The ID of the task to associate with the time entry",
       useQuery: true,
-      async options({ page }) {
+      async options({
+        page, accountId,
+      }) {
         const response = await this.listTasks({
           perPage: constants.PAGE_SIZE,
           page: page + 1,
+          accountId,
         });
         return response.tasks.map((task) => ({
           label: task.name,
@@ -46,10 +52,13 @@ export default {
       description: "The ID of the user to associate with the time entry",
       useQuery: true,
       optional: true,
-      async options({ page }) {
+      async options({
+        page, accountId,
+      }) {
         const response = await this.listUsers({
           perPage: constants.PAGE_SIZE,
           page: page + 1,
+          accountId,
         });
         return response.users.map((user) => ({
           label: `${user.first_name} ${user.last_name}`,
@@ -63,10 +72,13 @@ export default {
       description: "The ID of the client to associate with time entries",
       useQuery: true,
       optional: true,
-      async options({ page }) {
+      async options({
+        page, accountId,
+      }) {
         const response = await this.listClients({
           perPage: constants.PAGE_SIZE,
           page: page + 1,
+          accountId,
         });
         return response.clients.map((client) => ({
           label: client.name,
@@ -80,12 +92,13 @@ export default {
       description: "The ID of the time entry.",
       useQuery: true,
       async options({
-        page, isRunning,
+        page, isRunning, accountId,
       }) {
         const response = await this.listTimeEntries({
           perPage: constants.PAGE_SIZE,
           page: page + 1,
           is_running: isRunning,
+          accountId,
         });
         return response.time_entries.map((entry) => ({
           label: `Project: ${entry.project.name}, Task: ${entry.task.name}, Spend date: ${entry.spent_date} ${entry.started_time || ""} ${entry.ended_time
@@ -95,6 +108,20 @@ export default {
         }));
       },
     },
+    accountId: {
+      type: "string",
+      label: "Account ID",
+      description: "The ID of your account",
+      async options() {
+        const { accounts } = await this.listAccounts({});
+        return accounts.map(({
+          id, name,
+        }) => ({
+          label: name,
+          value: id,
+        }));
+      },
+    },
   },
   methods: {
     setLastDateChecked(db, value) {
@@ -103,11 +130,16 @@ export default {
     getLastDateChecked(db) {
       return db && db.get(constants.DB_LAST_DATE_CHECK);
     },
-    _getHeaders() {
+    _getAuthorizationHeader() {
       return {
-        "Content-Type": "application/json",
         "Authorization": `Bearer ${this.$auth.oauth_access_token}`,
-        "Harvest-Account-Id": this.$auth.account_id,
+      };
+    },
+    _getHeaders(accountId) {
+      return {
+        "Content-Type": "application/json",
+        "Harvest-Account-Id": accountId,
+        ...this._getAuthorizationHeader(),
       };
     },
     _getUrl(path) {
@@ -125,16 +157,23 @@ export default {
         path,
         params,
         data,
+        accountId,
       } = args;
       const config = {
         method,
         url: this._getUrl(path),
-        headers: this._getHeaders(),
+        headers: this._getHeaders(accountId),
         params,
         data,
       };
       return axios($ ?? this, config);
     },
+    async listAccounts({ $ = this }) {
+      return axios($, {
+        url: "https://id.getharvest.com/api/v2/accounts",
+        headers: this._getAuthorizationHeader(),
+      });
+    },
     _isRetriableStatusCode(statusCode) {
       constants.retriableStatusCodes.includes(statusCode);
     },
@@ -161,7 +200,7 @@ export default {
       }, retryOpts);
     },
     async *listTimeEntriesPaginated({
-      page, updatedSince,
+      page, updatedSince, accountId,
     }) {
       do {
         const response = await this._withRetries(
@@ -169,6 +208,7 @@ export default {
             per_page: constants.PAGE_SIZE,
             page,
             updated_since: updatedSince,
+            accountId,
           }),
         );
 
@@ -185,7 +225,7 @@ export default {
       } while (true);
     },
     async *listInvoicesPaginated({
-      page, updatedSince,
+      page, updatedSince, accountId,
     }) {
       do {
         const response = await this._withRetries(
@@ -193,6 +233,7 @@ export default {
             per_page: constants.PAGE_SIZE,
             page,
             updated_since: updatedSince,
+            accountId,
           }),
         );
 
@@ -208,8 +249,42 @@ export default {
         page += 1;
       } while (true);
     },
+    async *listProjectsPaginated({
+      page, $, accountId,
+    }) {
+      do {
+        const response = await this._withRetries(
+          () => this.listProjects({
+            accountId,
+            per_page: constants.PAGE_SIZE,
+            page,
+            $,
+          }),
+        );
+
+        if (response.projects.length === 0) {
+          return;
+        }
+        for (const project of response.projects) {
+          yield project;
+        }
+        if (!response.next_page) {
+          return;
+        }
+        page += 1;
+      } while (true);
+    },
+    async getProject({
+      $, projectId, accountId,
+    }) {
+      return this._makeRequest({
+        $,
+        path: `/projects/${projectId}`,
+        accountId,
+      });
+    },
     async listProjects({
-      $, perPage, page,
+      $, perPage, page, accountId,
     }) {
       return this._makeRequest({
         $,
@@ -218,10 +293,11 @@ export default {
           per_page: perPage,
           page,
         },
+        accountId,
       });
     },
     async listTasks({
-      $, perPage, page,
+      $, perPage, page, accountId,
     }) {
       return this._makeRequest({
         $,
@@ -230,10 +306,11 @@ export default {
           per_page: perPage,
           page,
         },
+        accountId,
       });
     },
     async listUsers({
-      $, perPage, page,
+      $, perPage, page, accountId,
     }) {
       return this._makeRequest({
         $,
@@ -242,10 +319,11 @@ export default {
           per_page: perPage,
           page,
         },
+        accountId,
       });
     },
     async listClients({
-      $, perPage, page,
+      $, perPage, page, accountId,
     }) {
       return this._makeRequest({
         $,
@@ -254,52 +332,58 @@ export default {
           per_page: perPage,
           page,
         },
+        accountId,
       });
     },
     async createTimeEntry({
-      $, params,
+      $, params, accountId,
     }) {
       return this._makeRequest({
         $,
         path: "/time_entries",
         params,
         method: "post",
+        accountId,
       });
     },
     async listTimeEntries({
-      $, ...params
+      $, accountId, ...params
     }) {
 
       return this._makeRequest({
         $,
         path: "/time_entries",
+        accountId,
         params,
       });
     },
     async restartTimeEntry({
-      $, id,
+      $, id, accountId,
     }) {
       return this._makeRequest({
         $,
         path: `/time_entries/${id}/restart`,
         method: "patch",
+        accountId,
       });
     },
     async stopTimeEntry({
-      $, id,
+      $, id, accountId,
     }) {
       return this._makeRequest({
         $,
         path: `/time_entries/${id}/stop`,
         method: "patch",
+        accountId,
       });
     },
     async listInvoices({
-      $, ...params
+      $, accountId, ...params
     }) {
       return this._makeRequest({
         $,
         path: "/invoices",
+        accountId,
         params,
       });
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/harvest",
-  "version": "0.0.5",
+  "version": "0.1.0",
   "description": "Pipedream Harvest Components",
   "main": "harvest.app.mjs",
   "keywords": [
@@ -13,8 +13,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@pipedream/platform": "^1.2.0",
+    "@pipedream/platform": "^1.6.8",
     "async-retry": "^1.3.3",
-    "moment": "^2.29.3"
+    "moment": "^2.29.4"
   }
 }

package/sources/new-invoice-entry/new-invoice-entry.mjs

@@ -5,7 +5,7 @@ export default {
   key: "harvest-new-invoice-entry",
   name: "New Invoice Entry",
   description: "Emit new notifications when a new invoice is created",
-  version: "0.0.3",
+  version: "0.0.4",
   type: "source",
   props: {
     harvest,
@@ -18,6 +18,12 @@ export default {
       },
     },
     db: "$.service.db",
+    accountId: {
+      propDefinition: [
+        harvest,
+        "accountId",
+      ],
+    },
   },
   dedupe: "unique",
   async run() {
@@ -30,6 +36,7 @@ export default {
     const invoices = await this.harvest.listInvoicesPaginated({
       page: 1,
       updatedSince: lastDateChecked,
+      accountId: this.accountId,
     });
     for await (const invoice of invoices) {
       data.push(invoice);

package/sources/new-timesheet-entry/new-timesheet-entry.mjs

@@ -5,7 +5,7 @@ export default {
   key: "harvest-new-timesheet-entry",
   name: "New Timesheet Entry",
   description: "Emit new notifications when a new timesheet entry is created",
-  version: "0.0.3",
+  version: "0.0.4",
   type: "source",
   props: {
     harvest,
@@ -18,6 +18,12 @@ export default {
       },
     },
     db: "$.service.db",
+    accountId: {
+      propDefinition: [
+        harvest,
+        "accountId",
+      ],
+    },
   },
   dedupe: "unique",
   async run() {
@@ -30,6 +36,7 @@ export default {
     const entries = await this.harvest.listTimeEntriesPaginated({
       page: 1,
       updatedSince: lastDateChecked,
+      accountId: this.accountId,
     });
     for await (const entry of entries) {
       data.push(entry);