@pipedream/toggl 0.0.5 → 0.1.0

package/README.md

@@ -1,29 +1,11 @@
 # Overview
 
-The Toggl Track API allows developers to build apps that help measure and
-visualize employee productivity. Using the API, it is possible to build tools
-such as timesheet managers, project-based dashboards, expense analysis, team
-management applications, and more.
+Toggl Track is a time tracking API that lets you start, stop, and manage timers and time entries, as well as manage projects, clients, and tasks associated with time records. With the Toggl Track API on Pipedream, you can automate time tracking activities, synchronize data across platforms, and generate insights from time tracking data to improve productivity and project management.
 
-The Toggl Track API also offers data overviews and integrated reporting, as
-well as access to Toggl Track’s easy-to-use user interface. This facilitates
-the creation of customized application features that can help businesses save
-time and maximize productivity.
+# Example Use Cases
 
-Here are a few examples of what you can build using the Toggl Track API:
+- **Project Time Tracking Automation:** Automatically start a Toggl timer when you begin working on a GitHub issue. When the issue is closed, stop the timer. This creates a seamless link between your coding activity and time tracking.
 
-- Timesheet manager: Create an application that gives users an overview of
-  their time tracking data.
-- Project-based dashboard: Visualize employee’s performance data on a
-  project-by-project basis.
-- Expense analysis: Analyze employees' expense data so that businesses can make
-  more informed decisions.
-- Team management applications: Manage employee workloads more efficiently with
-  customized tools.
-- Customized reports: Build customized reports based on specific criteria
-  related to time tracking data.
-- User interface: Access and integrate Toggl Track's intuitive user interface
-  into applications.
+- **Client Reporting Workflow:** Generate weekly time reports for clients by aggregating Toggl data and sending it via Gmail. Use the Pipedream workflow to filter time entries by client and project, compile the data, and format it into a nicely structured email.
 
-- The API Reference has been updated to V9 and has been relocated [here](https://developers.track.toggl.com/)
-- This current implementation in pipdream only utilizes time entries. Toggl also offers coverage at the workspace level down to the individual task level. The workspace docs located [here](https://developers.track.toggl.com/docs/api/workspaces) provide insight in how to begin creating workspaces and allowing other individuals to be added to those workspaces allowing the tracking of whole teams at a time.
+- **Slack Productivity Bot:** Create a Slack bot that prompts team members to log their time if they haven't started a timer by midday. Use Toggl's API to check for active timers and send reminders through Slack, encouraging timely time entry submissions.

package/actions/create-client/create-client.mjs

@@ -0,0 +1,45 @@
+import toggl from "../../toggl.app.mjs";
+
+export default {
+  key: "toggl-create-client",
+  name: "Create Client",
+  description: "Create a new client in Toggl. [See the documentation](https://engineering.toggl.com/docs/api/clients#post-create-client)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    toggl,
+    workspaceId: {
+      propDefinition: [
+        toggl,
+        "workspaceId",
+      ],
+    },
+    name: {
+      propDefinition: [
+        toggl,
+        "clientName",
+      ],
+    },
+    notes: {
+      propDefinition: [
+        toggl,
+        "notes",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.toggl.createClient({
+      $,
+      workspaceId: this.workspaceId,
+      data: {
+        name: this.name,
+        notes: this.notes,
+        wid: this.workspaceId,
+      },
+    });
+    if (response.id) {
+      $.export("$summary", `Successfully created client with ID: ${response.id}`);
+    }
+    return response;
+  },
+};

package/actions/create-project/create-project.mjs

@@ -0,0 +1,86 @@
+import toggl from "../../toggl.app.mjs";
+
+export default {
+  key: "toggl-create-project",
+  name: "Create Project",
+  description: "Create a new project in Toggl. [See the documentation](https://engineering.toggl.com/docs/api/projects#post-workspaceprojects)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    toggl,
+    workspaceId: {
+      propDefinition: [
+        toggl,
+        "workspaceId",
+      ],
+    },
+    name: {
+      propDefinition: [
+        toggl,
+        "projectName",
+      ],
+    },
+    startDate: {
+      propDefinition: [
+        toggl,
+        "startDate",
+      ],
+    },
+    endDate: {
+      propDefinition: [
+        toggl,
+        "endDate",
+      ],
+    },
+    active: {
+      type: "boolean",
+      label: "Active",
+      description: "Whether the project is active or archived. Defaults to `true`.",
+      optional: true,
+      default: true,
+    },
+    isPrivate: {
+      type: "boolean",
+      label: "Is Private?",
+      description: "Whether the project is private or not. Defaults to `false`.",
+      optional: true,
+      default: false,
+    },
+    isShared: {
+      type: "boolean",
+      label: "Is Shared?",
+      description: "Whether the project is shared or not. Defaults to `false`.",
+      optional: true,
+      default: false,
+    },
+    clientId: {
+      propDefinition: [
+        toggl,
+        "clientId",
+        (c) => ({
+          workspaceId: c.workspaceId,
+        }),
+      ],
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const response = await this.toggl.createProject({
+      $,
+      workspaceId: this.workspaceId,
+      data: {
+        name: this.name,
+        start_date: this.startDate,
+        end_date: this.endDate,
+        active: this.active,
+        is_private: this.isPrivate,
+        is_shared: this.isShared,
+        client_id: this.clientId,
+      },
+    });
+    if (response.id) {
+      $.export("$summary", `Successfully created project with ID: ${response.id}`);
+    }
+    return response;
+  },
+};

package/actions/get-current-time-entry/get-current-time-entry.mjs

@@ -2,7 +2,7 @@ import toggl from "../../toggl.app.mjs";
 
 export default {
   name: "Get Current Time Entry",
-  version: "0.0.4",
+  version: "0.0.6",
   key: "toggl-get-current-time-entry",
   description: "Get the time entry that is running now. [See docs here]https://developers.track.toggl.com/docs/api/time_entries#get-get-current-time-entry)",
   type: "action",

package/actions/get-time-entries/get-time-entries.mjs

@@ -2,7 +2,7 @@ import toggl from "../../toggl.app.mjs";
 
 export default {
   name: "Get Time Entries",
-  version: "0.0.4",
+  version: "0.0.6",
   key: "toggl-get-time-entries",
   description: "Get the last thousand time entries. [See docs here](https://developers.track.toggl.com/docs/api/time_entries#get-timeentries)",
   type: "action",

package/actions/get-time-entry/get-time-entry.mjs

@@ -2,7 +2,7 @@ import toggl from "../../toggl.app.mjs";
 
 export default {
   name: "Get Time Entry",
-  version: "0.0.4",
+  version: "0.0.6",
   key: "toggl-get-time-entry",
   description: "Get details about a specific time entry. [See docs here](https://developers.track.toggl.com/docs/api/time_entries)",
   type: "action",
@@ -21,8 +21,7 @@ export default {
       timeEntryId: this.timeEntryId,
     });
 
-    response && $.export("$summary", "Successfully retrieved time entry");
-
+    $.export("$summary", "Successfully retrieved time entry");
     return response;
   },
 };

package/actions/update-client/update-client.mjs

@@ -0,0 +1,61 @@
+import toggl from "../../toggl.app.mjs";
+
+export default {
+  key: "toggl-update-client",
+  name: "Update Client",
+  description: "Updates an existing client in Toggl. [See the documentation](https://engineering.toggl.com/docs/api/clients#put-change-client)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    toggl,
+    workspaceId: {
+      propDefinition: [
+        toggl,
+        "workspaceId",
+      ],
+    },
+    clientId: {
+      propDefinition: [
+        toggl,
+        "clientId",
+        (c) => ({
+          workspaceId: c.workspaceId,
+        }),
+      ],
+    },
+    name: {
+      propDefinition: [
+        toggl,
+        "clientName",
+      ],
+      optional: true,
+    },
+    notes: {
+      propDefinition: [
+        toggl,
+        "notes",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const client = await this.toggl.getClient({
+      $,
+      workspaceId: this.workspaceId,
+      clientId: this.clientId,
+    });
+    const response = await this.toggl.updateClient({
+      $,
+      workspaceId: this.workspaceId,
+      clientId: this.clientId,
+      data: {
+        name: this.name || client.name,
+        notes: this.notes || client.notes,
+        wid: this.workspaceId,
+      },
+    });
+    if (response.id) {
+      $.export("$summary", `Successfully updated client with ID: ${response.id}`);
+    }
+    return response;
+  },
+};

package/actions/update-project/update-project.mjs

@@ -0,0 +1,101 @@
+import toggl from "../../toggl.app.mjs";
+
+export default {
+  key: "toggl-update-project",
+  name: "Update Project",
+  description: "Updates an existing project in Toggl. [See the documentation](https://engineering.toggl.com/docs/api/projects#put-workspaceproject)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    toggl,
+    workspaceId: {
+      propDefinition: [
+        toggl,
+        "workspaceId",
+      ],
+    },
+    projectId: {
+      propDefinition: [
+        toggl,
+        "projectId",
+        (c) => ({
+          workspaceId: c.workspaceId,
+        }),
+      ],
+    },
+    name: {
+      propDefinition: [
+        toggl,
+        "projectName",
+      ],
+      optional: true,
+    },
+    startDate: {
+      propDefinition: [
+        toggl,
+        "startDate",
+      ],
+      optional: true,
+    },
+    endDate: {
+      propDefinition: [
+        toggl,
+        "endDate",
+      ],
+      optional: true,
+    },
+    active: {
+      type: "boolean",
+      label: "Active",
+      description: "Whether the project is active or archived.",
+      optional: true,
+    },
+    isPrivate: {
+      type: "boolean",
+      label: "Is Private?",
+      description: "Whether the project is private or not.",
+      optional: true,
+    },
+    isShared: {
+      type: "boolean",
+      label: "Is Shared?",
+      description: "Whether the project is shared or not.",
+      optional: true,
+    },
+    clientId: {
+      propDefinition: [
+        toggl,
+        "clientId",
+        (c) => ({
+          workspaceId: c.workspaceId,
+        }),
+      ],
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const project = await this.toggl.getProject({
+      $,
+      workspaceId: this.workspaceId,
+      projectId: this.projectId,
+    });
+    const response = await this.toggl.updateProject({
+      $,
+      workspaceId: this.workspaceId,
+      projectId: this.projectId,
+      data: {
+        name: this.name || project.name,
+        start_date: this.startDate || project.start_date,
+        end_date: this.endDate || project.end_date,
+        active: this.active || project.active,
+        is_private: this.isPrivate || project.isPrivate,
+        is_shared: this.isShared || project.is_shared,
+        client_id: this.clientId || project.client_id,
+      },
+    });
+    if (response.id) {
+      $.export("$summary", `Successfully updated project with ID: ${response.id}`);
+    }
+    return response;
+  },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/toggl",
-  "version": "0.0.5",
+  "version": "0.1.0",
   "description": "Pipedream Toggl Components",
   "main": "toggl.app.js",
   "keywords": [
@@ -14,7 +14,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@pipedream/platform": "^0.10.0",
+    "@pipedream/platform": "^3.0.0",
     "toggl-api": "^1.0.2"
   }
 }

package/sources/new-start-time-entry/new-start-time-entry.mjs

@@ -3,7 +3,7 @@ import base from "../common/base.mjs";
 export default {
   ...base,
   name: "New Start Time Entry (Instant)",
-  version: "0.0.2",
+  version: "0.0.4",
   key: "toggl-new-start-time-entry",
   description: "Emit new event when a time entry is started. [See docs here](https://github.com/toggl/toggl_api_docs/blob/master/webhooks.md)",
   type: "source",

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

@@ -3,7 +3,7 @@ import base from "../common/base.mjs";
 export default {
   ...base,
   name: "New Time Entry (Instant)",
-  version: "0.0.2",
+  version: "0.0.4",
   key: "toggl-new-time-entry",
   description: "Emit new event when a time entry is created. [See docs here](https://github.com/toggl/toggl_api_docs/blob/master/webhooks.md)",
   type: "source",

package/sources/new-update-time-entry/new-update-time-entry.mjs

@@ -3,7 +3,7 @@ import base from "../common/base.mjs";
 export default {
   ...base,
   name: "New Update Time Entry (Instant)",
-  version: "0.0.2",
+  version: "0.0.4",
   key: "toggl-new-update-time-entry",
   description: "Emit new event when a time entry is updated. [See docs here](https://github.com/toggl/toggl_api_docs/blob/master/webhooks.md)",
   type: "source",

package/sources/new-webhook-event/new-webhook-event.mjs

@@ -4,7 +4,7 @@ import constants from "../common/constants.mjs";
 export default {
   ...base,
   name: "New Webhook Event (Instant)",
-  version: "0.0.2",
+  version: "0.0.4",
   key: "toggl-new-webhook-event",
   description: "Emit new event on receive a webhook event. [See docs here](https://github.com/toggl/toggl_api_docs/blob/master/webhooks.md)",
   type: "source",

package/toggl.app.mjs

@@ -39,6 +39,62 @@ export default {
         }));
       },
     },
+    clientId: {
+      label: "Client ID",
+      description: "The client ID",
+      type: "integer",
+      async options({ workspaceId }) {
+        const clients = await this.getClients({
+          workspaceId,
+        });
+
+        return clients?.map((client) => ({
+          label: client.name,
+          value: client.id,
+        })) || [];
+      },
+    },
+    projectId: {
+      label: "Project ID",
+      description: "The project ID",
+      type: "integer",
+      async options({ workspaceId }) {
+        const projects = await this.getProjects({
+          workspaceId,
+        });
+
+        return projects?.map((project) => ({
+          label: project.name,
+          value: project.id,
+        })) || [];
+      },
+    },
+    clientName: {
+      type: "string",
+      label: "Name",
+      description: "Name of the client",
+    },
+    notes: {
+      type: "string",
+      label: "Notes",
+      description: "Notes about the client",
+      optional: true,
+    },
+    projectName: {
+      type: "string",
+      label: "Name",
+      description: "Name of the project",
+    },
+    startDate: {
+      type: "string",
+      label: "Start Date",
+      description: "The start date of the project in `YYYY-MM-DD` format",
+    },
+    endDate: {
+      type: "string",
+      label: "End Date",
+      description: "The end date of the project in `YYYY-MM-DD` format",
+    },
   },
   methods: {
     _apiToken() {
@@ -47,7 +103,7 @@ export default {
     _apiUrl(apiVersion) {
       return constants.API_BASE_URL_VERSIONS[apiVersion];
     },
-    async _makeRequest(apiVersion, path, options = {}, $ = this) {
+    _makeRequest(apiVersion, path, options = {}, $ = this) {
       return axios($, {
         url: `${this._apiUrl(apiVersion)}/${path}`,
         auth: {
@@ -57,7 +113,7 @@ export default {
         ...options,
       });
     },
-    async createWebhook({
+    createWebhook({
       workspaceId, data,
     }) {
       return this._makeRequest("v1", `subscriptions/${workspaceId}`, {
@@ -69,22 +125,30 @@ export default {
         },
       });
     },
-    async removeWebhook({
+    removeWebhook({
       workspaceId, webhookId,
     }) {
       return this._makeRequest("v1", `subscriptions/${workspaceId}/${webhookId}`, {
         method: "delete",
       });
     },
-    async getWorkspaces({
+    getWorkspaces({ $ }) {
+      return this._makeRequest("v9", "me/workspaces", {}, $);
+    },
+    getClients({
+      workspaceId, $,
+    }) {
+      return this._makeRequest("v9", `workspaces/${workspaceId}/clients`, {}, $);
+    },
+    getProjects({
       workspaceId, $,
     }) {
-      return this._makeRequest("v9", `workspaces/${workspaceId}`, {}, $);
+      return this._makeRequest("v9", `workspaces/${workspaceId}/projects`, {}, $);
     },
-    async getCurrentTimeEntry({ $ } = {}) {
+    getCurrentTimeEntry({ $ } = {}) {
       return this._makeRequest("v9", "me/time_entries/current", {}, $);
     },
-    async getTimeEntries({
+    getTimeEntries({
       params, $,
     } = {}) {
       return this._makeRequest("v9", "me/time_entries", {
@@ -94,12 +158,52 @@ export default {
         },
       }, $);
     },
-    async getTimeEntry({
+    getTimeEntry({
       timeEntryId, $,
     } = {}) {
-      const { data } = await this._makeRequest("v8", `time_entries/${timeEntryId}`, {}, $);
-
-      return data;
+      return this._makeRequest("v9", `me/time_entries/${timeEntryId}`, {}, $);
+    },
+    getClient({
+      workspaceId, clientId, $,
+    } = {}) {
+      return this._makeRequest("v9", `workspaces/${workspaceId}/clients/${clientId}`, {}, $);
+    },
+    getProject({
+      workspaceId, projectId, $,
+    } = {}) {
+      return this._makeRequest("v9", `workspaces/${workspaceId}/projects/${projectId}`, {}, $);
+    },
+    createClient({
+      workspaceId, data, $,
+    }) {
+      return this._makeRequest("v9", `workspaces/${workspaceId}/clients`, {
+        method: "post",
+        data,
+      }, $);
+    },
+    createProject({
+      workspaceId, data, $,
+    }) {
+      return this._makeRequest("v9", `workspaces/${workspaceId}/projects`, {
+        method: "post",
+        data,
+      }, $);
+    },
+    updateClient({
+      workspaceId, clientId, data, $,
+    }) {
+      return this._makeRequest("v9", `workspaces/${workspaceId}/clients/${clientId}`, {
+        method: "put",
+        data,
+      }, $);
+    },
+    updateProject({
+      workspaceId, projectId, data, $,
+    }) {
+      return this._makeRequest("v9", `workspaces/${workspaceId}/projects/${projectId}`, {
+        method: "put",
+        data,
+      }, $);
     },
   },
 };