conductor-node 8.5.1 → 8.5.3

package/README.md

@@ -54,13 +54,13 @@ Create a new integration-connection.
 const newQbdConnection = await conductor.createIntegrationConnection({
   // The identifier of the third-party platform to integrate.
   integrationKey: "quickbooks-desktop",
-  // Your end-user's unique ID in your product's database. Must be distinct
-  // from your other connections for the same integration.
+  // Your end-user's unique ID in your product's database. Must be
+  // distinct from your other connections for the same integration.
   endUserSourceId: "1234-abcd",
   // Your end-user's email address for identification only. No emails
   // will be sent.
   endUserEmail: "danny@constructionco.com",
-  // Your end-user's company name that will be shown elsewhere in Conductor.
+  // Your end-user's company name shown elsewhere in Conductor.
   endUserCompanyName: "Construction Corp",
 });
 ```
@@ -192,33 +192,15 @@ The error object you receive will have one of the following error types:
 | `ConductorConnectionError`     | There was a network problem between the client (on your server) and Conductor's servers.                                                                                 |
 | `ConductorInternalError`       | Something went wrong on Conductor's end. (These are rare.)                                                                                                               |
 
-### Example
+### Alerting
 
-Using `async`/`await`:
+We recommend sending a **warning** to your error-tracking service (e.g., Sentry) for instances of `ConductorIntegrationError`, which are your end-user's fault (e.g., cannot connect to QBD on your end-user's computer) and sending an **error** for all other errors (e.g., invalid API key).
 
-```ts
-try {
-  const newAccount = await conductor.qbd.account.add(qbdConnectionId, {
-    Name: "Test Account",
-    AccountType: "Bank",
-    OpenBalance: "100",
-  });
-} catch (error) {
-  if (error instanceof ConductorError) {
-    // TODO: Update your app's UI to display `error.endUserMessage`.
-
-    // RECOMMENDED: Send a *warning* to Sentry for integration-errors, which are
-    // your end-user's fault (e.g., cannot connect to QBD on your end-user's
-    // computer) or an *error* for other errors (e.g., invalid API key).
-    Sentry.captureException(error, {
-      level: error instanceof ConductorIntegrationError ? "warning" : "error",
-    });
-  }
-  // ...
-}
-```
+### Example
+
+**NOTE:** We do not expect you to individually implement error handling as shown below for every API call. Ideally, we recommend implementing error handling in a single place in your app, such as a global error handler.
 
-Or in the form of a rejected promise:
+In the form of a rejected promise:
 
 ```ts
 conductor.qbd.account
@@ -232,9 +214,27 @@ conductor.qbd.account
   })
   .catch((error) => {
     if (error instanceof ConductorError) {
-      // TODO: Update your app's UI to display `error.endUserMessage`.
+      // Update your app's UI to display `error.endUserMessage`.
+    } else {
       // ...
     }
-    // ...
   });
 ```
+
+Or using `async`/`await`:
+
+```ts
+try {
+  const newAccount = await conductor.qbd.account.add(qbdConnectionId, {
+    Name: "Test Account",
+    AccountType: "Bank",
+    OpenBalance: "100",
+  });
+} catch (error) {
+  if (error instanceof ConductorError) {
+    // Update your app's UI to display `error.endUserMessage`.
+  } else {
+    // ...
+  }
+}
+```

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "conductor-node",
-    "version": "8.5.1",
+    "version": "8.5.3",
     "description": "Easily integrate with the entire QuickBooks Desktop API with fully-typed async TypeScript",
     "author": "Danny Nemer <hi@DannyNemer.com>",
     "license": "MIT",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "conductor-node",
-  "version": "8.5.1",
+  "version": "8.5.3",
   "description": "Easily integrate with the entire QuickBooks Desktop API with fully-typed async TypeScript",
   "author": "Danny Nemer <hi@DannyNemer.com>",
   "license": "MIT",