17341 action freshsales (#17506)

* [ACTION] Freshsales #17341
Actions
 - Create Contact
 - Create Deal
 - List All Contacts
 - List All Deals

* pnpm update

Author: luancazarine

components/freshsales/.gitignore

@@ -4,8 +4,6 @@ The Freshsales API offers a suite of functionalities to enhance your CRM experie
 
 # Example Use Cases
 
-- **Lead Scoring Automation**: Automatically update the lead score in Freshsales based on customer interactions tracked in other tools. For instance, increase a lead's score when they open a marketing email sent via SendGrid.
-
 - **Deal Progression Notifications**: Set up a workflow that sends real-time Slack notifications to a sales channel when a deal moves to a new stage in the Freshsales pipeline, keeping the team instantly informed.
 
 - **Customer Success Handover**: Automate the process of creating a task in project management tools like Asana when a deal is won in Freshsales, ensuring smooth handover from sales to customer success teams.

components/freshsales/README.md

@@ -0,0 +1,106 @@
+import { parseObject } from "../../common/utils.mjs";
+import freshsales from "../../freshsales.app.mjs";
+
+export default {
+  key: "freshsales-create-contact",
+  name: "Create Contact",
+  description: "Create a new contact in your Freshsales account. [See the documentation](https://developer.freshsales.io/api/#create_a_contact)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    freshsales,
+    email: {
+      type: "string",
+      label: "Email",
+      description: "Email of the contact",
+      reloadProps: true,
+    },
+  },
+  async additionalProps() {
+    const { fields } = await this.freshsales.getContactFields();
+    const filteredFields = fields.filter((field) => (field.visible === true && field.name != "emails"));
+
+    const props = {};
+    for (const field of filteredFields) {
+
+      const data = {
+        type: field.type === "multi_select_dropdown"
+          ? "string[]"
+          : "string",
+        label: field.label,
+        description: `${field.label} of the contact.`,
+        optional: field.required === false,
+      };
+
+      if (field.name === "sales_accounts") {
+        const { sales_accounts: options } = await this.freshsales.getSalesAccounts();
+        const salesAccountOptions = options.map((account) => ({
+          label: account.name,
+          value: `${account.id}`,
+        }));
+        props.primaryAccount = {
+          type: "string",
+          label: "Primary Sales Account",
+          description: "Primary sales account of the contact.",
+          optional: true,
+          options: salesAccountOptions,
+        };
+        props.additionalAccounts = {
+          type: "string[]",
+          label: "Additional Sales Accounts",
+          description: "Additional sales accounts of the contact.",
+          optional: true,
+          options: salesAccountOptions,
+        };
+      } else {
+        if ([
+          "dropdown",
+          "multi_select_dropdown",
+        ].includes(field.type)) {
+          data.type = "integer";
+          data.options = field.choices.map((choice) => ({
+            label: choice.value,
+            value: choice.id,
+          }));
+        }
+        props[field.name] = data;
+      }
+    }
+
+    return props;
+  },
+  async run({ $ }) {
+
+    const {
+      freshsales,
+      ...data
+    } = this;
+
+    if (data.primaryAccount) {
+      data.sales_accounts = [
+        {
+          id: data.primaryAccount,
+          is_primary: true,
+        },
+      ];
+      parseObject(data.additionalAccounts)?.map((account) => {
+        data.sales_accounts.push(
+          {
+            id: account,
+            is_primary: false,
+          },
+        );
+      });
+      delete data.primaryAccount;
+      delete data.additionalAccounts;
+    }
+
+    const response = await freshsales.createContact({
+      $,
+      data,
+    });
+
+    $.export("$summary", `Successfully created contact with ID: ${response.contact.id}`);
+    return response;
+  },
+};

components/freshsales/actions/create-contact/create-contact.mjs

@@ -0,0 +1,89 @@
+import freshsales from "../../freshsales.app.mjs";
+
+export default {
+  key: "freshsales-create-deal",
+  name: "Create Deal",
+  description: "Create a new deal in your Freshsales account. [See the documentation](https://developer.freshsales.io/api/#create_deal)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    freshsales,
+    name: {
+      type: "string",
+      label: "Name",
+      description: "Name of the deal",
+      reloadProps: true,
+    },
+  },
+  async additionalProps() {
+    const { fields } = await this.freshsales.getDealFields();
+    const filteredFields = fields.filter((field) => (field.visible === true && field.name != "name"));
+
+    const props = {};
+    for (const field of filteredFields) {
+
+      const data = {
+        type: field.type === "multi_select_dropdown"
+          ? "string[]"
+          : "string",
+        label: field.label,
+        description: `${field.label} of the deal.`,
+        optional: field.required === false,
+      };
+
+      if (field.name === "sales_account_id") {
+        const { sales_accounts: options } = await this.freshsales.getSalesAccounts();
+        data.type = "integer";
+        data.label = "Sales Account";
+        data.description = "Sales account of the deal.";
+        data.optional = true;
+        data.options = options.map((account) => ({
+          label: account.name,
+          value: account.id,
+        }));
+      }
+
+      if (field.name === "contacts") {
+        const { contacts: options } = await this.freshsales.getContacts();
+        data.type = "integer[]";
+        data.label = "Contacts";
+        data.description = "Contacts of the deal.";
+        data.optional = true;
+        data.options = options.map((contact) => ({
+          label: contact.display_name,
+          value: contact.id,
+        }));
+      }
+
+      if ([
+        "dropdown",
+        "multi_select_dropdown",
+      ].includes(field.type)) {
+        data.type = "integer";
+        data.options = field.choices.map((choice) => ({
+          label: choice.value,
+          value: choice.id,
+        }));
+      }
+
+      props[field.name] = data;
+    }
+
+    return props;
+  },
+  async run({ $ }) {
+
+    const {
+      freshsales,
+      ...data
+    } = this;
+
+    const response = await freshsales.createDeal({
+      $,
+      data,
+    });
+
+    $.export("$summary", `Successfully created deal with ID: ${response.deal.id}`);
+    return response;
+  },
+};

components/freshsales/actions/create-deal/create-deal.mjs

@@ -0,0 +1,34 @@
+import freshsales from "../../freshsales.app.mjs";
+
+export default {
+  key: "freshsales-list-all-contacts",
+  name: "List All Contacts",
+  description: "Fetch all contacts from your Freshsales account. [See the documentation](https://developer.freshsales.io/api/#list_all_contacts)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    freshsales,
+  },
+  async run({ $ }) {
+    const filterId = await this.freshsales.getFilterId({
+      model: "contacts",
+      name: "All Contacts",
+    });
+
+    const response = this.freshsales.paginate({
+      fn: this.freshsales.listContacts,
+      responseField: "contacts",
+      filterId,
+    });
+
+    const contacts = [];
+    for await (const contact of response) {
+      contacts.push(contact);
+    }
+
+    $.export("$summary", `Successfully fetched ${contacts?.length || 0} contact${contacts?.length === 1
+      ? ""
+      : "s"}`);
+    return contacts;
+  },
+};

components/freshsales/actions/list-all-contacts/list-all-contacts.mjs

@@ -0,0 +1,34 @@
+import freshsales from "../../freshsales.app.mjs";
+
+export default {
+  key: "freshsales-list-all-deals",
+  name: "List All Deals",
+  description: "Fetch all deals from your Freshsales account. [See the documentation](https://developer.freshsales.io/api/#list_all_deals)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    freshsales,
+  },
+  async run({ $ }) {
+    const filterId = await this.freshsales.getFilterId({
+      model: "deals",
+      name: "All Deals",
+    });
+
+    const response = this.freshsales.paginate({
+      fn: this.freshsales.listDeals,
+      responseField: "deals",
+      filterId,
+    });
+
+    const deals = [];
+    for await (const deal of response) {
+      deals.push(deal);
+    }
+
+    $.export("$summary", `Successfully fetched ${deals?.length || 0} deal${deals?.length === 1
+      ? ""
+      : "s"}`);
+    return deals;
+  },
+};

components/freshsales/actions/list-all-deals/list-all-deals.mjs

@@ -0,0 +1,29 @@
+export const snakeCaseToTitleCase = (s) =>
+  s.replace(/^_*(.)|_+(.)/g, (s, c, d) => c
+    ? c.toUpperCase()
+    : " " + d.toUpperCase());
+
+export const parseObject = (obj) => {
+  if (!obj) return undefined;
+
+  if (Array.isArray(obj)) {
+    return obj.map((item) => {
+      if (typeof item === "string") {
+        try {
+          return JSON.parse(item);
+        } catch (e) {
+          return item;
+        }
+      }
+      return item;
+    });
+  }
+  if (typeof obj === "string") {
+    try {
+      return JSON.parse(obj);
+    } catch (e) {
+      return obj;
+    }
+  }
+  return obj;
+};