conductor-node 6.1.3 → 6.2.1

package/README.md

@@ -4,8 +4,8 @@ Execute _any_ read or write [QuickBooks Desktop API](https://developer.intuit.co
 
 ## Requirements
 
-1. A running version of QuickBooks Desktop with QuickBooks Web Connector configured for Conductor. See the [Conductor Getting Started guide](https://www.notion.so/conductor-io/Conductor-Documentation-Getting-Started-7f0f42593d444337b0b3200c771d98e6).
-2. A Conductor API key from Danny.
+1. A Conductor API key from Danny.
+2. A running version of QuickBooks Desktop connected to Conductor. See our guide to [Connect QBD to Conductor with QB Web Connector](https://www.notion.so/conductor-io/QBWC-Setup-Connect-QBD-to-Conductor-with-QB-Web-Connector-fb01b86f938e445ead178e3a1a994d78).
 
 ## Installation
 
@@ -42,7 +42,7 @@ Fetch all authorized integration-connections.
 const qbdConnections = await conductor.getIntegrationConnections();
 ```
 
-### `qbd`
+### `qbd.*`
 
 Execute any QuickBooks Desktop (QBD) API against a specific integration connection id. See the official [QuickBooks Desktop API Reference](https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop) for a full list of available APIs.
 
@@ -54,12 +54,24 @@ const newAccount = await conductor.qbd.account.add(qbdConnections[0].id, {
 });
 ```
 
+### `createIntegrationConnection(qbwcUsername: string)`
+
+🚧 Not yet enabled.
+
+Create a new integration connection.
+
+```ts
+const newQbdConnection = await conductor.createIntegrationConnection(
+  "qbwc_username"
+);
+```
+
 ### `getIntegrationConnectionById(id: string)`
 
 Fetch a single integration connection by id.
 
 ```ts
-const connection = await conductor.getIntegrationConnectionById(
+const qbdConnection = await conductor.getIntegrationConnectionById(
   qbdConnections[0].id
 );
 ```

package/dist/package.json

@@ -1,7 +1,18 @@
 {
     "name": "conductor-node",
-    "version": "6.1.3",
+    "version": "6.2.1",
     "description": "Easily integrate with the entire QuickBooks Desktop API with fully-typed async TypeScript",
+    "keywords": [
+        "accounting",
+        "api",
+        "conductor",
+        "qbd",
+        "qbwc",
+        "qbxml",
+        "quickbooks desktop",
+        "sdk",
+        "typescript"
+    ],
     "author": "Danny Nemer <hi@DannyNemer.com>",
     "license": "MIT",
     "type": "commonjs",

package/dist/src/Client.d.ts

@@ -1,4 +1,5 @@
 import type { Environment } from "./environment";
+import type { IntegrationConnection } from "./graphqlTypes";
 import QbdIntegration from "./integrations/qbd/QbdIntegration";
 export interface ClientOptions {
     /** Log each request and response. */
@@ -9,20 +10,6 @@ interface IntegrationRequestParams {
     integrationConnectionId: string;
     requestObject: object;
 }
-interface GetIntegrationConnectionByIdResult {
-    integrationConnection: {
-        id: string;
-        integration: {
-            id: string;
-            name: string;
-        };
-        qbwcUsername: string;
-        lastHeartbeatAt: string | null;
-    };
-}
-interface GetIntegrationConnectionsResult {
-    integrationConnections: GetIntegrationConnectionByIdResult["integrationConnection"][];
-}
 export default class Client {
     /** QuickBooks Desktop integration. */
     readonly qbd: QbdIntegration;
@@ -30,8 +17,9 @@ export default class Client {
     private readonly gqlClient;
     private readonly verbose;
     constructor(apiKey: string, { verbose, serverEnvironment }?: ClientOptions);
-    getIntegrationConnectionById(integrationConnectionId: string): Promise<GetIntegrationConnectionByIdResult["integrationConnection"]>;
-    getIntegrationConnections(): Promise<GetIntegrationConnectionsResult["integrationConnections"]>;
+    getIntegrationConnectionById(integrationConnectionId: string): Promise<IntegrationConnection>;
+    getIntegrationConnections(): Promise<IntegrationConnection[]>;
+    createIntegrationConnection(qbwcUsername: string): Promise<IntegrationConnection>;
     isIntegrationConnectionActive(integrationConnectionId: string, secondsSinceLastActive?: number): Promise<boolean>;
     logConnectionStatuses(): Promise<void>;
     integrationRequest(integrationRequestParams: IntegrationRequestParams): Promise<object>;

package/dist/src/Client.js

@@ -51,6 +51,7 @@ class Client {
             integration {
               id
               name
+              key
             }
             qbwcUsername
             lastHeartbeatAt
@@ -59,6 +60,28 @@ class Client {
       `));
         return data.integrationConnections;
     }
+    async createIntegrationConnection(qbwcUsername) {
+        const data = (await this.request(`#graphql
+        mutation CreateIntegrationConnection($input: IntegrationConnectionInput!) {
+          createIntegrationConnection(input: $input) {
+            id
+            integration {
+              id
+              name
+              key
+            }
+            qbwcUsername
+            lastHeartbeatAt
+          }
+        }
+      `, {
+            input: {
+                integrationKey: "qbd",
+                qbwcUsername,
+            },
+        }));
+        return data.createIntegrationConnection;
+    }
     async isIntegrationConnectionActive(integrationConnectionId, secondsSinceLastActive = 10) {
         const integrationConnection = await this.getIntegrationConnectionById(integrationConnectionId);
         if (integrationConnection.lastHeartbeatAt === null) {

package/dist/src/graphqlTypes.d.ts

@@ -0,0 +1,21 @@
+export interface Integration {
+    id: string;
+    name: string;
+    key: string;
+}
+export interface IntegrationConnection {
+    id: string;
+    devUserId: string;
+    integration: Integration;
+    qbwcUsername: string;
+    qbwcPassword: string;
+    lastHeartbeatAt: string | null;
+}
+export interface IntegrationRequestParams {
+    integrationConnectionId: string;
+    requestObject: object;
+}
+export interface IntegrationConnectionInput {
+    integrationKey: string;
+    qbwcUsername: string;
+}

package/dist/src/graphqlTypes.js

@@ -0,0 +1,3 @@
+"use strict";
+// TODO: Replace with codegen.
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,7 +1,18 @@
 {
   "name": "conductor-node",
-  "version": "6.1.3",
+  "version": "6.2.1",
   "description": "Easily integrate with the entire QuickBooks Desktop API with fully-typed async TypeScript",
+  "keywords": [
+    "accounting",
+    "api",
+    "conductor",
+    "qbd",
+    "qbwc",
+    "qbxml",
+    "quickbooks desktop",
+    "sdk",
+    "typescript"
+  ],
   "author": "Danny Nemer <hi@DannyNemer.com>",
   "license": "MIT",
   "type": "commonjs",