QuickBooks Webhook Sources

components/quickbooks/actions/download-pdf/download-pdf.js

@@ -0,0 +1,64 @@
+const quickbooks = require("../../quickbooks.app");
+const fs = require("fs");
+const { promisify } = require("util");
+const stream = require("stream");
+
+module.exports = {
+  name: "Download PDF",
+  description: "Download an invoice, bill, purchase order or other QuickBooks entity as a PDF and save it in [Pipedream's temporary file system](https://pipedream.com/docs/workflows/steps/code/nodejs/working-with-files/#the-tmp-directory) for use in a later step.",
+  key: "quickbooks-download-pdf",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    quickbooks,
+    entity: {
+      type: "string",
+      label: "Document Type",
+      description: null,
+      options: [
+        "CreditMemo",
+        "Estimate",
+        "Invoice",
+        "Payment",
+        "PurchaseOrder",
+        "RefundReceipt",
+        "SalesReceipt",
+      ],
+    },
+    id: {
+      type: "string",
+      label: "Record ID",
+      description: "Use the 'Id' property of the record's JSON object or open the record for editing in Quickbooks Online to find its ID in the URL after 'txnId=', e.g. 'https://app.qbo.intuit.com/app/invoice?txnId=22743'",
+    },
+    fileName: {
+      type: "string",
+      label: "File Name (Optional)",
+      description: "The name to give the PDF when it is stored in the /tmp directory, e.g. `myFile.pdf`. If no file name is provided, the PDF will be named using the record ID, e.g. '22743.pdf'",
+      optional: true,
+    },
+  },
+  methods: {
+    async downloadPDF($, entity, id, fileName) {
+      const file = await this.quickbooks.getPDF($, entity, id);
+
+      const filePath = "/tmp/" + fileName;
+      const pipeline = promisify(stream.pipeline);
+      await pipeline(
+        file,
+        fs.createWriteStream(filePath),
+      );
+      return filePath;
+    },
+  },
+  async run({ $ }) {
+    const fileName = this.fileName || this.id;
+    const fileNameWithExtension = fileName.endsWith(".pdf")
+      ? fileName
+      : fileName + ".pdf";
+
+    const filePath = await this.downloadPDF($, this.entity, this.id, fileNameWithExtension);
+    $.export("file_path", filePath);
+    $.export("file_name", fileNameWithExtension);
+    $.export("$summary", `Successfully downloaded file: ${fileNameWithExtension}`);
+  },
+};

components/quickbooks/constants.js

@@ -0,0 +1,210 @@
+const WEBHOOK_ENTITIES = [
+  "Account",
+  "Bill",
+  "BillPayment",
+  "Budget",
+  "Class",
+  "CreditMemo",
+  "Currency",
+  "Customer",
+  "Department",
+  "Deposit",
+  "Employee",
+  "Estimate",
+  "Invoice",
+  "Item",
+  "JournalCode",
+  "JournalEntry",
+  "Payment",
+  "PaymentMethod",
+  "Preferences",
+  "Purchase",
+  "PurchaseOrder",
+  "RefundReceipt",
+  "SalesReceipt",
+  "TaxAgency",
+  "Term",
+  "TimeActivity",
+  "Transfer",
+  "Vendor",
+  "VendorCredit",
+];
+
+const WEBHOOK_OPERATIONS = [
+  "Create",
+  "Update",
+  "Merge",
+  "Delete",
+  "Void",
+  "Emailed",
+];
+
+// The below list is based on the table shown in Step 3 of the Intuit webhooks documentation
+// https://developer.intuit.com/app/developer/qbo/docs/develop/webhooks#set-up-oauth
+const SUPPORTED_WEBHOOK_OPERATIONS = {
+  Account: [
+    "Create",
+    "Update",
+    "Merge",
+    "Delete",
+  ],
+  Bill: [
+    "Create",
+    "Update",
+    "Delete",
+  ],
+  BillPayment: [
+    "Create",
+    "Update",
+    "Delete",
+    "Void",
+  ],
+  Budget: [
+    "Create",
+    "Update",
+  ],
+  Class: [
+    "Create",
+    "Update",
+    "Merge",
+    "Delete",
+  ],
+  CreditMemo: [
+    "Create",
+    "Update",
+    "Delete",
+    "Void",
+    "Emailed",
+  ],
+  Currency: [
+    "Create",
+    "Update",
+  ],
+  Customer: [
+    "Create",
+    "Update",
+    "Merge",
+    "Delete",
+  ],
+  Department: [
+    "Create",
+    "Update",
+    "Merge",
+  ],
+  Deposit: [
+    "Create",
+    "Update",
+    "Delete",
+  ],
+  Employee: [
+    "Create",
+    "Update",
+    "Merge",
+    "Delete",
+  ],
+  Estimate: [
+    "Create",
+    "Update",
+    "Delete",
+    "Emailed",
+  ],
+  Invoice: [
+    "Create",
+    "Update",
+    "Delete",
+    "Void",
+    "Emailed",
+  ],
+  Item: [
+    "Create",
+    "Update",
+    "Merge",
+    "Delete",
+  ],
+  JournalCode: [
+    "Create",
+    "Update",
+  ],
+  JournalEntry: [
+    "Create",
+    "Update",
+    "Delete",
+  ],
+  Payment: [
+    "Create",
+    "Update",
+    "Delete",
+    "Void",
+    "Emailed",
+  ],
+  PaymentMethod: [
+    "Create",
+    "Update",
+    "Merge",
+  ],
+  Preferences: [
+    "Update",
+  ],
+  Purchase: [
+    "Create",
+    "Update",
+    "Delete",
+    "Void",
+  ],
+  PurchaseOrder: [
+    "Create",
+    "Update",
+    "Delete",
+    "Emailed",
+  ],
+  RefundReceipt: [
+    "Create",
+    "Update",
+    "Delete",
+    "Void",
+    "Emailed",
+  ],
+  SalesReceipt: [
+    "Create",
+    "Update",
+    "Delete",
+    "Void",
+    "Emailed",
+  ],
+  TaxAgency: [
+    "Create",
+    "Update",
+  ],
+  Term: [
+    "Create",
+    "Update",
+  ],
+  TimeActivity: [
+    "Create",
+    "Update",
+    "Delete",
+  ],
+  Transfer: [
+    "Create",
+    "Update",
+    "Delete",
+    "Void",
+  ],
+  Vendor: [
+    "Create",
+    "Update",
+    "Merge",
+    "Delete",
+  ],
+  VendorCredit: [
+    "Create",
+    "Update",
+    "Delete",
+  ],
+};
+
+module.exports = {
+  WEBHOOK_ENTITIES,
+  WEBHOOK_OPERATIONS,
+  SUPPORTED_WEBHOOK_OPERATIONS,
+};

components/quickbooks/quickbooks.app.js

@@ -0,0 +1,97 @@
+const { axios } = require("@pipedream/platform");
+const {
+  WEBHOOK_ENTITIES,
+  WEBHOOK_OPERATIONS,
+} = require("./constants");
+
+module.exports = {
+  type: "app",
+  app: "quickbooks",
+  propDefinitions: {
+    webhookNames: {
+      type: "string[]",
+      label: "Entities",
+      description: "Select which QuickBooks entities to emit or just leave it blank to emit them all.",
+      options: WEBHOOK_ENTITIES,
+      optional: true,
+    },
+    webhookOperations: {
+      type: "string[]",
+      label: "Operations",
+      description: "Select which operations to emit or just leave it blank to emit them all.",
+      options: WEBHOOK_OPERATIONS,
+      default: WEBHOOK_OPERATIONS,
+      optional: true,
+    },
+    webhookVerifierToken: {
+      type: "string",
+      label: "Verifier Token",
+      description: "[Create an app](https://developer.intuit.com/app/developer/qbo/docs/build-your-first-app) " +
+      "on the Intuit Developer Dashboard and [set up a webhook](https://developer.intuit.com/app/developer/qbo/docs/develop/webhooks). " +
+      "Once you have a [verifier token](https://developer.intuit.com/app/developer/qbo/docs/develop/webhooks/managing-webhooks-notifications), " +
+      "fill it in below. Note that if you want to send webhooks to more than one Pipedream source, you will have to create a new Dashboard app for each different source.",
+      secret: true,
+    },
+  },
+  methods: {
+    _apiUrl() {
+      return "https://quickbooks.api.intuit.com/v3";
+    },
+    _authToken() {
+      return this.$auth.oauth_access_token;
+    },
+    companyId() {
+      return this.$auth.company_id;
+    },
+    _makeRequestConfig(config = {}) {
+      const {
+        headers,
+        path = "",
+        ...extraConfig
+      } = config;
+      const authToken = this._authToken();
+      const baseUrl = this._apiUrl();
+      const url = `${baseUrl}${path[0] === "/"
+        ? ""
+        : "/"}${path}`;
+      return {
+        headers: {
+          "Authorization": `Bearer ${authToken}`,
+          "Accept": "application/json",
+          "Content-Type": "application/json",
+          ...headers,
+        },
+        url,
+        ...extraConfig,
+      };
+    },
+    async _makeRequest($ = this, config) {
+      const requestConfig = this._makeRequestConfig(config);
+      return await axios($, requestConfig);
+    },
+    async getPDF($, entity, id) {
+      try {
+        const companyId = this.companyId();
+        return await this._makeRequest($, {
+          path: `company/${companyId}/${entity.toLowerCase()}/${id}/pdf`,
+          headers: {
+            "Accept": "application/pdf",
+          },
+          responseType: "stream",
+        });
+      } catch (ex) {
+        if (ex.response.data.statusCode === 400) {
+          throw new Error(`Request failed with status code 400. Double-check that '${id}' is a valid ${entity} record ID.`);
+        } else {
+          throw ex;
+        }
+      }
+    },
+    async getRecordDetails(entityName, id) {
+      const companyId = this.companyId();
+      return await this._makeRequest(this, {
+        path: `company/${companyId}/${entityName.toLowerCase()}/${id}`,
+      });
+    },
+  },
+};