@pipedream/freshdesk 0.0.1

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2020 Pipedream, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/actions/create-company/create-company.mjs

@@ -0,0 +1,57 @@
+import { removeNullEntries } from "../../common/utils.mjs";
+import freshdesk from "../../freshdesk.app.mjs";
+
+export default {
+  key: "freshdesk-create-company",
+  name: "Create a Company",
+  description: "Create a company. [See docs here](https://developers.freshdesk.com/api/#companies)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    freshdesk,
+    name: {
+      type: "string",
+      label: "Name",
+      description: "Name of the company.",
+    },
+    description: {
+      type: "string",
+      label: "Description",
+      description: "Description of the company.",
+      optional: true,
+    },
+    note: {
+      type: "string",
+      label: "Note",
+      description: "Any specific note about the company.",
+      optional: true,
+    },
+    industry: {
+      type: "string",
+      label: "Industry",
+      description: "The industry the company serves in.",
+      optional: true,
+    },
+    domains: {
+      type: "string[]",
+      label: "Domains",
+      description: "Domains of the company. Email addresses of contacts that contain this domain will be associated with that company automatically. e.g. [\"supernova\",\"nova\"]",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const payload = removeNullEntries({
+      name: this.name,
+      domains: this.domains,
+      note: this.note,
+      industry: this.industry,
+      description: this.description,
+    });
+    const response = await this.freshdesk.createCompany({
+      $,
+      payload,
+    });
+    response && $.export("$summary", "Company sucessfully created");
+    return response;
+  },
+};

package/actions/create-contact/create-contact.mjs

@@ -0,0 +1,58 @@
+import { removeNullEntries } from "../../common/utils.mjs";
+import freshdesk from "../../freshdesk.app.mjs";
+
+export default {
+  key: "freshdesk-create-contact",
+  name: "Create a Contact",
+  description: "Create a contact. [See docs here](https://developers.freshdesk.com/api/#create_contact)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    freshdesk,
+    name: {
+      type: "string",
+      label: "Name",
+      description: "Name of the contact.",
+    },
+    email: {
+      type: "string",
+      label: "Email",
+      description: "Primary email address of the contact. If you want to associate additional email(s) with this contact, use the other_emails attribute.",
+      optional: true,
+    },
+    otherEmails: {
+      type: "string[]",
+      label: "Additional email addresses",
+      description: "String array of additional email addresses.",
+      optional: true,
+    },
+    phone: {
+      type: "string",
+      label: "Phone number",
+      description: "Telephone number of the contact.",
+      optional: true,
+    },
+    companyId: {
+      propDefinition: [
+        freshdesk,
+        "companyId",
+      ],
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const data = removeNullEntries({
+      name: this.name,
+      email: this.email,
+      other_emails: this.otherEmails,
+      phone: this.phone,
+      company_id: this.companyId && Number(this.companyId),
+    });
+    const response = await this.freshdesk.createContact({
+      $,
+      data,
+    });
+    response && $.export("$summary", "Contact successfully created");
+    return response;
+  },
+};

package/actions/create-ticket/create-ticket.mjs

@@ -0,0 +1,88 @@
+import freshdesk from "../../freshdesk.app.mjs";
+import { removeNullEntries } from "../../common/utils.mjs";
+
+export default {
+  key: "freshdesk-create-ticket",
+  name: "Create a Ticket",
+  description: "Create a ticket. [See docs here](https://developers.freshdesk.com/api/#tickets)",
+  version: "0.0.2",
+  type: "action",
+  props: {
+    freshdesk,
+    companyId: {
+      propDefinition: [
+        freshdesk,
+        "companyId",
+      ],
+      description: "ID of the company to which this ticket belongs",
+    },
+    email: {
+      propDefinition: [
+        freshdesk,
+        "contactEmail",
+        ({ companyId }) => ({
+          companyId,
+        }),
+      ],
+      description: "Email address of the requester.",
+      optional: true,
+    },
+    priority: {
+      propDefinition: [
+        freshdesk,
+        "ticketPriority",
+      ],
+      default: 1,
+    },
+    description: {
+      type: "string",
+      label: "Description",
+      description: "HTML content of the ticket.",
+      optional: true,
+    },
+    descriptionText: {
+      type: "string",
+      label: "Description text",
+      description: "Content of the ticket in plain text.",
+      optional: true,
+    },
+    phone: {
+      type: "string",
+      label: "Phone number",
+      description: "Telephone number of the contact.",
+      optional: true,
+    },
+    subject: {
+      type: "string",
+      label: "Subject",
+      description: "Subject of the ticket.",
+      optional: true,
+    },
+    status: {
+      propDefinition: [
+        freshdesk,
+        "ticketStatus",
+      ],
+      default: 2,
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const data = removeNullEntries({
+      company_id: this.companyId && Number(this.companyId),
+      description: this.description,
+      description_text: this.descriptionText,
+      email: this.email,
+      phone: this.phone,
+      subject: this.subject,
+      status: this.status && Number(this.status),
+      priority: this.priority && Number(this.priority),
+    });
+    const response = await this.freshdesk.createTicket({
+      $,
+      data,
+    });
+    response && $.export("$summary", "Ticket successfully created");
+    return response;
+  },
+};

package/actions/get-ticket/get-ticket.mjs

@@ -0,0 +1,25 @@
+import freshdesk from "../../freshdesk.app.mjs";
+
+export default {
+  key: "freshdesk-get-ticket",
+  name: "Get Ticket Details",
+  description: "Get a Ticket. [See docs here](https://developers.freshdesk.com/api/#tickets)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    freshdesk,
+    id: {
+      type: "string",
+      label: "Ticket ID",
+      description: "Ticket ID.",
+    },
+  },
+  async run({ $ }) {
+    const response = await this.freshdesk.getTicket({
+      $,
+      id: this.id,
+    });
+    response && $.export("$summary", "Successfully found ticket");
+    return response;
+  },
+};

package/actions/list-all-tickets/list-all-tickets.mjs

@@ -0,0 +1,25 @@
+// legacy_hash_id: a_A6i5zz
+import { axios } from "@pipedream/platform";
+
+export default {
+  key: "freshdesk-list-all-tickets",
+  name: "List All Tickets",
+  description: "Use filters to view only specific tickets (those which match the criteria that you choose). By default, only tickets that have not been deleted or marked as spam will be returned, unless you use the 'deleted' filter.",
+  version: "0.1.1",
+  type: "action",
+  props: {
+    freshdesk: {
+      type: "app",
+      app: "freshdesk",
+    },
+  },
+  async run({ $ }) {
+    return await axios($, {
+      url: `https://${this.freshdesk.$auth.domain}.freshdesk.com/api/v2/tickets`,
+      auth: {
+        username: `${this.freshdesk.$auth.api_key}:X`,
+        password: "",
+      },
+    });
+  },
+};

package/common/constants.mjs

@@ -0,0 +1,48 @@
+export default {
+  HTTP_PROTOCOL: "https://",
+  BASE_PATH: "/api",
+  VERSION_PATH: "/v2",
+  PAGE_SIZE: 100,
+  retriableStatusCodes: [
+    408,
+    429,
+    500,
+  ],
+  DB_LAST_DATE_CHECK: "DB_LAST_DATE_CHECK",
+  TICKET_STATUS: [
+    {
+      label: "Open",
+      value: 2,
+    },
+    {
+      label: "Pending",
+      value: 3,
+    },
+    {
+      label: "Resolved",
+      value: 4,
+    },
+    {
+      label: "Closed",
+      value: 5,
+    },
+  ],
+  TICKET_PRIORITY: [
+    {
+      label: "Low",
+      value: 1,
+    },
+    {
+      label: "Medium",
+      value: 2,
+    },
+    {
+      label: "High",
+      value: 3,
+    },
+    {
+      label: "Urgent",
+      value: 4,
+    },
+  ],
+};

package/common/utils.mjs

@@ -0,0 +1,27 @@
+const removeNullEntries = (obj) =>
+  obj && Object.entries(obj).reduce((acc, [
+    key,
+    value,
+  ]) => {
+    const isNumber = typeof value === "number";
+    const isBoolean = typeof value === "boolean";
+    const isNotEmpyString = typeof value === "string" && value.trim() !== "";
+    const isNotEmptyArray = Array.isArray(value) && value.length;
+    const isNotEmptyObject =
+      typeof value === "object" &&
+      value !== null &&
+      !Array.isArray(value) &&
+      Object.keys(value).length !== 0;
+    isNotEmptyObject && (value = removeNullEntries(value));
+    return ((value || value === false) &&
+      (isNotEmpyString || isNotEmptyArray || isNotEmptyObject || isBoolean || isNumber))
+      ? {
+        ...acc,
+        [key]: value,
+      }
+      : acc;
+  }, {});
+
+export {
+  removeNullEntries,
+};

package/freshdesk.app.mjs

@@ -0,0 +1,222 @@
+import constants from "./common/constants.mjs";
+import {
+  axios, ConfigurationError,
+} from "@pipedream/platform";
+import retry from "async-retry";
+
+export default {
+  type: "app",
+  app: "freshdesk",
+  propDefinitions: {
+    companyId: {
+      type: "integer",
+      label: "Company ID",
+      description: "The ID of the company",
+      async options() {
+        const response = await this.getCompanies();
+        return response.map((project) => ({
+          label: project.name,
+          value: project.id,
+        }));
+      },
+    },
+    ticketStatus: {
+      type: "integer",
+      label: "Status",
+      description: "Status of the ticket.",
+      options() {
+        return constants.TICKET_STATUS;
+      },
+    },
+    ticketPriority: {
+      type: "integer",
+      label: "Priority",
+      description: "Priority of the ticket.",
+      options() {
+        return constants.TICKET_PRIORITY;
+      },
+    },
+    contactEmail: {
+      type: "string",
+      label: "Email",
+      description: "Contact Email.",
+      async options({ companyId }) {
+        const response = await this.getCompanies();
+        const contacts = response.filter((contact) => contact.company_id === Number(companyId));
+        return contacts.map((contact) => ({
+          label: contact?.email ?? contact?.name,
+          value: contact.email,
+        }));
+      },
+    },
+  },
+  methods: {
+    setLastDateChecked(db, value) {
+      db && db.set(constants.DB_LAST_DATE_CHECK, value);
+    },
+    getLastDateChecked(db) {
+      return db && db.get(constants.DB_LAST_DATE_CHECK);
+    },
+    base64Encode(data) {
+      return Buffer.from(data).toString("base64");
+    },
+    _getHeaders() {
+      return {
+        "Authorization": "Basic " + this.base64Encode(this.$auth.api_key + ":X"),
+        "Content-Type": "application/json;charset=utf-8",
+      };
+    },
+    _getUrl(path) {
+      const {
+        HTTP_PROTOCOL,
+        BASE_PATH,
+        VERSION_PATH,
+      } = constants;
+      return `${HTTP_PROTOCOL}${this.$auth.domain}${BASE_PATH}${VERSION_PATH}${path}`;
+    },
+    async _makeRequest(args = {}) {
+      const {
+        $,
+        method = "get",
+        path,
+        params,
+        data,
+      } = args;
+      const config = {
+        method,
+        url: this._getUrl(path),
+        headers: this._getHeaders(),
+        params,
+        data,
+      };
+
+      return axios($ ?? this, config);
+    },
+    _isRetriableStatusCode(statusCode) {
+      constants.retriableStatusCodes.includes(statusCode);
+    },
+    async _withRetries(apiCall) {
+      const retryOpts = {
+        retries: 5,
+        factor: 2,
+      };
+      return retry(async (bail) => {
+        try {
+          const data = await apiCall();
+
+          return data;
+        } catch (err) {
+
+          const { status = 500 } = err;
+          if (!this._isRetriableStatusCode(status)) {
+            bail(`
+              Unexpected error (status code: ${status}):
+              ${JSON.stringify(err.response)}
+            `);
+          }
+          throw new ConfigurationError("Could not get data");
+        }
+      }, retryOpts);
+    },
+    async *filterTickets(params) {
+      let loadedData = 0;
+      do {
+        const response = await this.searchTickets(params);
+
+        if (!response || response.results.length === 0) {
+          return;
+        }
+        loadedData += response.results.length;
+        for (const ticket of response.results) {
+          yield ticket;
+        }
+        if (loadedData >= response.total) {
+          return;
+        }
+        params.page += 1;
+      } while (true);
+    },
+    async *filterContacts(params) {
+      let loadedData = 0;
+      do {
+        const response = await this.searchContacts(params);
+
+        if (!response || response.results.length === 0) {
+          return;
+        }
+        loadedData += response.results.length;
+        for (const ticket of response.results) {
+          yield ticket;
+        }
+        if (loadedData >= response.total) {
+          return;
+        }
+        params.page += 1;
+      } while (true);
+    },
+    async createCompany({
+      $, payload: data,
+    }) {
+      return this._makeRequest({
+        $,
+        path: "/companies",
+        data,
+        method: "post",
+      });
+    },
+    async getCompanies($ = undefined) {
+      return this._makeRequest({
+        $,
+        path: "/contacts",
+      });
+    },
+    async getContacts($ = undefined) {
+      return this._makeRequest({
+        $,
+        path: "/companies",
+      });
+    },
+    async createContact({
+      $, data,
+    }) {
+      return this._makeRequest({
+        $,
+        path: "/contacts",
+        data,
+        method: "post",
+      });
+    },
+    async createTicket({
+      $, data,
+    }) {
+      return this._makeRequest({
+        $,
+        path: "/tickets",
+        data,
+        method: "post",
+      });
+    },
+    async getTicket({
+      $, id,
+    }) {
+      return this._makeRequest({
+        $,
+        path: `/tickets/${id}`,
+      });
+    },
+    async searchTickets(params, $ = undefined) {
+      return this._makeRequest({
+        $,
+        path: "/search/tickets",
+        params,
+      });
+    },
+    async searchContacts(params, $ = undefined) {
+      return this._makeRequest({
+        $,
+        path: "/search/contacts",
+        params,
+      });
+    },
+  },
+};

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "@pipedream/freshdesk",
+  "version": "0.0.1",
+  "description": "Pipedream Freshdesk Components",
+  "main": "freshdesk.app.mjs",
+  "keywords": [
+    "pipedream",
+    "freshdesk"
+  ],
+  "homepage": "https://pipedream.com/apps/freshdesk",
+  "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@pipedream/platform": "^0.9.0",
+    "async-retry": "^1.3.3",
+    "moment": "2.29.2"
+  }
+}

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

@@ -0,0 +1,50 @@
+import freshdesk from "../../freshdesk.app.mjs";
+import moment from "moment";
+
+export default {
+  key: "freshdesk-new-contact",
+  name: "New Contact",
+  description: "Emit new notifications when a new contact is created",
+  version: "0.0.1",
+  type: "source",
+  props: {
+    freshdesk,
+    timer: {
+      label: "Polling interval",
+      description: "Pipedream will poll Harvest API on this schedule",
+      type: "$.interface.timer",
+      default: {
+        intervalSeconds: 60 * 15,
+      },
+    },
+    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: `Contact name: ${contact.name}`,
+            ts: Date.parse(contact.created_at),
+          });
+      }
+    });
+  },
+};

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

@@ -0,0 +1,50 @@
+import freshdesk from "../../freshdesk.app.mjs";
+import moment from "moment";
+
+export default {
+  key: "freshdesk-new-ticket",
+  name: "New Ticket",
+  description: "Emit new notifications when a new ticket is created",
+  version: "0.0.1",
+  type: "source",
+  props: {
+    freshdesk,
+    timer: {
+      label: "Polling interval",
+      description: "Pipedream will poll Harvest API on this schedule",
+      type: "$.interface.timer",
+      default: {
+        intervalSeconds: 60 * 15,
+      },
+    },
+    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: `Ticket number: ${ticket.id}`,
+            ts: Date.parse(ticket.created_at)
+          });
+      }
+    });
+  },
+};