@bunnyapp/api-client 1.0.16 → 2.0.0

package/README.md

@@ -39,38 +39,88 @@ const bunny = new BunnyClient({
 });
 ```
 
-## Convenience methods
+## Helper methods
 
-This SDK wrappers several of the common Bunny API requests.
+This SDK wrappers several of the common Bunny API requests. The response varies based on the method that is used.
 
 ```js
 // Create a new subscription
-bunny.createSubscription("priceListCode", {
+const res = await bunny.subscriptionCreate("priceListCode", {
   trial: true,
   accountName: "accountName",
   firstName: "firstName",
   lastName: "lastName",
-  email: "email",
+  email: "email@example.com",
   tenantCode: "remoteId",
 });
 
+// On success res will be a subscription object
+{
+  id: '17',
+  account: { id: '18', name: 'accountName', contacts: [ [Object] ] },
+  trialStartDate: '2023-07-17',
+  trialEndDate: '2023-07-30',
+  startDate: '2023-07-31',
+  endDate: '2024-07-30',
+  state: 'TRIAL',
+  plan: { code: 'bunny_medium', name: 'Medium' },
+  priceList: { code: 'bunny_medium_monthly', name: 'Monthly' },
+  tenant: { id: '12', code: 'remoteId', name: 'accountName' }
+}
+
+
 // Get a session token for the Bunny customer portal
-bunny.createPortalSession("tenantCode");
+const res = await bunny.portalSessionCreate("tenantCode");
 
 // Optionally supply a return url to get back to your app
-bunny.createPortalSession("tenantCode", "https://example.com");
+const res = await bunny.portalSessionCreate(
+  "tenantCode",
+  "https://example.com"
+);
 
 // Default session length is 24 hours but you can change it. e.g 12 hours
-bunny.createPortalSession("tenantCode", "https://example.com", 12);
+const res = await bunny.portalSessionCreate(
+  "tenantCode",
+  "https://example.com",
+  12
+);
 
 // Track usage for billing
-bunny.trackUsage(featureCode, quantity, tenantCode, usageAt);
+const res = await bunny.tenantUsageCreate(
+  featureCode,
+  quantity,
+  tenantCode,
+  usageAt
+);
+```
+
+## Error handling
+
+If there is an error with a helper method an exception will be raised.
+
+```js
+try {
+  const res = await bunny.subscriptionCreate(...);
+  // Do something
+} catch (error) {
+  console.log(error);
+}
+
+or
+
+bunny.subscriptionCreate(...).then((res) => {
+  // Do something
+}).catch((error) => {
+  console.log(error);
+})
 ```
 
 ## Perform a query
 
 If the convenience methods on this SDK are not enough and you need more control over queries or mutations then you can make an async request against the Bunny GraphQL API.
 
+The response will contain the raw graphql json.
+
 ```js
 let query = `query tenants ($filter: String, $limit: Int) {
     tenants (filter: $filter, limit: $limit) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bunnyapp/api-client",
-  "version": "1.0.16",
+  "version": "2.0.0",
   "description": "Node.js client for Bunny CRM",
   "main": "index.js",
   "directories": {

package/src/helpers/{track-usage.js → feature-usage-create.js}

@@ -19,6 +19,14 @@ const query = `mutation featureUsageCreate ($attributes: FeatureUsageAttributes!
     }
 }`;
 
+/**
+ * Record feature usage for a tenant
+ * @param {string} featureCode Code for the feature that is being used
+ * @param {number} quantity Amount of usage to record
+ * @param {string} tenantCode Code for the tenant that has the usage
+ * @param {string} usageAt ISO8601 date string. Deafults to now
+ * @returns
+ */
 module.exports = async function (
   featureCode,
   quantity,
@@ -37,5 +45,11 @@ module.exports = async function (
     variables["attributes"]["usageAt"] = usageAt;
   }
 
-  return this.query(query, variables);
+  const res = await this.query(query, variables);
+
+  if (res?.errors) {
+    throw new Error(res.errors.map((e) => e.message).join());
+  }
+
+  return res?.data?.featureUsageCreate?.featureUsage;
 };

package/src/helpers/portal-session-create.js

@@ -0,0 +1,33 @@
+const query = `mutation portalSessionCreate ($tenantCode: String!, $expiry: Int!, $returnUrl: String!) {
+  portalSessionCreate (tenantCode: $tenantCode, expiry: $expiry, returnUrl: $returnUrl) {
+      errors
+      token
+  }
+}`;
+
+/**
+ * Generate a session token for customer portal
+ * @param {string} tenantCode The unique code that represents the tenant
+ * @param {string} returnUrl A URL to redirect the user back to the original app after using the portal
+ * @param {number} expiryInHours Length of time in hours before the token expires. Deafults to 24
+ * @returns {string} The session token
+ */
+module.exports = async function (
+  tenantCode,
+  returnUrl = null,
+  expiryInHours = 24
+) {
+  let variables = {
+    tenantCode: tenantCode,
+    returnUrl: returnUrl,
+    expiry: expiryInHours,
+  };
+
+  const res = await this.query(query, variables);
+
+  if (res?.errors) {
+    throw new Error(res.errors.map((e) => e.message).join());
+  }
+
+  return res?.data?.portalSessionCreate?.token;
+};

package/src/helpers/subscription-cancel.js

@@ -0,0 +1,24 @@
+const query = `mutation subscriptionCancel ($ids: [ID!]!) {
+  subscriptionCancel (ids: $ids) {
+      errors
+  }
+}`;
+
+/**
+ * Cancel a subsription
+ * @param {number} subscriptionId
+ * @returns {boolean} Success
+ */
+module.exports = async function (subscriptionId) {
+  let variables = {
+    ids: [subscriptionId],
+  };
+
+  const res = await this.query(query, variables);
+
+  if (res?.errors) {
+    throw new Error(res.errors.map((e) => e.message).join());
+  }
+
+  return true;
+};

package/src/helpers/{create-subscription.js → subscription-create.js}

@@ -34,12 +34,18 @@ const query = `mutation subscriptionCreate ($attributes: SubscriptionAttributes!
   }
 }`;
 
+/**
+ * Create a new subscription for a tenant
+ * @param {string} priceListCode The code for the plan to subscribe to
+ * @param {Object} options
+ * @returns {Object} The subscription object
+ */
 module.exports = async function (priceListCode, options = {}) {
   let variables = {
     attributes: {
       priceListCode: priceListCode,
       trial: options["trial"] || false,
-      evergreen: options["evergreen"] || false,
+      evergreen: options["evergreen"] || true,
     },
   };
 
@@ -63,5 +69,13 @@ module.exports = async function (priceListCode, options = {}) {
     };
   }
 
-  return this.query(query, variables);
+  const res = await this.query(query, variables);
+
+  console.log(res);
+
+  if (res?.errors) {
+    throw new Error(res.errors.map((e) => e.message).join());
+  }
+
+  return res?.data?.subscriptionCreate?.subscription;
 };

package/src/helpers/tenant-create.js

@@ -0,0 +1,51 @@
+const query = `mutation tenantCreate ($attributes: TenantAttributes!, $subscriptionId: ID!) {
+  tenantCreate (attributes: $attributes, subscriptionId: $subscriptionId) {
+    tenant {
+      code
+      id
+      name
+      platform {
+        id
+        name
+        code
+      }
+    }
+    errors
+  }
+}`;
+
+/**
+ *
+ * @param {string} name Account name of the tenant
+ * @param {string} code Unique code for the tenant
+ * @param {string} platformCode Code for the platform that the tenant is on
+ * @param {number} accountId Id of the account that the tenant is being created for
+ * @param {number} subscriptionId Id of the subscription that the tenant is being created for
+ * @returns
+ */
+module.exports = async function (
+  name,
+  code,
+  platformCode,
+  accountId,
+  subscriptionId
+) {
+  let variables = {
+    attributes: {
+      name: name,
+      code: code,
+      accountId: accountId,
+      platformCode: platformCode,
+    },
+    subscriptionId: subscriptionId,
+  };
+
+  const res = await this.query(query, variables);
+
+  console.log(res);
+  if (res?.errors) {
+    throw new Error(res.errors.map((e) => e.message).join());
+  }
+
+  return res?.data?.tenantCreate?.tenant;
+};

package/src/helpers/{update-tenant.js → tenant-update.js}

@@ -10,6 +10,7 @@ const query = `mutation tenantUpdate ($id: ID!, $attributes: TenantAttributes!)
         code
       }
     }
+    errors
   }
 }`;
 
@@ -21,5 +22,12 @@ module.exports = async function (id, code, name) {
       name: name,
     },
   };
-  return this.query(query, variables);
+
+  const res = await this.query(query, variables);
+
+  if (res?.errors) {
+    throw new Error(res.errors.map((e) => e.message).join());
+  }
+
+  return res?.data?.tenantUpdate?.tenant;
 };

package/src/index.js

@@ -84,10 +84,11 @@ class Bunny {
   }
 }
 
-Bunny.prototype.createSubscription = require("./helpers/create-subscription.js");
-Bunny.prototype.createTenant = require("./helpers/create-tenant.js");
-Bunny.prototype.updateTenant = require("./helpers/update-tenant.js");
-Bunny.prototype.trackUsage = require("./helpers/track-usage.js");
-Bunny.prototype.createPortalSession = require("./helpers/create-portal-session.js");
+Bunny.prototype.subscriptionCreate = require("./helpers/subscription-create.js");
+Bunny.prototype.subscriptionCancel = require("./helpers/subscription-cancel.js");
+Bunny.prototype.tenantCreate = require("./helpers/tenant-create.js");
+Bunny.prototype.tenantUpdate = require("./helpers/tenant-update.js");
+Bunny.prototype.featureUsageCreate = require("./helpers/feature-usage-create.js");
+Bunny.prototype.portalSessionCreate = require("./helpers/portal-session-create.js");
 
 module.exports = Bunny;

package/src/helpers/create-portal-session.js

@@ -1,19 +0,0 @@
-const query = `mutation portalSessionCreate ($tenantCode: String!, $expiry: Int!, $returnUrl: String!) {
-  portalSessionCreate (tenantCode: $tenantCode, expiry: $expiry, returnUrl: $returnUrl) {
-      errors
-      token
-  }
-}`;
-
-module.exports = async function (
-  tenantCode,
-  returnUrl = null,
-  expiryInHours = 24
-) {
-  let variables = {
-    tenantCode: tenantCode,
-    returnUrl: returnUrl,
-    expiry: expiryInHours,
-  };
-  return this.query(query, variables);
-};

package/src/helpers/create-tenant.js

@@ -1,26 +0,0 @@
-const query = `mutation tenantCreate ($attributes: TenantAttributes!, $subscriptionId: ID!) {
-  tenantCreate (attributes: $attributes, subscriptionId: $subscriptionId) {
-    tenant {
-      code
-      id
-      name
-      platform {
-        id
-        name
-        code
-      }
-    }
-  }
-}`;
-
-module.exports = async function (name, code, platformCode, subscriptionId) {
-  let variables = {
-    attributes: {
-      name: name,
-      code: code,
-      platformCode: platformCode,
-    },
-    subscriptionId: subscriptionId,
-  };
-  return this.query(query, variables);
-};