@pipedream/freshdesk 0.3.0 → 0.4.0

package/freshdesk.app.mjs

@@ -19,7 +19,6 @@ export default {
         }));
       },
     },
-
     ticketId: {
       type: "integer",
       label: "Ticket ID",
@@ -79,7 +78,6 @@ export default {
         }));
       },
     },
-
     ticketStatus: {
       type: "integer",
       label: "Status",
@@ -116,6 +114,138 @@ export default {
           }));
       },
     },
+    contactId: {
+      type: "string",
+      label: "Contact ID",
+      description: "The ID of a contact",
+      async options({
+        companyId, page,
+      }) {
+        const contacts = await this.getContacts({
+          params: {
+            company_id: companyId,
+            page: page + 1,
+          },
+        });
+        return contacts
+          .map(({
+            id, name, email,
+          }) => ({
+            label: name || email,
+            value: id,
+          }));
+      },
+    },
+    ticketFieldId: {
+      type: "string",
+      label: "Ticket Field ID",
+      description: "The ID of a ticket field",
+      async options({ page }) {
+        const fields = await this.listTicketFields({
+          params: {
+            page: page + 1,
+          },
+        });
+        return fields.map(({
+          id, label,
+        }) => ({
+          label: label || id,
+          value: id,
+        }));
+      },
+    },
+    skillIds: {
+      type: "string[]",
+      label: "Skill IDs",
+      description: "Array of skill IDs",
+      optional: true,
+      async options({ page }) {
+        const skills = await this.listSkills({
+          params: {
+            page: page + 1,
+          },
+        });
+        return skills.map(({
+          id, name,
+        }) => ({
+          label: name || id,
+          value: id,
+        }));
+      },
+    },
+    roleIds: {
+      type: "string[]",
+      label: "Role IDs",
+      description: "Array of role IDs",
+      optional: true,
+      async options() {
+        const roles = await this.listRoles();
+        return roles.map(({
+          id, name,
+        }) => ({
+          label: name || id,
+          value: id,
+        }));
+      },
+    },
+    categoryId: {
+      type: "integer",
+      label: "Category ID",
+      description: "The ID of a category",
+      async options() {
+        const categories = await this.listSolutionCategories();
+        return categories.map(({
+          id, name,
+        }) => ({
+          label: name || id,
+          value: id,
+        }));
+      },
+    },
+    folderId: {
+      type: "integer",
+      label: "Folder ID",
+      description: "The ID of a folder",
+      async options({ categoryId }) {
+        const folders = await this.listCategoryFolders({
+          categoryId,
+        });
+        return folders.map(({
+          id, name,
+        }) => ({
+          label: name || id,
+          value: id,
+        }));
+      },
+    },
+    articleId: {
+      type: "integer",
+      label: "Article ID",
+      description: "The ID of an article",
+      async options({
+        page, folderId,
+      }) {
+        const articles = await this.listFolderArticles({
+          folderId,
+          params: {
+            page: page + 1,
+          },
+        });
+        return articles.map(({
+          id, title,
+        }) => ({
+          label: title || id,
+          value: id,
+        }));
+      },
+    },
+    maxResults: {
+      type: "integer",
+      label: "Max Results",
+      description: "The maximum number of results to return",
+      default: 100,
+      optional: true,
+    },
     ticketTags: {
       type: "string[]",
       label: "Tags",
@@ -210,6 +340,14 @@ export default {
         ...args,
       });
     },
+    async getContact({
+      contactId, ...args
+    }) {
+      return this._makeRequest({
+        url: `/contacts/${contactId}`,
+        ...args,
+      });
+    },
     async getContacts(args) {
       return this._makeRequest({
         url: "/contacts",
@@ -223,6 +361,15 @@ export default {
         ...args,
       });
     },
+    async updateContact({
+      contactId, ...args
+    }) {
+      return this._makeRequest({
+        url: `/contacts/${contactId}`,
+        method: "put",
+        ...args,
+      });
+    },
     async createTicket(args) {
       return this._makeRequest({
         url: "/tickets",
@@ -250,6 +397,119 @@ export default {
         ...args,
       });
     },
+    async listTicketFields(args) {
+      return this._makeRequest({
+        url: "/ticket_fields",
+        ...args,
+      });
+    },
+    async createTicketField(args) {
+      return this._makeRequest({
+        url: "/admin/ticket_fields",
+        method: "post",
+        ...args,
+      });
+    },
+    async updateTicketField({
+      ticketFieldId, ...args
+    }) {
+      return this._makeRequest({
+        url: `/admin/ticket_fields/${ticketFieldId}`,
+        method: "put",
+        ...args,
+      });
+    },
+    async listAgents(args) {
+      return this._makeRequest({
+        url: "/agents",
+        ...args,
+      });
+    },
+    async createAgent(args) {
+      return this._makeRequest({
+        url: "/agents",
+        method: "post",
+        ...args,
+      });
+    },
+    async updateAgent({
+      agentId, ...args
+    }) {
+      return this._makeRequest({
+        url: `/agents/${agentId}`,
+        method: "put",
+        ...args,
+      });
+    },
+    async listSkills(args) {
+      return this._makeRequest({
+        url: "/admin/skills",
+        ...args,
+      });
+    },
+    async listRoles(args) {
+      return this._makeRequest({
+        url: "/roles",
+        ...args,
+      });
+    },
+    async listSolutionCategories(args) {
+      return this._makeRequest({
+        url: "/solutions/categories",
+        ...args,
+      });
+    },
+    async listCategoryFolders({
+      categoryId, ...args
+    }) {
+      return this._makeRequest({
+        url: `/solutions/categories/${categoryId}/folders`,
+        ...args,
+      });
+    },
+    async listFolderArticles({
+      folderId, ...args
+    }) {
+      return this._makeRequest({
+        url: `/solutions/folders/${folderId}/articles`,
+        ...args,
+      });
+    },
+    async getArticle({
+      articleId, ...args
+    }) {
+      return this._makeRequest({
+        url: `/solutions/articles/${articleId}`,
+        ...args,
+      });
+    },
+    async createArticle({
+      folderId, ...args
+    }) {
+      return this._makeRequest({
+        url: `/solutions/folders/${folderId}/articles`,
+        method: "post",
+        ...args,
+      });
+    },
+    async updateArticle({
+      articleId, ...args
+    }) {
+      return this._makeRequest({
+        url: `/solutions/articles/${articleId}`,
+        method: "put",
+        ...args,
+      });
+    },
+    async deleteArticle({
+      articleId, ...args
+    }) {
+      return this._makeRequest({
+        url: `/solutions/articles/${articleId}`,
+        method: "delete",
+        ...args,
+      });
+    },
     async listTickets(args) {
       return this._makeRequest({
         url: "/tickets",
@@ -257,10 +517,17 @@ export default {
       });
     },
     async getTicketName(ticketId) {
-      const ticket = await this.getTicket({
-        ticketId,
-      });
-      return ticket.subject;
+      try {
+        const ticket = await this.getTicket({
+          ticketId,
+        });
+        return ticket.subject;
+      } catch (error) {
+        if (error.response?.status === 404) {
+          return null;
+        }
+        throw error;
+      }
     },
     parseIfJSONString(input) {
       if (typeof input === "string") {
@@ -272,6 +539,29 @@ export default {
       }
       return input;
     },
+    /**
+     * Add a note to a Freshdesk ticket
+     * @param {Object} options - The options object
+     * @param {number} options.ticketId - The ID of the ticket to add the note to
+     * @param {Object} options.data - The note data object
+     * @param {string} options.data.body - Content of the note in HTML format
+     * @param {boolean} [options.data.private=false] - Whether the note is private
+     * @param {boolean} [options.data.incoming] - Whether the note is incoming
+     * @param {number} [options.data.user_id] - ID of the user creating the note
+     * @param {string[]} [options.data.notify_emails] - Array of email addresses to notify
+     * @param {...*} args - Additional arguments passed to _makeRequest
+     * @returns {Promise<Object>} The API response containing the created note
+     */
+    async addNoteToTicket({
+      ticketId, data, ...args
+    }) {
+      return this._makeRequest({
+        url: `/tickets/${ticketId}/notes`,
+        method: "post",
+        data,
+        ...args,
+      });
+    },
     /**
      * Set tags on a ticket (replaces all existing tags)
      * @param {object} args - Arguments object
@@ -345,5 +635,39 @@ export default {
         ...args,
       });
     },
+    async *paginate({
+      fn, args, max,
+    }) {
+      args = {
+        ...args,
+        params: {
+          ...args?.params,
+          page: 1,
+          per_page: 100,
+        },
+      };
+      let total, count = 0;
+      do {
+        const results = await fn(args);
+        total = results?.length;
+        if (!total) {
+          return;
+        }
+        for (const result of results) {
+          yield result;
+          if (max && ++count >= max) {
+            return;
+          }
+        }
+        args.params.page += 1;
+      } while (total === args.params.per_page);
+    },
+    async getPaginatedResources(opts) {
+      const results = [];
+      for await (const result of this.paginate(opts)) {
+        results.push(result);
+      }
+      return results;
+    },
   },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/freshdesk",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Pipedream Freshdesk Components",
   "main": "freshdesk.app.mjs",
   "keywords": [

package/sources/common/polling.mjs

@@ -0,0 +1,63 @@
+import freshdesk from "../../freshdesk.app.mjs";
+import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
+import moment from "moment";
+
+export default {
+  props: {
+    freshdesk,
+    timer: {
+      type: "$.interface.timer",
+      default: {
+        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
+      },
+    },
+    db: "$.service.db",
+  },
+  methods: {
+    getResourceFn() {
+      throw new Error("getResourceFn is not implemented");
+    },
+    getTsField() {
+      throw new Error("getTsField is not implemented");
+    },
+    generateMeta() {
+      throw new Error("generateMeta is not implemented");
+    },
+  },
+  async run() {
+    const data = [];
+    let lastDateChecked = this.freshdesk.getLastDateChecked(this.db);
+    if (!lastDateChecked) {
+      lastDateChecked = new Date().toISOString();
+      this.freshdesk.setLastDateChecked(this.db, lastDateChecked);
+    }
+    let maxTs = lastDateChecked;
+
+    const resourceFn = this.getResourceFn();
+    const tsField = this.getTsField();
+
+    const formatedDate = lastDateChecked.substr(
+      0,
+      (lastDateChecked + "T").indexOf("T"),
+    );
+    const results = await resourceFn({
+      query: `"${tsField}:>'${formatedDate}'"`,
+      page: 1,
+    });
+    for await (const result of results) {
+      data.push(result);
+    }
+
+    data &&
+      data.reverse().forEach((item) => {
+        if (moment(item[tsField]).isAfter(lastDateChecked)) {
+          if (moment(item[tsField]).isAfter(maxTs)) {
+            maxTs = item[tsField];
+          }
+          this.$emit(item, this.generateMeta(item));
+        }
+      });
+
+    this.freshdesk.setLastDateChecked(this.db, maxTs);
+  },
+};

package/sources/contact-updated/contact-updated.mjs

@@ -0,0 +1,28 @@
+import common from "../common/polling.mjs";
+
+export default {
+  ...common,
+  key: "freshdesk-contact-updated",
+  name: "Contact Updated",
+  description: "Emit new event when a contact is updated. [See the documentation](https://developers.freshdesk.com/api/#filter_contacts)",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getResourceFn() {
+      return this.freshdesk.filterContacts;
+    },
+    getTsField() {
+      return "updated_at";
+    },
+    generateMeta(item) {
+      const ts = Date.parse(item.updated_at);
+      return {
+        id: `${item.id}-${ts}`,
+        summary: `Contact Updated (ID: ${item.id})`,
+        ts,
+      };
+    },
+  },
+};

package/sources/new-contact/new-contact.mjs

@@ -1,49 +1,27 @@
-import freshdesk from "../../freshdesk.app.mjs";
-import moment from "moment";
-import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
+import common from "../common/polling.mjs";
 
 export default {
+  ...common,
   key: "freshdesk-new-contact",
   name: "New Contact Created",
   description: "Emit new event when a contact is created. [See the documentation](https://developers.freshdesk.com/api/#filter_contacts)",
-  version: "0.0.6",
+  version: "0.0.8",
   type: "source",
-  props: {
-    freshdesk,
-    timer: {
-      type: "$.interface.timer",
-      default: {
-        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
-      },
-    },
-    db: "$.service.db",
-  },
   dedupe: "unique",
-  async run() {
-    const data = [];
-    let lastDateChecked = this.freshdesk.getLastDateChecked(this.db);
-    if (!lastDateChecked) {
-      lastDateChecked = new Date().toISOString();
-      this.freshdesk.setLastDateChecked(this.db, lastDateChecked);
-    }
-    const formatedDate = lastDateChecked.substr(0, (lastDateChecked + "T").indexOf("T"));
-    const contacts = await this.freshdesk.filterContacts({
-      query: `"created_at:>'${formatedDate}'"`,
-      page: 1,
-    });
-    for await (const contact of contacts) {
-      data.push(contact);
-    }
-    data && data.reverse().forEach((contact) => {
-      this.freshdesk.setLastDateChecked(this.db, contact.created_at);
-      if (moment(contact.created_at).isAfter(lastDateChecked)) {
-        this.$emit(contact,
-          {
-            id: contact.id,
-            summary: `New Contact: "${contact.name}"`,
-            ts: Date.parse(contact.created_at),
-          });
-      }
-    });
+  methods: {
+    ...common.methods,
+    getResourceFn() {
+      return this.freshdesk.filterContacts;
+    },
+    getTsField() {
+      return "created_at";
+    },
+    generateMeta(item) {
+      return {
+        id: item.id,
+        summary: `New Contact: "${item.name}"`,
+        ts: Date.parse(item.created_at),
+      };
+    },
   },
 };

package/sources/new-ticket/new-ticket.mjs

@@ -1,52 +1,27 @@
-import freshdesk from "../../freshdesk.app.mjs";
-import moment from "moment";
-import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
+import common from "../common/polling.mjs";
 
 export default {
+  ...common,
   key: "freshdesk-new-ticket",
   name: "New Ticket Created",
   description: "Emit new event when a ticket is created. [See the documentation](https://developers.freshdesk.com/api/#filter_tickets)",
-  version: "0.0.6",
+  version: "0.0.8",
   type: "source",
-  props: {
-    freshdesk,
-    timer: {
-      type: "$.interface.timer",
-      default: {
-        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
-      },
-    },
-    db: "$.service.db",
-  },
   dedupe: "unique",
-  async run() {
-    const data = [];
-    let lastDateChecked = this.freshdesk.getLastDateChecked(this.db);
-    if (!lastDateChecked) {
-      lastDateChecked = new Date().toISOString();
-      this.freshdesk.setLastDateChecked(this.db, lastDateChecked);
-    }
-    const formatedDate = lastDateChecked.substr(
-      0,
-      (lastDateChecked + "T").indexOf("T"),
-    );
-    const tickets = await this.freshdesk.filterTickets({
-      query: `"created_at:>'${formatedDate}'"`,
-      page: 1,
-    });
-    for await (const ticket of tickets) {
-      data.push(ticket);
-    }
-    data &&
-      data.reverse().forEach((ticket) => {
-        this.freshdesk.setLastDateChecked(this.db, ticket.created_at);
-        if (moment(ticket.created_at).isAfter(lastDateChecked)) {
-          this.$emit(ticket, {
-            id: ticket.id,
-            summary: `New Ticket (ID: ${ticket.id})`,
-            ts: Date.parse(ticket.created_at),
-          });
-        }
-      });
+  methods: {
+    ...common.methods,
+    getResourceFn() {
+      return this.freshdesk.filterTickets;
+    },
+    getTsField() {
+      return "created_at";
+    },
+    generateMeta(item) {
+      return {
+        id: item.id,
+        summary: `New Ticket (ID: ${item.id})`,
+        ts: Date.parse(item.created_at),
+      };
+    },
   },
 };

package/sources/ticket-updated/ticket-updated.mjs

@@ -0,0 +1,28 @@
+import common from "../common/polling.mjs";
+
+export default {
+  ...common,
+  key: "freshdesk-ticket-updated",
+  name: "Ticket Updated",
+  description: "Emit new event when a ticket is updated. [See the documentation](https://developers.freshdesk.com/api/#filter_tickets)",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getResourceFn() {
+      return this.freshdesk.filterTickets;
+    },
+    getTsField() {
+      return "updated_at";
+    },
+    generateMeta(item) {
+      const ts = Date.parse(item.updated_at);
+      return {
+        id: `${item.id}-${ts}`,
+        summary: `Ticket Updated (ID: ${item.id})`,
+        ts,
+      };
+    },
+  },
+};