@pipedream/taxjar 0.0.2 → 0.1.0

package/README.md

@@ -0,0 +1,14 @@
+# Overview
+
+The TaxJar API offers a suite of tools for automating sales tax calculations, reporting, and filings. With this API, you can get real-time sales tax rates and calculations at checkout, generate detailed sales tax reports for each state, and automate your sales tax filings. Integrating TaxJar with Pipedream allows you to create workflows that can enhance e-commerce platforms, financial systems, and accounting software, ensuring that sales tax handling is both accurate and effortless.
+
+# Example Use Cases
+
+- **Real-Time Sales Tax Calculation at Checkout**  
+  Automatically calculate sales tax in Pipedream workflows for e-commerce orders. When a new order is received in Shopify, trigger a workflow that uses the TaxJar API to calculate the appropriate sales tax based on the customer’s location and the items purchased.
+
+- **Monthly Sales Tax Reporting**  
+  Schedule a Pipedream workflow that runs at the end of every month, summarizing total sales and taxes collected through Stripe. Use TaxJar to prepare the tax reports needed for filing, ensuring compliance with minimal manual effort.
+
+- **Automated Tax Filing Reminders**  
+  Combine the TaxJar API with Google Calendar in Pipedream to create workflows that remind you to file taxes before the due date. When TaxJar reports a nearing filing deadline, the workflow can create an event in your Google Calendar as a reminder.

package/actions/calculate-sales-tax/calculate-sales-tax.mjs

@@ -0,0 +1,98 @@
+import app from "../../taxjar.app.mjs";
+
+export default {
+  key: "taxjar-calculate-sales-tax",
+  name: "Calculate Sales Tax",
+  description: "Shows the sales tax that should be collected for a given order. [See the documentation](https://developers.taxjar.com/api/reference/#taxes)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    app,
+    exemptionType: {
+      propDefinition: [
+        app,
+        "exemptionType",
+      ],
+    },
+    fromCountry: {
+      propDefinition: [
+        app,
+        "fromCountry",
+      ],
+    },
+    fromZip: {
+      propDefinition: [
+        app,
+        "fromZip",
+      ],
+    },
+    fromState: {
+      propDefinition: [
+        app,
+        "fromState",
+      ],
+    },
+    fromCity: {
+      propDefinition: [
+        app,
+        "fromCity",
+      ],
+    },
+    fromStreet: {
+      propDefinition: [
+        app,
+        "fromStreet",
+      ],
+    },
+    toCountry: {
+      propDefinition: [
+        app,
+        "toCountry",
+      ],
+    },
+    toZip: {
+      propDefinition: [
+        app,
+        "toZip",
+      ],
+    },
+    toState: {
+      propDefinition: [
+        app,
+        "toState",
+      ],
+    },
+    amount: {
+      propDefinition: [
+        app,
+        "amount",
+      ],
+    },
+    shipping: {
+      propDefinition: [
+        app,
+        "shipping",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.app.calculateSalesTax({
+      $,
+      data: {
+        exemption_type: this.exemptionType,
+        from_country: this.fromCountry,
+        from_zip: this.fromZip,
+        from_state: this.fromState,
+        from_city: this.fromCity,
+        from_street: this.fromStreet,
+        to_country: this.toCountry,
+        to_zip: this.toZip,
+        to_state: this.toState,
+        amount: this.amount,
+        shipping: this.shipping,
+      },
+    });
+    $.export("$summary", `Successfully calculated sales tax. Amount to collect: ${response.tax.amount_to_collect}`);
+    return response;
+  },
+};

package/actions/create-customer/create-customer.mjs

@@ -0,0 +1,82 @@
+import app from "../../taxjar.app.mjs";
+
+export default {
+  key: "taxjar-create-customer",
+  name: "Create Customer",
+  description: "Creates a new customer at TaxJar. [See the documentation](https://developers.taxjar.com/api/reference/#post-create-a-customer)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    app,
+    customerId: {
+      propDefinition: [
+        app,
+        "customerId",
+      ],
+    },
+    exemptionType: {
+      propDefinition: [
+        app,
+        "exemptionType",
+      ],
+    },
+    name: {
+      propDefinition: [
+        app,
+        "name",
+      ],
+    },
+    country: {
+      propDefinition: [
+        app,
+        "country",
+      ],
+      optional: true,
+    },
+    state: {
+      propDefinition: [
+        app,
+        "state",
+      ],
+      optional: true,
+    },
+    zip: {
+      propDefinition: [
+        app,
+        "zip",
+      ],
+      optional: true,
+    },
+    city: {
+      propDefinition: [
+        app,
+        "city",
+      ],
+      optional: true,
+    },
+    street: {
+      propDefinition: [
+        app,
+        "street",
+      ],
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const response = await this.app.createCustomer({
+      $,
+      data: {
+        customer_id: this.customerId,
+        exemption_type: this.exemptionType,
+        name: this.name,
+        country: this.country,
+        state: this.state,
+        zip: this.zip,
+        city: this.city,
+        street: this.street,
+      },
+    });
+    $.export("$summary", `Successfully created customer with ID ${this.customerId}`);
+    return response;
+  },
+};

package/actions/validate-address/validate-address.mjs

@@ -0,0 +1,62 @@
+import app from "../../taxjar.app.mjs";
+
+export default {
+  key: "taxjar-validate-address",
+  name: "Validate Address",
+  description: "Validates a customer address and returns back a collection of address matches. [See the documentation](https://developers.taxjar.com/api/reference/#post-validate-an-address)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    app,
+    country: {
+      propDefinition: [
+        app,
+        "country",
+      ],
+      description: "The two-letter ISO country code, i.e.: `US`. At this time only US addresses can be validated",
+      optional: true,
+    },
+    state: {
+      propDefinition: [
+        app,
+        "state",
+      ],
+      optional: true,
+    },
+    zip: {
+      propDefinition: [
+        app,
+        "zip",
+      ],
+      optional: true,
+    },
+    city: {
+      propDefinition: [
+        app,
+        "city",
+      ],
+      optional: true,
+    },
+    street: {
+      propDefinition: [
+        app,
+        "street",
+      ],
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const response = await this.app.validateAddress({
+      $,
+      data: {
+        country: this.country,
+        state: this.state,
+        zip: this.zip,
+        city: this.city,
+        street: this.street,
+      },
+    });
+    $.export("$summary", `Successfully sent the request and found ${response.addresses.length} address matches`);
+    return response;
+  },
+};

package/common/constants.mjs

@@ -0,0 +1,8 @@
+export default {
+  EXEMPTION_TYPES: [
+    "wholesale",
+    "government",
+    "other",
+    "non_exempt",
+  ],
+};

package/package.json

@@ -1,18 +1,18 @@
 {
   "name": "@pipedream/taxjar",
-  "version": "0.0.2",
+  "version": "0.1.0",
   "description": "Pipedream TaxJar Components",
-  "main": "dist/app/taxjar.app.mjs",
+  "main": "taxjar.app.mjs",
   "keywords": [
     "pipedream",
     "taxjar"
   ],
-  "files": [
-    "dist"
-  ],
   "homepage": "https://pipedream.com/apps/taxjar",
   "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@pipedream/platform": "^3.0.3"
   }
 }

package/taxjar.app.mjs

@@ -0,0 +1,142 @@
+import { axios } from "@pipedream/platform";
+import constants from "./common/constants.mjs";
+
+export default {
+  type: "app",
+  app: "taxjar",
+  propDefinitions: {
+    customerId: {
+      type: "string",
+      label: "Customer ID",
+      description: "Unique identifier for the customer",
+    },
+    exemptionType: {
+      type: "string",
+      label: "Exemption Type",
+      description: "The type of tax exemption for the customer",
+      options: constants.EXEMPTION_TYPES,
+    },
+    name: {
+      type: "string",
+      label: "Name",
+      description: "The name of the customer",
+    },
+    country: {
+      type: "string",
+      label: "Country",
+      description: "The two-letter ISO country code, i.e.: `US`",
+    },
+    state: {
+      type: "string",
+      label: "State",
+      description: "The two-letter ISO state code, i.e.: `CA`",
+    },
+    zip: {
+      type: "string",
+      label: "Zip",
+      description: "The ZIP code of the customer's primary address, i.e.: `92093`",
+    },
+    city: {
+      type: "string",
+      label: "City",
+      description: "The city of the customer's primary address, i.e.: `La Jolla`",
+    },
+    street: {
+      type: "string",
+      label: "Street",
+      description: "The street of the customer's primary address, i.e.: `9500 Gilman Drive`",
+    },
+    fromCountry: {
+      type: "string",
+      label: "From Country",
+      description: "The two-letter ISO country code of the country where the order shipped from, i.e.: `US`",
+    },
+    fromZip: {
+      type: "string",
+      label: "From Zip",
+      description: "The postal code where the order shipped from, i.e.: `92093`",
+    },
+    fromState: {
+      type: "string",
+      label: "From State",
+      description: "The two-letter ISO state code where the order shipped from, i.e.: `CA`",
+    },
+    fromCity: {
+      type: "string",
+      label: "From City",
+      description: "The city where the order shipped from, i.e.: `La Jolla`",
+    },
+    fromStreet: {
+      type: "string",
+      label: "From Street",
+      description: "The street address where the order shipped from, i.e.: `9500 Gilman Drive`",
+    },
+    toCountry: {
+      type: "string",
+      label: "To Country",
+      description: "The two-letter ISO country code of the country where the order shipped to, i.e.: `US`",
+    },
+    toZip: {
+      type: "string",
+      label: "To Zip",
+      description: "The postal code where the order shipped to, i.e.: `92093`",
+    },
+    toState: {
+      type: "string",
+      label: "To State",
+      description: "The two-letter ISO state code where the order shipped yo, i.e.: `CA`",
+    },
+    amount: {
+      type: "string",
+      label: "Amount",
+      description: "Total amount of the order, excluding shipping",
+    },
+    shipping: {
+      type: "string",
+      label: "Shipping",
+      description: "Total amount of shipping for the order",
+    },
+  },
+  methods: {
+    _baseUrl() {
+      return "https://api.taxjar.com/v2";
+    },
+    async _makeRequest(opts = {}) {
+      const {
+        $ = this,
+        path,
+        headers,
+        ...otherOpts
+      } = opts;
+      return axios($, {
+        ...otherOpts,
+        url: this._baseUrl() + path,
+        headers: {
+          Authorization: `Bearer ${this.$auth.api_key}`,
+          ...headers,
+        },
+      });
+    },
+    async createCustomer(args = {}) {
+      return this._makeRequest({
+        path: "/customers",
+        method: "post",
+        ...args,
+      });
+    },
+    async calculateSalesTax(args = {}) {
+      return this._makeRequest({
+        path: "/taxes",
+        method: "post",
+        ...args,
+      });
+    },
+    async validateAddress(args = {}) {
+      return this._makeRequest({
+        path: "/addresses/validate",
+        method: "post",
+        ...args,
+      });
+    },
+  },
+};