@pipedream/billsby 0.0.3 → 0.1.0

package/actions/add-feature-tags/add-feature-tags.mjs

@@ -0,0 +1,39 @@
+import billsby from "../../billsby.app.mjs";
+
+export default {
+  key: "billsby-add-feature-tags",
+  name: "Add Feature Tags",
+  description: "Add feature tags to a subscription. [See the documentation](https://support.billsby.com/reference/post-subscription-tags)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  props: {
+    billsby,
+    subscriptionIds: {
+      propDefinition: [
+        billsby,
+        "subscriptionIds",
+      ],
+    },
+    tagNames: {
+      type: "string[]",
+      label: "Tag Names",
+      description: "The names of the tags to add to the subscription",
+    },
+  },
+  async run({ $ }) {
+    const response = await this.billsby.addFeatureTags({
+      $,
+      data: {
+        subscriptionUniqueIds: this.subscriptionIds,
+        tagNames: this.tagNames,
+      },
+    });
+    $.export("$summary", "Successfully added feature tags to subscription");
+    return response;
+  },
+};

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

@@ -0,0 +1,51 @@
+import billsby from "../../billsby.app.mjs";
+
+export default {
+  key: "billsby-create-one-time-charge",
+  name: "Create One-Time Charge",
+  description: "Create a one-time charge for a customer. [See the documentation](https://support.billsby.com/reference/create-a-one-time-charge)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  props: {
+    billsby,
+    customerId: {
+      propDefinition: [
+        billsby,
+        "customerId",
+      ],
+    },
+    currencyCode: {
+      type: "string",
+      label: "Currency Code",
+      description: "The code for the currency of the one-time charge",
+    },
+    amount: {
+      type: "integer",
+      label: "Amount",
+      description: "The amount of the one-time charge",
+    },
+    description: {
+      type: "string",
+      label: "Description",
+      description: "The description for the one-time charge",
+    },
+  },
+  async run({ $ }) {
+    const response = await this.billsby.createOneTimeCharge({
+      $,
+      customerId: this.customerId,
+      data: {
+        currencyCode: this.currencyCode,
+        amount: this.amount,
+        description: this.description,
+      },
+    });
+    $.export("$summary", "Successfully created one-time charge");
+    return response;
+  },
+};

package/actions/update-customer-details/update-customer-details.mjs

@@ -0,0 +1,125 @@
+import billsby from "../../billsby.app.mjs";
+
+export default {
+  key: "billsby-update-customer-details",
+  name: "Update Customer Details",
+  description: "Update the details of a customer. [See the documentation](https://support.billsby.com/reference/put-customer)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: true,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  props: {
+    billsby,
+    customerId: {
+      propDefinition: [
+        billsby,
+        "customerId",
+      ],
+    },
+    firstName: {
+      type: "string",
+      label: "First Name",
+      description: "The first name of the customer",
+      optional: true,
+    },
+    lastName: {
+      type: "string",
+      label: "Last Name",
+      description: "The last name of the customer",
+      optional: true,
+    },
+    email: {
+      type: "string",
+      label: "Email",
+      description: "The email of the customer",
+      optional: true,
+    },
+    addressLine1: {
+      type: "string",
+      label: "Address Line 1",
+      description: "The first line of the address of the customer",
+      optional: true,
+    },
+    addressLine2: {
+      type: "string",
+      label: "Address Line 2",
+      description: "The second line of the address of the customer",
+      optional: true,
+    },
+    city: {
+      type: "string",
+      label: "City",
+      description: "The city of the address of the customer",
+      optional: true,
+    },
+    state: {
+      type: "string",
+      label: "State",
+      description: "The state of the address of the customer",
+      optional: true,
+    },
+    postCode: {
+      type: "string",
+      label: "Post Code",
+      description: "The postal code of the address of the customer",
+      optional: true,
+    },
+    country: {
+      type: "string",
+      label: "Country",
+      description: "The country of the address of the customer",
+      optional: true,
+    },
+    phoneNumberDialCountry: {
+      type: "string",
+      label: "Phone Number Dial Country",
+      description: "The customers phone number dial country (i.e. \"UK\")",
+      optional: true,
+    },
+    phoneNumberDialCode: {
+      type: "string",
+      label: "Phone Number Dial Code",
+      description: "The customer phone number dial code",
+      optional: true,
+    },
+    phoneNumber: {
+      type: "string",
+      label: "Phone Number",
+      description: "The customer phone number",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const customer = await this.billsby.getCustomer({
+      $,
+      customerId: this.customerId,
+    });
+
+    const response = await this.billsby.updateCustomer({
+      $,
+      customerId: this.customerId,
+      data: {
+        firstName: this.firstName || customer.firstName,
+        lastName: this.lastName || customer.lastName,
+        email: this.email || customer.email,
+        phoneNumberDialCountry: this.phoneNumberDialCountry || customer.phoneNumberDialCountry,
+        phoneNumberDialCode: this.phoneNumberDialCode || customer.phoneNumberDialCode,
+        phoneNumber: this.phoneNumber || customer.phoneNumber,
+        billingAddress: {
+          addressLine1: this.addressLine1 || customer.billingAddress.addressLine1,
+          addressLine2: this.addressLine2 || customer.billingAddress.addressLine2,
+          city: this.city || customer.billingAddress.city,
+          state: this.state || customer.billingAddress.state,
+          postCode: this.postCode || customer.billingAddress.postCode,
+          country: this.country || customer.billingAddress.country,
+        },
+      },
+    });
+
+    $.export("$summary", "Successfully updated customer details");
+    return response;
+  },
+};

package/billsby.app.mjs

@@ -1,11 +1,143 @@
+import { axios } from "@pipedream/platform";
+
 export default {
   type: "app",
   app: "billsby",
-  propDefinitions: {},
+  propDefinitions: {
+    customerId: {
+      type: "string",
+      label: "Customer ID",
+      description: "The ID of the customer",
+      useQuery: true,
+      async options({
+        page, query,
+      }) {
+        const { results } = await this.listCustomers({
+          params: {
+            page: page + 1,
+            pageSize: 50,
+            search: query,
+          },
+        });
+        return results?.map(({
+          customerUniqueId: value, firstName, lastName,
+        }) => ({
+          label: `${firstName} ${lastName}`,
+          value,
+        })) || [];
+      },
+    },
+    subscriptionIds: {
+      type: "string[]",
+      label: "Subscription IDs",
+      description: "The IDs of the subscriptions",
+      async options({ page }) {
+        const { results } = await this.listSubscriptions({
+          params: {
+            page: page + 1,
+            pageSize: 50,
+          },
+        });
+        return results?.map(({
+          subscriptionUniqueId: value, customerFullname, productName,
+        }) => ({
+          label: `${customerFullname} - ${productName}`,
+          value,
+        })) || [];
+      },
+    },
+  },
   methods: {
-    // this.$auth contains connected account data
-    authKeys() {
-      console.log(Object.keys(this.$auth));
+    _baseUrl() {
+      return `https://public.billsby.com/api/v1/rest/core/${this.$auth.company_domain}`;
+    },
+    _makeRequest({
+      $ = this, path, ...opts
+    }) {
+      return axios($, {
+        url: `${this._baseUrl()}${path}`,
+        headers: {
+          ApiKey: this.$auth.api_key,
+        },
+        ...opts,
+      });
+    },
+    getCustomer({
+      customerId, ...opts
+    }) {
+      return this._makeRequest({
+        path: `/customers/${customerId}`,
+        ...opts,
+      });
+    },
+    listCustomers(opts = {}) {
+      return this._makeRequest({
+        path: "/customers",
+        ...opts,
+      });
+    },
+    listSubscriptions(opts = {}) {
+      return this._makeRequest({
+        path: "/subscriptions",
+        ...opts,
+      });
+    },
+    listCompanyInvoices(opts = {}) {
+      return this._makeRequest({
+        path: "/companies/invoices",
+        ...opts,
+      });
+    },
+    createOneTimeCharge({
+      customerId, ...opts
+    }) {
+      return this._makeRequest({
+        method: "POST",
+        path: `/customers/${customerId}/invoices`,
+        ...opts,
+      });
+    },
+    updateCustomer({
+      customerId, ...opts
+    }) {
+      return this._makeRequest({
+        method: "PUT",
+        path: `/customers/${customerId}`,
+        ...opts,
+      });
+    },
+    addFeatureTags(opts = {}) {
+      return this._makeRequest({
+        method: "POST",
+        path: "/subscriptions/tags",
+        ...opts,
+      });
+    },
+    async *paginate({
+      fn, params, max,
+    }) {
+      params = {
+        ...params,
+        page: 1,
+        pageSize: 100,
+      };
+      let total, count = 0;
+      do {
+        const { results } = await fn({
+          params,
+        });
+        if (!results?.length) {
+          return;
+        }
+        for (const item of results) {
+          yield item;
+          if (max && ++count >= max) {
+            return;
+          }
+        }
+        total = results.length;
+        params.page++;
+      } while (total === params.pageSize);
     },
   },
 };

package/package.json

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

package/sources/common/base-polling.mjs

@@ -0,0 +1,75 @@
+import billsby from "../../billsby.app.mjs";
+import {
+  DEFAULT_POLLING_SOURCE_TIMER_INTERVAL, ConfigurationError,
+} from "@pipedream/platform";
+
+export default {
+  props: {
+    billsby,
+    db: "$.service.db",
+    timer: {
+      type: "$.interface.timer",
+      default: {
+        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
+      },
+    },
+  },
+  methods: {
+    _getLastId() {
+      return this.db.get("lastId") || 0;
+    },
+    _setLastId(lastId) {
+      this.db.set("lastId", lastId);
+    },
+    getParams() {
+      return {};
+    },
+    getTsField() {
+      return "createdOn";
+    },
+    async processEvents(max) {
+      const lastId = this._getLastId();
+
+      const results = this.billsby.paginate({
+        fn: this.getResourceFn(),
+        params: this.getParams(),
+        max,
+      });
+
+      let items = [];
+      for await (const item of results) {
+        const ts = Date.parse(item[this.getTsField()]);
+        if (ts >= lastId) {
+          items.push(item);
+        } else {
+          break;
+        }
+      }
+
+      if (!items.length) {
+        return;
+      }
+
+      this._setLastId(Date.parse(items[0][this.getTsField()]));
+
+      items.forEach((item) => {
+        const meta = this.generateMeta(item);
+        this.$emit(item, meta);
+      });
+    },
+    getResourceFn() {
+      throw new ConfigurationError("getResourceFn is not implemented");
+    },
+    generateMeta() {
+      throw new ConfigurationError("generateMeta is not implemented");
+    },
+  },
+  hooks: {
+    async deploy() {
+      await this.processEvents(10);
+    },
+  },
+  async run() {
+    await this.processEvents();
+  },
+};

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

@@ -0,0 +1,24 @@
+import common from "../common/base-polling.mjs";
+
+export default {
+  ...common,
+  key: "billsby-new-customer-created",
+  name: "New Customer Created",
+  description: "Emit new event when a new customer is created. [See the documentation](https://support.billsby.com/reference/getting-started-with-your-api)",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getResourceFn() {
+      return this.billsby.listCustomers;
+    },
+    generateMeta(customer) {
+      return {
+        id: customer.customerUniqueId,
+        summary: `New Customer with ID ${customer.customerUniqueId}`,
+        ts: Date.parse(customer.createdOn),
+      };
+    },
+  },
+};

package/sources/new-invoice-created/new-invoice-created.mjs

@@ -0,0 +1,29 @@
+import common from "../common/base-polling.mjs";
+
+export default {
+  ...common,
+  key: "billsby-new-invoice-created",
+  name: "New Invoice Created",
+  description: "Emit new event when a new company invoice is created. [See the documentation](https://support.billsby.com/reference/get-company-credit-notes)",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getResourceFn() {
+      return this.billsby.listCompanyInvoices;
+    },
+    getParams() {
+      return {
+        orderByDescending: "createdOn",
+      };
+    },
+    generateMeta(invoice) {
+      return {
+        id: invoice.invoiceId,
+        summary: `New Invoice with ID ${invoice.invoiceId}`,
+        ts: Date.parse(invoice.createdOn),
+      };
+    },
+  },
+};

package/sources/new-subscription-created/new-subscription-created.mjs

@@ -0,0 +1,29 @@
+import common from "../common/base-polling.mjs";
+
+export default {
+  ...common,
+  key: "billsby-new-subscription-created",
+  name: "New Subscription Created",
+  description: "Emit new event when a new subscription is created. [See the documentation](https://support.billsby.com/reference/get-company-subscriptions)",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getResourceFn() {
+      return this.billsby.listSubscriptions;
+    },
+    getParams() {
+      return {
+        orderByDescending: "createdOn",
+      };
+    },
+    generateMeta(subscription) {
+      return {
+        id: subscription.subscriptionUniqueId,
+        summary: `New Subscription with ID ${subscription.subscriptionUniqueId}`,
+        ts: Date.parse(subscription.createdOn),
+      };
+    },
+  },
+};