@pipedream/shift4 0.0.1 → 0.1.0

package/actions/create-charge/create-charge.mjs

@@ -0,0 +1,129 @@
+import { ConfigurationError } from "@pipedream/platform";
+import { TYPE_OPTIONS } from "../../common/constants.mjs";
+import { parseObject } from "../../common/utils.mjs";
+import shift4 from "../../shift4.app.mjs";
+
+export default {
+  key: "shift4-create-charge",
+  name: "Create Charge",
+  description: "Creates a new charge object. [See the documentation](https://dev.shift4.com/docs/api#charges-create-a-new-charge)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    shift4,
+    customerId: {
+      propDefinition: [
+        shift4,
+        "customerId",
+      ],
+      optional: true,
+    },
+    amount: {
+      propDefinition: [
+        shift4,
+        "amount",
+      ],
+    },
+    currency: {
+      propDefinition: [
+        shift4,
+        "currency",
+      ],
+    },
+    type: {
+      type: "string",
+      label: "Type",
+      description: "The type of the charge.",
+      options: TYPE_OPTIONS,
+      optional: true,
+    },
+    description: {
+      propDefinition: [
+        shift4,
+        "description",
+      ],
+      optional: true,
+    },
+    card: {
+      propDefinition: [
+        shift4,
+        "card",
+      ],
+      optional: true,
+    },
+    paymentMethod: {
+      type: "string",
+      label: "Payment Method",
+      description: "Payment method details or identifier.",
+      optional: true,
+    },
+    flow: {
+      type: "object",
+      label: "Flow",
+      description: "Details specific to the payment method charge.",
+      optional: true,
+    },
+    captured: {
+      type: "boolean",
+      label: "Captured",
+      description: "Whether this charge should be immediately captured.",
+      optional: true,
+    },
+    shipping: {
+      type: "object",
+      label: "Shipping",
+      description: "Shipping details. Sample object: `{name: \"string\", address: {line1: \"string\", line2: \"string\", zip: \"string\", city: \"string\", state: \"string\", country: \"country represented as two-letter ISO country code\"}}`",
+      optional: true,
+    },
+    billing: {
+      type: "object",
+      label: "Billing",
+      description: "Billing details. Sample object: `{name: \"string\", email: \"string\", address: {line1: \"string\", line2: \"string\", zip: \"string\", city: \"string\", state: \"string\", country: \"country represented as two-letter ISO country code\"}, vat: \"string\"}`",
+      optional: true,
+    },
+    threeDSecure: {
+      type: "object",
+      label: "3D Secure",
+      description: "3D Secure options.",
+      optional: true,
+    },
+    metadata: {
+      propDefinition: [
+        shift4,
+        "metadata",
+      ],
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    if (!this.customerId && !this.card && !this.paymentMethod) {
+      throw new ConfigurationError("Either **CustomerId**, **Card** or **PaymentMethod** is required!");
+    }
+
+    try {
+      const response = await this.shift4.createCharge({
+        $,
+        data: {
+          amount: this.amount,
+          currency: this.currency,
+          type: this.type,
+          description: this.description,
+          customerId: this.customerId,
+          card: this.card && parseObject(this.card),
+          paymentMethod: this.paymentMethod && parseObject(this.paymentMethod),
+          flow: this.flow && parseObject(this.flow),
+          captured: this.captured,
+          shipping: this.shipping && parseObject(this.shipping),
+          billing: this.billing && parseObject(this.billing),
+          threeDSecure: this.threeDSecure && parseObject(this.threeDSecure),
+          metadata: this.metadata && parseObject(this.metadata),
+        },
+      });
+
+      $.export("$summary", `Successfully created charge with Id: ${response.id}`);
+      return response;
+    } catch ({ message }) {
+      throw new ConfigurationError(JSON.parse(message).error.message);
+    }
+  },
+};

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

@@ -0,0 +1,52 @@
+import { parseObject } from "../../common/utils.mjs";
+import shift4 from "../../shift4.app.mjs";
+
+export default {
+  key: "shift4-create-customer",
+  name: "Create Customer",
+  description: "Creates a new customer object. [See the documentation](https://dev.shift4.com/docs/api#customers-create-a-customer)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    shift4,
+    email: {
+      type: "string",
+      label: "Email",
+      description: "The email address of the customer.",
+    },
+    description: {
+      type: "string",
+      label: "Description",
+      description: "A description for the customer.",
+      optional: true,
+    },
+    card: {
+      propDefinition: [
+        shift4,
+        "card",
+      ],
+      optional: true,
+    },
+    metadata: {
+      propDefinition: [
+        shift4,
+        "metadata",
+      ],
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const response = await this.shift4.createCustomer({
+      $,
+      data: {
+        email: this.email,
+        description: this.description,
+        card: this.card && parseObject(this.card),
+        metadata: this.metadata && parseObject(this.metadata),
+      },
+    });
+
+    $.export("$summary", `Successfully created customer with Id: ${response.id}`);
+    return response;
+  },
+};

package/actions/create-plan/create-plan.mjs

@@ -0,0 +1,93 @@
+import { parseObject } from "../../common/utils.mjs";
+import shift4 from "../../shift4.app.mjs";
+
+export default {
+  key: "shift4-create-plan",
+  name: "Create Plan",
+  description: "Creates a new plan object. [See the documentation](https://dev.shift4.com/docs/api#plan-create)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    shift4,
+    amount: {
+      propDefinition: [
+        shift4,
+        "amount",
+      ],
+      description: "Subscription charge amount in minor units of a given currency. For example, 10€ is represented as \"1000\", and 10¥ is represented as \"10\".",
+    },
+    currency: {
+      propDefinition: [
+        shift4,
+        "currency",
+      ],
+      description: "Subscription charge currency represented as a three-letter ISO currency code.",
+    },
+    interval: {
+      type: "string",
+      label: "Interval",
+      description: "The interval at which a plan is set to recur. Could be 'day', 'week', 'month', or 'year'.",
+      options: [
+        "day",
+        "week",
+        "month",
+        "year",
+      ],
+    },
+    name: {
+      type: "string",
+      label: "Name",
+      description: "The name of the plan.",
+    },
+    intervalCount: {
+      type: "integer",
+      label: "Interval Count",
+      description: "The number of intervals between each subscription billing. For example, if `interval`=`month` and `intervalCount`=`3`, subscriptions created with this plan will be billed every 3 months.",
+      optional: true,
+    },
+    billingCycles: {
+      type: "integer",
+      label: "Billing Cycles",
+      description: "The number of billing cycles for the payment period. If left blank, the subscription will continue indefinitely.",
+      optional: true,
+    },
+    trialPeriodDays: {
+      type: "integer",
+      label: "Trial Period Days",
+      description: "The number of trial period days granted when subscribing a customer to this plan.",
+      optional: true,
+    },
+    recursTo: {
+      propDefinition: [
+        shift4,
+        "recursTo",
+      ],
+      optional: true,
+    },
+    metadata: {
+      propDefinition: [
+        shift4,
+        "metadata",
+      ],
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const {
+      shift4,
+      metadata,
+      ...data
+    } = this;
+
+    const response = await shift4.createPlan({
+      $,
+      data: {
+        ...data,
+        metadata: metadata && parseObject(metadata),
+      },
+    });
+
+    $.export("$summary", `Successfully created plan with Id: '${response.id}'`);
+    return response;
+  },
+};

package/actions/create-token/create-token.mjs

@@ -0,0 +1,102 @@
+import shift4 from "../../shift4.app.mjs";
+
+export default {
+  key: "shift4-create-token",
+  name: "Create Token",
+  description: "Creates a new token object. [See the documentation](https://dev.shift4.com/docs/api#token-create)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    shift4,
+    number: {
+      type: "string",
+      label: "Card Number",
+      description: "Card number without any separators.",
+    },
+    expMonth: {
+      type: "string",
+      label: "Expiration Month",
+      description: "Card expiration month.",
+    },
+    expYear: {
+      type: "string",
+      label: "Expiration Year",
+      description: "Card expiration year.",
+    },
+    cvc: {
+      type: "string",
+      label: "CVC",
+      description: "Card security code.",
+    },
+    cardholderName: {
+      type: "string",
+      label: "Cardholder Name",
+      description: "Name of the cardholder.",
+      optional: true,
+    },
+    addressLine1: {
+      type: "string",
+      label: "Address Line 1",
+      description: "First line of the address.",
+      optional: true,
+    },
+    addressLine2: {
+      type: "string",
+      label: "Address Line 2",
+      description: "Second line of the address.",
+      optional: true,
+    },
+    addressCity: {
+      type: "string",
+      label: "City",
+      description: "City of the address.",
+      optional: true,
+    },
+    addressState: {
+      type: "string",
+      label: "State",
+      description: "State of the address.",
+      optional: true,
+    },
+    addressZip: {
+      type: "string",
+      label: "Zip Code",
+      description: "Zip code of the address.",
+      optional: true,
+    },
+    addressCountry: {
+      type: "string",
+      label: "Country",
+      description: "Country represented as a three-letter ISO country code.",
+      optional: true,
+    },
+    fraudCheckData: {
+      type: "object",
+      label: "Fraud Check Data",
+      description: "Additional data used for fraud protection.",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const {
+      shift4,
+      fraudCheckData,
+      ...data
+    } = this;
+
+    const fraudCheck = fraudCheckData
+      ? JSON.stringify(fraudCheckData)
+      : undefined;
+
+    const response = await shift4.createToken({
+      $,
+      data: {
+        ...data,
+        fraudCheckData: fraudCheck,
+      },
+    });
+
+    $.export("$summary", `Successfully created token with Id: '${response.id}'`);
+    return response;
+  },
+};

package/common/constants.mjs

@@ -0,0 +1,20 @@
+export const LIMIT = 100;
+
+export const TYPE_OPTIONS = [
+  {
+    label: "First Recurring",
+    value: "first_recurring",
+  },
+  {
+    label: "Subsequent Recurring",
+    value: "subsequent_recurring",
+  },
+  {
+    label: "Merchant Initiated",
+    value: "merchant_initiated",
+  },
+  {
+    label: "Customer Initiated",
+    value: "customer_initiated",
+  },
+];

package/common/utils.mjs

@@ -0,0 +1,22 @@
+export const parseObject = (obj) => {
+  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;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/shift4",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "Pipedream Shift4 Components",
   "main": "shift4.app.mjs",
   "keywords": [
@@ -11,5 +11,8 @@
   "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@pipedream/platform": "^1.5.1"
   }
 }

package/shift4.app.mjs

@@ -1,11 +1,191 @@
+import { axios } from "@pipedream/platform";
+import { LIMIT } from "./common/constants.mjs";
+
 export default {
   type: "app",
   app: "shift4",
-  propDefinitions: {},
+  propDefinitions: {
+    amount: {
+      type: "integer",
+      label: "Amount",
+      description: "The charge amount in minor units of a given currency. For example, 10€ is represented as '1000'.",
+    },
+    card: {
+      type: "string",
+      label: "Card",
+      description: "Card token, card details or card identifier.",
+    },
+    currency: {
+      type: "string",
+      label: "Currency",
+      description: "The charge currency represented as a three-letter ISO currency code.",
+    },
+    customerId: {
+      type: "string",
+      label: "Customer ID",
+      description: "Identifier of the customer that will be associated with this charge.",
+      async options({ prevContext }) {
+        const { list } = await this.listCustomers({
+          params: {
+            limit: LIMIT,
+            startingAfterId: prevContext.lastId,
+          },
+        });
+
+        return {
+          options: list.map(({
+            id: value, email: label,
+          }) => ({
+            label,
+            value,
+          })),
+          context: {
+            lastId: list.length
+              ? list[list.length - 1].id
+              : null,
+          },
+        };
+      },
+    },
+    description: {
+      type: "string",
+      label: "Description",
+      description: "A description for the charge.",
+      optional: true,
+    },
+    metadata: {
+      type: "object",
+      label: "Metadata",
+      description: "Metadata object.",
+    },
+    orderIdentifier: {
+      type: "string",
+      label: "Order Identifier",
+      description: "The identifier of the order related to the charge that was updated.",
+    },
+    recursTo: {
+      type: "string",
+      label: "Recurs To",
+      description: "The plan to which this plan will recur after the billing cycles have completed.",
+      async options({ prevContext }) {
+        const { list } = await this.listPlans({
+          params: {
+            limit: LIMIT,
+            startingAfterId: prevContext.lastId,
+          },
+        });
+
+        return {
+          options: list.map(({
+            id: value, name: label,
+          }) => ({
+            label,
+            value,
+          })),
+          context: {
+            lastId: list.length
+              ? list[list.length - 1].id
+              : null,
+          },
+        };
+      },
+    },
+  },
   methods: {
-    // this.$auth contains connected account data
-    authKeys() {
-      console.log(Object.keys(this.$auth));
+    _baseUrl() {
+      return "https://api.shift4.com";
+    },
+    _auth() {
+      return {
+        username: `${this.$auth.api_key_secret}`,
+        password: "",
+      };
+    },
+    _makeRequest({
+      $ = this, path, ...otherOpts
+    }) {
+      return axios($, {
+        ...otherOpts,
+        url: this._baseUrl() + path,
+        auth: this._auth(),
+      });
+    },
+    createCharge(opts = {}) {
+      return this._makeRequest({
+        method: "POST",
+        path: "/charges",
+        ...opts,
+      });
+    },
+    createPlan(opts = {}) {
+      return this._makeRequest({
+        method: "POST",
+        path: "/plans",
+        ...opts,
+      });
+    },
+    createToken(opts = {}) {
+      return this._makeRequest({
+        method: "POST",
+        path: "/tokens",
+        ...opts,
+      });
+    },
+    createCustomer(opts = {}) {
+      return this._makeRequest({
+        method: "POST",
+        path: "/customers",
+        ...opts,
+      });
+    },
+    listCustomers(opts = {}) {
+      return this._makeRequest({
+        path: "/customers",
+        ...opts,
+      });
+    },
+    listEvents(opts = {}) {
+      return this._makeRequest({
+        path: "/events",
+        ...opts,
+      });
+    },
+    listPlans(opts = {}) {
+      return this._makeRequest({
+        path: "/plans",
+        ...opts,
+      });
+    },
+    async *paginate({
+      fn, params = {}, maxResults = null, filterTypes, ...opts
+    }) {
+      let hasMore = false;
+      let count = 0;
+      let lastId = null;
+
+      do {
+        params.limit = LIMIT;
+        params.startingAfterId = lastId;
+        const {
+          list,
+          hasMore: hasMoreItems,
+        } = await fn({
+          params,
+          ...opts,
+        });
+        for (const d of list) {
+          if (filterTypes.includes(d.type)) {
+            yield d;
+
+            if (maxResults && ++count === maxResults) {
+              return count;
+            }
+          }
+        }
+
+        hasMore = hasMoreItems;
+
+      } while (hasMore);
     },
   },
-};
+};

package/sources/charge-updated/charge-updated.mjs

@@ -0,0 +1,34 @@
+import common from "../common/base.mjs";
+import sampleEmit from "./test-event.mjs";
+
+export default {
+  ...common,
+  key: "shift4-charge-updated",
+  name: "New Charge Updated",
+  description: "Emit new event when a charge object is updated.",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getFilterTypes() {
+      return [
+        "CHARGE_SUCCEEDED",
+        "CHARGE_FAILED",
+        "CHARGE_UPDATED",
+        "CHARGE_CAPTURED",
+        "CHARGE_REFUNDED",
+        "CHARGE_DISPUTE_CREATED",
+        "CHARGE_DISPUTE_UPDATED",
+        "CHARGE_DISPUTE_WON",
+        "CHARGE_DISPUTE_LOST",
+        "CHARGE_DISPUTE_FUNDS_WITHDRAWN",
+        "CHARGE_DISPUTE_FUNDS_RESTORED",
+      ];
+    },
+    getSummary(item) {
+      return `New charge updated event with Id: ${item.id}`;
+    },
+  },
+  sampleEmit,
+};

package/sources/charge-updated/test-event.mjs

@@ -0,0 +1,49 @@
+export default {
+  "id": "event_1234567890",
+  "created": 1234567890,
+  "objectType": "event",
+  "type": "CHARGE_UPDATED",
+  "data": {
+    "id": "char_1234567890",
+    "created": 1234567890,
+    "objectType": "charge",
+    "amount": 2000,
+    "amountRefunded": 0,
+    "currency": "USD",
+    "card": {
+      "id": "card_1234567890",
+      "created": 1234567890,
+      "objectType": "card",
+      "first6": "401200",
+      "last4": "0007",
+      "fingerprint": "BMophBOvfsd234h",
+      "expMonth": "07",
+      "expYear": "2027",
+      "cardholderName": "",
+      "customerId": "cust_1234567890",
+      "brand": "Visa",
+      "type": "Credit Card",
+      "country": "CH",
+      "addressLine1": "",
+      "addressLine2": "",
+      "addressCity": "",
+      "addressState": "",
+      "addressZip": "",
+      "addressCountry": "",
+      "issuer": "SHIFT4 TEST"
+    },
+    "customerId": "cust_1234567890",
+    "captured": true,
+    "refunded": false,
+    "disputed": false,
+    "fraudDetails": {
+      "status": "safe",
+      "score": 0
+    },
+    "avsCheck": {
+      "result": "unavailable"
+    },
+    "status": "successful",
+    "clientObjectId": "client_char_1234567890"
+  }
+}

package/sources/common/base.mjs

@@ -0,0 +1,63 @@
+import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
+import shift4 from "../../shift4.app.mjs";
+
+export default {
+  props: {
+    shift4,
+    db: "$.service.db",
+    timer: {
+      type: "$.interface.timer",
+      default: {
+        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
+      },
+    },
+  },
+  methods: {
+    _getLastDate() {
+      return this.db.get("lastDate") || 0;
+    },
+    _setLastDate(created) {
+      this.db.set("lastDate", created);
+    },
+    generateMeta(item) {
+      return {
+        id: item.id,
+        summary: this.getSummary(item),
+        ts: item.created,
+      };
+    },
+    async startEvent(maxResults = 0) {
+      const lastDate = this._getLastDate();
+
+      const data = this.shift4.paginate({
+        fn: this.shift4.listEvents,
+        maxResults,
+        params: {
+          created: {
+            gt: lastDate,
+          },
+        },
+        filterTypes: this.getFilterTypes(),
+      });
+
+      const responseArray = [];
+      for await (const item of data) {
+        responseArray.push(item);
+      }
+
+      if (responseArray.length) this._setLastDate(responseArray[0].created);
+
+      for (const item of responseArray.reverse()) {
+        this.$emit(item, this.generateMeta(item));
+      }
+    },
+  },
+  hooks: {
+    async deploy() {
+      await this.startEvent(25);
+    },
+  },
+  async run() {
+    await this.startEvent();
+  },
+};

package/sources/new-charge/new-charge.mjs

@@ -0,0 +1,24 @@
+import common from "../common/base.mjs";
+import sampleEmit from "./test-event.mjs";
+
+export default {
+  ...common,
+  key: "shift4-new-charge",
+  name: "New Charge",
+  description: "Emit new event when a new charge is successfully created.",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getFilterTypes() {
+      return [
+        "CHARGE_SUCCEEDED",
+      ];
+    },
+    getSummary(item) {
+      return `New charge created event with Id: ${item.id}`;
+    },
+  },
+  sampleEmit,
+};

package/sources/new-charge/test-event.mjs

@@ -0,0 +1,46 @@
+export default {
+  "id": "event_1234567890",
+  "created": 1234567890,
+  "objectType": "event",
+  "type": "CHARGE_SUCCEEDED",
+  "data": {
+    "id": "char_1234567890",
+    "created": 1234567890,
+    "objectType": "charge",
+    "amount": 2000,
+    "amountRefunded": 0,
+    "currency": "USD",
+    "card": {
+      "id": "card_1234567890",
+      "created": 1234567890,
+      "objectType": "card",
+      "first6": "401200",
+      "last4": "0007",
+      "fingerprint": "BMophBO0Q123564mrty2VT",
+      "expMonth": "07",
+      "expYear": "2027",
+      "cardholderName": "",
+      "customerId": "cust_1234567890",
+      "brand": "Visa",
+      "type": "Credit Card",
+      "country": "CH",
+      "addressLine1": "",
+      "addressLine2": "",
+      "addressCity": "",
+      "addressState": "",
+      "addressZip": "",
+      "addressCountry": "",
+      "issuer": "SHIFT4 TEST"
+    },
+    "customerId": "cust_1234567890",
+    "captured": true,
+    "refunded": false,
+    "disputed": false,
+    "avsCheck": {
+      "result": "unavailable"
+    },
+    "status": "successful",
+    "clientObjectId": "client_char_1234567890"
+  },
+  "log": "log_1234567890"
+}

package/sources/new-customer/new-customer.mjs

@@ -0,0 +1,24 @@
+import common from "../common/base.mjs";
+import sampleEmit from "./test-event.mjs";
+
+export default {
+  ...common,
+  key: "shift4-new-customer",
+  name: "New Customer",
+  description: "Emit new event when a new customer is created.",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getFilterTypes() {
+      return [
+        "CUSTOMER_CREATED",
+      ];
+    },
+    getSummary(item) {
+      return `New customer created event with Id: ${item.id}`;
+    },
+  },
+  sampleEmit,
+};

package/sources/new-customer/test-event.mjs

@@ -0,0 +1,15 @@
+export default {
+  "id": "event_1234567890",
+  "created": 1234567890,
+  "objectType": "event",
+  "type": "CUSTOMER_CREATED",
+  "data": {
+    "id": "cust_1234567890",
+    "created": 1234567890,
+    "objectType": "customer",
+    "email": "email@test.com",
+    "description": "description",
+    "metadata": {}
+  },
+  "log": "log_1234567890"
+}