conductor-node 11.5.5 → 11.6.1

package/README.md

@@ -64,7 +64,7 @@ yarn add conductor-node
 
 ## Usage
 
-The full API documentation is available [here](https://docs.conductor.is) along with many code examples. The code below is a quickstart example.
+The full API documentation is available [here](https://docs.conductor.is) along with many code examples. The following is a quickstart example:
 
 ```ts
 import Conductor from "conductor-node";
@@ -87,9 +87,11 @@ async function main() {
   });
   console.log("Complete the QuickBooks Desktop auth:", authSession.authFlowUrl);
 
-  // 3. Get a list of all Customers from QuickBooks Desktop for this EndUser.
-  const qbdCustomers = await conductor.qbd.customer.query(endUser.id);
-  console.log("QuickBooks Desktop customers:", qbdCustomers);
+  // 3. Get a list of invoices from this EndUser's QuickBooks Desktop.
+  const qbdInvoices = await conductor.qbd.customer.query(endUser.id, {
+    MaxReturned: 10,
+  });
+  console.log("QuickBooks Desktop invoices:", qbdInvoices);
 }
 
 main();

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "conductor-node",
-    "version": "11.5.5",
+    "version": "11.6.1",
     "description": "QuickBooks Desktop API for Node.js and TypeScript",
     "keywords": [
         "QuickBooks",

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

@@ -4,6 +4,10 @@ export interface AuthSession {
      * The unique identifier for the object.
      */
     readonly id: string;
+    /**
+     * The object's type. This will always be "auth_session".
+     */
+    readonly objectType: "auth_session";
     /**
      * The ID of the EndUser for whom to create an IntegrationConnection.
      */

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

@@ -1,5 +1,6 @@
 import BaseResource from "../resources/BaseResource";
 import type { IntegrationSlug } from "../resources/IntegrationConnectionsResource";
+import type { ApiListResponse } from "../resources/base";
 export interface EndUser {
     /**
      * The unique identifier for this EndUser. You must save this value to your
@@ -7,6 +8,10 @@ export interface EndUser {
      * future.
      */
     readonly id: string;
+    /**
+     * The object's type. This will always be "end_user".
+     */
+    readonly objectType: "end_user";
     /**
      * Your end-user's unique ID in _your_ database. Must be distinct from your
      * other end-users.
@@ -37,7 +42,7 @@ export default class EndUsersResource extends BaseResource {
     /**
      * Returns a list of your EndUsers.
      */
-    list(): Promise<EndUser[]>;
+    list(): Promise<ApiListResponse<EndUser>>;
     /**
      * Creates a new EndUser.
      */

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

@@ -1,10 +1,15 @@
 import BaseResource from "../resources/BaseResource";
+import type { ApiListResponse } from "../resources/base";
 export type IntegrationSlug = "quickbooks_desktop";
 export interface IntegrationConnection {
     /**
      * The unique identifier for the object.
      */
     readonly id: string;
+    /**
+     * The object's type. This will always be "integration_connection".
+     */
+    readonly objectType: "integration_connection";
     /**
      * The ID of the EndUser who owns this IntegrationConnection.
      */
@@ -27,7 +32,7 @@ export default class IntegrationConnectionsResource extends BaseResource {
     /**
      * Returns a list of all IntegrationConnections of all your EndUsers.
      */
-    list(): Promise<IntegrationConnection[]>;
+    list(): Promise<ApiListResponse<IntegrationConnection>>;
     /**
      * Retrieves the specified IntegrationConnection.
      */

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

@@ -0,0 +1,5 @@
+export interface ApiListResponse<T> {
+    readonly url: string;
+    readonly objectType: "list";
+    readonly data: T[];
+}

package/dist/src/resources/base.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/utils/checkForUpdates.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createFramedMessage = exports.checkForUpdates = void 0;
 const package_json_1 = __importDefault(require("../../package.json"));
 const env_1 = require("../utils/env");
-const node_child_process_1 = __importDefault(require("node:child_process"));
+const axios_1 = __importDefault(require("axios"));
 function checkForUpdates() {
     if (process.env.NODE_ENV === "test") {
         return;
@@ -16,32 +16,27 @@ function checkForUpdates() {
     if ((0, env_1.isEnvironmentVariableTruthy)("CONDUCTOR_HIDE_UPDATE_MESSAGE")) {
         return;
     }
-    // Exit early if `npm` is not installed.
-    try {
-        node_child_process_1.default.execSync("npm --version", {
-            // Prevent the shell from internally logging the error message.
-            stdio: "ignore",
-        });
-    }
-    catch {
-        return;
-    }
     const currentVersion = package_json_1.default.version;
-    const latestVersion = node_child_process_1.default
-        .execSync(`npm view ${package_json_1.default.name} version --silent`)
-        .toString()
-        .trim();
-    if (currentVersion !== latestVersion) {
-        const updateCommand = process.env["npm_execpath"]?.includes("yarn") === true
-            ? "yarn add"
-            : "npm install";
-        console.warn(createFramedMessage([
-            `🟡 Update available for Conductor! ${currentVersion} -> ${latestVersion}`,
-            "",
-            "Run the following to update:",
-            `  ${updateCommand} ${package_json_1.default.name}@latest`,
-        ]));
-    }
+    const packageName = encodeURIComponent(package_json_1.default.name);
+    axios_1.default
+        .get(`https://registry.npmjs.org/-/package/${packageName}/dist-tags`)
+        .then((response) => {
+        const latestVersion = response.data.latest;
+        if (currentVersion !== latestVersion) {
+            const updateCommand = process.env["npm_execpath"]?.includes("yarn") === true
+                ? "yarn add"
+                : "npm install";
+            console.warn(createFramedMessage([
+                `🟡 Update available for Conductor! ${currentVersion} -> ${latestVersion}`,
+                "",
+                "Run the following to update:",
+                `  ${updateCommand} ${packageName}@latest`,
+            ]));
+        }
+    })
+        .catch((error) => {
+        console.debug("Failed to check for updates:", error);
+    });
 }
 exports.checkForUpdates = checkForUpdates;
 function createFramedMessage(messageLines) {

package/dist/src/utils/error.d.ts

@@ -39,7 +39,7 @@ export declare abstract class ConductorError extends Error {
      * your end-users in your app's UI.
      *
      * This value exists for *every* error. E.g., for a QBD connection error, it
-     * might recommend the end-user to check that their QuickBooks Desktop is open
+     * might recommend the end-user to confirm their QuickBooks Desktop is open
      * and that they're logged in. But if a Conductor API key is expired, e.g.,
      * this message will just say "An internal server error occurred. Please try
      * again later.".

package/dist/src/utils/error.js

@@ -29,7 +29,7 @@ class ConductorError extends Error {
      * your end-users in your app's UI.
      *
      * This value exists for *every* error. E.g., for a QBD connection error, it
-     * might recommend the end-user to check that their QuickBooks Desktop is open
+     * might recommend the end-user to confirm their QuickBooks Desktop is open
      * and that they're logged in. But if a Conductor API key is expired, e.g.,
      * this message will just say "An internal server error occurred. Please try
      * again later.".

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "conductor-node",
-  "version": "11.5.5",
+  "version": "11.6.1",
   "description": "QuickBooks Desktop API for Node.js and TypeScript",
   "keywords": [
     "QuickBooks",