conductor-node 10.3.1 → 10.4.0

package/README.md

@@ -1,4 +1,4 @@
-# Conductor - The best QuickBooks Desktop integration on the planet
+# [Conductor](https://conductor.is/) - The best QuickBooks Desktop integration on the planet
 
 Execute _any_ read or write [QuickBooks Desktop API](https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop) through async TypeScript and receive a fully-typed response.
 
@@ -16,8 +16,7 @@ Execute _any_ read or write [QuickBooks Desktop API](https://developer.intuit.co
 
 ## Requirements
 
-1. A Conductor API key.
-2. A running version of QuickBooks Desktop connected to Conductor. See our [guide to connecting QuickBooks Desktop to Conductor](https://conductor-io.notion.site/QuickBooks-Desktop-integration-setup-86f6325f747d4447b95d27b59ad89ef5).
+1. A Conductor API key. Please visit [our website](https://conductor.is/) to join the private beta.
 
 ## Installation
 
@@ -65,8 +64,7 @@ const newQbdConnection = await conductor.integrationConnections.create({
   // 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.
+  // Your end-user's email address.
   endUserEmail: "danny@constructionco.com",
   // Your end-user's company name shown elsewhere in Conductor.
   endUserCompanyName: "Construction Corp",

package/dist/package.json

@@ -1,7 +1,17 @@
 {
     "name": "conductor-node",
-    "version": "10.3.1",
+    "version": "10.4.0",
     "description": "Easily integrate the entire QuickBooks Desktop API using fully-typed async TypeScript",
+    "keywords": [
+        "QuickBooks Desktop",
+        "QuickBooks",
+        "Intuit",
+        "QuickBooks Web Connector",
+        "qbXML",
+        "QBWC",
+        "QBD"
+    ],
+    "homepage": "https://conductor.is",
     "license": "MIT",
     "type": "commonjs",
     "main": "dist/src/index.js",
@@ -29,12 +39,5 @@
     "devDependencies": {
         "axios-mock-adapter": "^1.21.4",
         "tsc-alias": "^1.7.0"
-    },
-    "keywords": [
-        "conductor",
-        "qbd",
-        "qbwc",
-        "qbxml",
-        "quickbooks desktop"
-    ]
+    }
 }

package/dist/src/integrations/BaseIntegration.d.ts

@@ -1,13 +1,14 @@
-import type { IntegrationConnection } from "../resources/IntegrationConnectionsResource";
+import type { EndUser } from "../resources/EndUsersResource";
+import type { IntegrationConnection, IntegrationKey } from "../resources/IntegrationConnectionsResource";
 import type { AxiosInstance } from "axios";
 export default abstract class BaseIntegration {
     protected readonly httpClient: AxiosInstance;
     constructor(httpClient: AxiosInstance);
     /**
-     * @deprecated Use `sendRequestByEndUserIdAndIntegrationKey` after migrating
-     * to end-user model.
+     * @deprecated Instead use `sendRequest` after migrating to the end-user
+     * model.
      */
     protected sendRequestDeprecated(id: IntegrationConnection["id"], payload: Record<string, unknown>): Promise<object>;
     /** Not intended for public use. */
-    protected sendRequest(endUserId: IntegrationConnection["endUserId"], integrationKey: IntegrationConnection["integrationKey"], payload: Record<string, unknown>): Promise<object>;
+    protected sendRequest(endUserId: EndUser["id"], integrationKey: IntegrationKey, payload: Record<string, unknown>): Promise<object>;
 }

package/dist/src/integrations/BaseIntegration.js

@@ -6,8 +6,8 @@ class BaseIntegration {
         this.httpClient = httpClient;
     }
     /**
-     * @deprecated Use `sendRequestByEndUserIdAndIntegrationKey` after migrating
-     * to end-user model.
+     * @deprecated Instead use `sendRequest` after migrating to the end-user
+     * model.
      */
     async sendRequestDeprecated(id, payload) {
         const { data } = await this.httpClient.post(`/integration-connections/${id}/send-request`, payload);

package/dist/src/integrations/qbd/QbdIntegration.js

@@ -2404,14 +2404,9 @@ class QbdIntegration extends BaseIntegration_1.default {
         query: async (endUserId, params) => this.sendRequestWrapper(endUserId, { WorkersCompCodeQueryRq: params }, "WorkersCompCodeQueryRs", "WorkersCompCodeRet"),
     };
     async sendRequestWrapper(endUserId, params, responseWrapperKey, responseBodyKey) {
-        // Why is there no lint error for not initializing `response`?
-        let response;
-        if (endUserId.startsWith("int_conn")) {
-            response = (await this.sendRequestDeprecated(endUserId, params));
-        }
-        else {
-            response = (await this.sendRequest(endUserId, "quickbooks-desktop", params));
-        }
+        const response = (endUserId.startsWith("int_conn")
+            ? await this.sendRequestDeprecated(endUserId, params)
+            : await this.sendRequest(endUserId, "quickbooks-desktop", params));
         const responseBody = response[responseWrapperKey]?.[responseBodyKey];
         if (responseBody === undefined) {
             throw new error_1.ConductorIntegrationError({

package/dist/src/resources/EndUsersResource.d.ts

@@ -1,17 +1,17 @@
 import BaseResource from "../resources/BaseResource";
+import type { IntegrationKey } from "../resources/IntegrationConnectionsResource";
 export interface EndUser {
     /**
      * The unique identifier for the object.
      */
     id: string;
     /**
-     * Your end-user's unique ID in your database. Must be distinct from
-     * your other end-users.
+     * Your end-user's unique ID in your database. Must be distinct from your
+     * other end-users.
      */
     sourceId: string;
     /**
-     * Your end-user's email address for identification only. No emails will be
-     * sent.
+     * Your end-user's email address.
      */
     email: string;
     /**
@@ -24,6 +24,9 @@ export interface EndUser {
     createdAt: string;
 }
 export type EndUserCreateInput = Pick<EndUser, "email" | "name" | "sourceId">;
+export interface EndUserPingOutput {
+    duration: number;
+}
 export default class EndUsersResource extends BaseResource {
     protected readonly ROUTE = "/end-users";
     /**
@@ -38,4 +41,20 @@ export default class EndUsersResource extends BaseResource {
      * Retrieves the specified end-user.
      */
     retrieve(id: EndUser["id"]): Promise<EndUser>;
+    /**
+     * Checks whether the specified integration-connection can connect and process
+     * requests end-to-end.
+     *
+     * If the connection fails, the error we encountered will be thrown as a
+     * `ConductorError` (like any request). This information is useful for showing
+     * a "connection status" indicator in your app. If an error occurs, we
+     * recommend displaying the property `error.endUserMessage` to your end-user
+     * in your app's UI.
+     *
+     * @param endUserId The ID of the end-user to ping.
+     * @param integrationKey The integration key for the integration-connection to
+     * ping.
+     * @returns The ping result with the duration in milliseconds.
+     */
+    ping(endUserId: EndUser["id"], integrationKey: IntegrationKey): Promise<EndUserPingOutput>;
 }

package/dist/src/resources/EndUsersResource.js

@@ -27,5 +27,24 @@ class EndUsersResource extends BaseResource_1.default {
         const { data } = await this.httpClient.get(`${this.ROUTE}/${id}`);
         return data;
     }
+    /**
+     * Checks whether the specified integration-connection can connect and process
+     * requests end-to-end.
+     *
+     * If the connection fails, the error we encountered will be thrown as a
+     * `ConductorError` (like any request). This information is useful for showing
+     * a "connection status" indicator in your app. If an error occurs, we
+     * recommend displaying the property `error.endUserMessage` to your end-user
+     * in your app's UI.
+     *
+     * @param endUserId The ID of the end-user to ping.
+     * @param integrationKey The integration key for the integration-connection to
+     * ping.
+     * @returns The ping result with the duration in milliseconds.
+     */
+    async ping(endUserId, integrationKey) {
+        const { data } = await this.httpClient.get(`${this.ROUTE}/${endUserId}/ping/${integrationKey}`);
+        return data;
+    }
 }
 exports.default = EndUsersResource;

package/dist/src/resources/IntegrationConnectionsResource.d.ts

@@ -1,6 +1,7 @@
 import BaseResource from "../resources/BaseResource";
 import IntegrationConnectionAuthSessionsResource from "../resources/IntegrationConnectionAuthSessionsResource";
 import type { AxiosInstance } from "axios";
+export type IntegrationKey = "quickbooks-desktop";
 export interface IntegrationConnection {
     /**
      * The unique identifier for the object.
@@ -14,7 +15,7 @@ export interface IntegrationConnection {
      * The identifier of the third-party platform to integrate (e.g.,
      * "quickbooks-desktop").
      */
-    integrationKey: string;
+    integrationKey: IntegrationKey;
     /**
      * The time at which the object was created.
      */
@@ -29,15 +30,14 @@ export interface IntegrationConnectionCreateOldInput {
      * The identifier of the third-party platform to integrate (e.g.,
      * "quickbooks-desktop").
      */
-    integrationKey: string;
+    integrationKey: IntegrationKey;
     /**
      * Your end-user's unique ID in your product's database. Must be distinct from
      * your other connections for the same integration.
      */
     endUserSourceId: string;
     /**
-     * Your end-user's email address for identification only. No emails will be
-     * sent.
+     * Your end-user's email address.
      */
     endUserEmail: string;
     /**

package/package.json

@@ -1,7 +1,17 @@
 {
   "name": "conductor-node",
-  "version": "10.3.1",
+  "version": "10.4.0",
   "description": "Easily integrate the entire QuickBooks Desktop API using fully-typed async TypeScript",
+  "keywords": [
+    "QuickBooks Desktop",
+    "QuickBooks",
+    "Intuit",
+    "QuickBooks Web Connector",
+    "qbXML",
+    "QBWC",
+    "QBD"
+  ],
+  "homepage": "https://conductor.is",
   "license": "MIT",
   "type": "commonjs",
   "main": "dist/src/index.js",
@@ -29,12 +39,5 @@
   "devDependencies": {
     "axios-mock-adapter": "^1.21.4",
     "tsc-alias": "^1.7.0"
-  },
-  "keywords": [
-    "conductor",
-    "qbd",
-    "qbwc",
-    "qbxml",
-    "quickbooks desktop"
-  ]
+  }
 }