conductor-node 7.2.0 → 7.3.1

package/dist/package.json

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

package/dist/src/Client.d.ts

@@ -1,5 +1,5 @@
 import type { Environment } from "./environment";
-import type { GraphqlCreateIntegrationConnectionInput, GraphqlCreateIntegrationConnectionMutation, GraphqlGetConnectionStatusQuery, GraphqlGetConnectionStatusQueryVariables, GraphqlGetIntegrationConnectionQuery, GraphqlGetIntegrationConnectionQueryVariables, GraphqlGetIntegrationConnectionsQuery, GraphqlIntegrationRequestInput, GraphqlIntegrationRequestQuery, GraphqlIsIntegrationConnectionActiveQuery, GraphqlIsIntegrationConnectionActiveQueryVariables } from "./graphql/__generated__/operationTypes";
+import type { GraphqlCreateIntegrationConnectionMutation, GraphqlGetConnectionStatusQuery, GraphqlGetConnectionStatusQueryVariables, GraphqlGetIntegrationConnectionQuery, GraphqlGetIntegrationConnectionQueryVariables, GraphqlGetIntegrationConnectionsQuery, GraphqlIntegrationRequestInput, GraphqlIntegrationRequestQuery, GraphqlIsIntegrationConnectionActiveQuery, GraphqlIsIntegrationConnectionActiveQueryVariables } from "./graphql/__generated__/operationTypes";
 import QbdIntegration from "./integrations/qbd/QbdIntegration";
 export interface ClientOptions {
     /** Log each request and response. */
@@ -25,11 +25,15 @@ export default class Client {
      * @param input.endUserEmail Your end-user's email address for identification
      * only. No emails will be sent. Must be distinct from your other connections
      * for the same integration.
-     * @param input.endUserName Your end-user's name that will be shown elsewhere
+     * @param input.endUserCompanyName Your end-user's name that will be shown elsewhere
      * in Conductor.
      * @returns The newly created integration connection.
      */
-    createIntegrationConnection(input: GraphqlCreateIntegrationConnectionInput & {
+    createIntegrationConnection(input: {
+        endUserEmail: string;
+        /** @deprecated Use endUserCompanyName instead */
+        endUserName?: string;
+        endUserCompanyName?: string;
         integrationKey: "quickbooks-desktop";
     }): Promise<GraphqlCreateIntegrationConnectionMutation["createIntegrationConnection"]>;
     isIntegrationConnectionActive(integrationConnectionId: GraphqlIsIntegrationConnectionActiveQueryVariables["integrationConnectionId"], secondsSinceLastActive?: GraphqlIsIntegrationConnectionActiveQueryVariables["secondsSinceLastActive"]): Promise<GraphqlIsIntegrationConnectionActiveQuery["integrationConnection"]["isActive"]>;
@@ -44,12 +48,12 @@ export default class Client {
      * @param integrationConnectionId The ID of the integration connection.
      * @returns result Object with the following properties:
      * @returns result.isConnected Whether we can connect to QBD.
-     * @returns result.devErrorMessage If `isConnected` is `false`, a
-     * developer-friendly error message; e.g., "The end-user's computer is likely
-     * off". Else, `null`.
-     * @returns result.endUserErrorMessage  If `isConnected` is `false`, a
-     * user-friendly error message; e.g., "Please ensure your computer is on and
-     * QuickBooks Desktop is open". Else, `null`.
+     * @returns result.devErrorMessage If `isConnected=false`, this will be the
+     * corresponding error message for the developer; e.g., "The end-user's
+     * computer is likely off".
+     * @returns result.endUserErrorMessage  If `isConnected=false`, this will be
+     * the corresponding error message for the end-user; e.g., "Please ensure your
+     * computer is on and QuickBooks Desktop is open".
      */
     getConnectionStatus(integrationConnectionId: GraphqlGetConnectionStatusQueryVariables["integrationConnectionId"]): Promise<GraphqlGetConnectionStatusQuery["integrationConnection"]["connectionStatus"]>;
     integrationRequest(input: GraphqlIntegrationRequestInput): Promise<GraphqlIntegrationRequestQuery["integrationRequest"]>;

package/dist/src/Client.js

@@ -56,13 +56,29 @@ class Client {
      * @param input.endUserEmail Your end-user's email address for identification
      * only. No emails will be sent. Must be distinct from your other connections
      * for the same integration.
-     * @param input.endUserName Your end-user's name that will be shown elsewhere
+     * @param input.endUserCompanyName Your end-user's name that will be shown elsewhere
      * in Conductor.
      * @returns The newly created integration connection.
      */
     async createIntegrationConnection(input) {
+        // TODO: Remove block below after removing the deprecated field `endUserName`.
+        if (input.endUserName !== undefined) {
+            console.warn(chalk_1.default.yellow(`⚠️ The field "endUserName" for "conductor.createIntegrationConnection()" is deprecated. Please use "endUserCompanyName" instead.`));
+        }
+        const endUserCompanyNameShimmed = input.endUserCompanyName ?? input.endUserName;
+        if (endUserCompanyNameShimmed === undefined) {
+            throw new Error("End-user company name is required when creating an integration-connection.");
+        }
         return this.graphqlOperations
-            .createIntegrationConnection({ input })
+            .createIntegrationConnection({
+            input: {
+                endUserEmail: input.endUserEmail,
+                // eslint-disable-next-line unicorn/no-null -- GraphQL does not support undefined.
+                endUserName: null,
+                endUserCompanyName: endUserCompanyNameShimmed,
+                integrationKey: input.integrationKey,
+            },
+        })
             .then((result) => result.createIntegrationConnection);
     }
     async isIntegrationConnectionActive(integrationConnectionId, secondsSinceLastActive = 60) {
@@ -84,12 +100,12 @@ class Client {
      * @param integrationConnectionId The ID of the integration connection.
      * @returns result Object with the following properties:
      * @returns result.isConnected Whether we can connect to QBD.
-     * @returns result.devErrorMessage If `isConnected` is `false`, a
-     * developer-friendly error message; e.g., "The end-user's computer is likely
-     * off". Else, `null`.
-     * @returns result.endUserErrorMessage  If `isConnected` is `false`, a
-     * user-friendly error message; e.g., "Please ensure your computer is on and
-     * QuickBooks Desktop is open". Else, `null`.
+     * @returns result.devErrorMessage If `isConnected=false`, this will be the
+     * corresponding error message for the developer; e.g., "The end-user's
+     * computer is likely off".
+     * @returns result.endUserErrorMessage  If `isConnected=false`, this will be
+     * the corresponding error message for the end-user; e.g., "Please ensure your
+     * computer is on and QuickBooks Desktop is open".
      */
     async getConnectionStatus(integrationConnectionId) {
         return this.graphqlOperations

package/dist/src/graphql/__generated__/operationTypes.d.ts

@@ -29,8 +29,10 @@ export type GraphqlConnectionStatusResult = {
     isConnected: Scalars["Boolean"];
 };
 export type GraphqlCreateIntegrationConnectionInput = {
+    endUserCompanyName: InputMaybe<Scalars["String"]>;
     endUserEmail: Scalars["String"];
-    endUserName: Scalars["String"];
+    /** @deprecated Use endUserCompanyName instead */
+    endUserName: InputMaybe<Scalars["String"]>;
     integrationKey: Scalars["String"];
 };
 export type GraphqlCreateIntegrationConnectionResult = {
@@ -46,7 +48,9 @@ export type GraphqlIntegration = {
 export type GraphqlIntegrationConnection = {
     connectionStatus: GraphqlConnectionStatusResult;
     devUserId: Scalars["ID"];
+    endUserCompanyName: Scalars["String"];
     endUserEmail: Scalars["String"];
+    /** @deprecated Use endUserCompanyName instead */
     endUserName: Scalars["String"];
     id: Scalars["ID"];
     integration: GraphqlIntegration;

package/dist/src/integrations/qbd/qbdTypes.d.ts

@@ -781,6 +781,8 @@ export interface BillRet {
   
     Note (especially relevant to `CheckAdd` requests): When `RefNumber` is left blank in an SDK transaction add request (that is, or ), the `RefNumber` will be left blank in QuickBooks. This behavior is new as of QBFC3. It used to select the next sequential reference number since the last one used by QuickBooks, as though no `RefNumber` had been provided. This is especially relevant to `CheckAdd` requests because with the current behavior, you will not know the number until the check is printed. */
     RefNumber?: string;
+    /** If `IsPending` is set to true, the bill has not been completed or in draft version. */
+    IsPending?: boolean;
     /** Refers to the payment terms associated with this entity. (This will be an item on the `DateDrivenTerms` or `StandardTerms` list.) If a `TermsRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
     TermsRef?: TermsRef;
     /** Appears in the A/P register and in reports that include this bill. */
@@ -995,6 +997,8 @@ export interface CheckRet {
     Address?: Address;
     /** The address expressed as an address block of `Addr1` through `Addr5`, depending on the number of lines in the original request that created the address. */
     AddressBlock?: AddressBlock;
+    /** If `IsPending` is set to true, the check has not been completed or in draft version. */
+    IsPending?: boolean;
     /** If `IsToBePrinted` is set to true, this transaction is on a list of forms to be printed later. The user can then choose to print all these forms at once. Notice that setting this field to true does not actually perform the printing. Only the QuickBooks user can do that from within QuickBooks. This cannot be done from the SDK. Setting this field to false does not prevent the QuickBooks user from printing the transaction later. It simply results in the transaction NOT being placed in the list of transactions to be printed. */
     IsToBePrinted?: boolean;
     /** For future use with international versions of QuickBooks. */
@@ -2588,6 +2592,8 @@ export interface ItemLineAdd {
     SerialNumber?: string;
     /** The lot number of the asset. */
     LotNumber?: string;
+    /** The expiration date of the inventory serial/lot number. Expiration `Date` is supported from QB Desktop 2023 (USA & Canada) and SDK 16.0. */
+    ExpirationDateForSerialLotNumber: string;
     /** A descriptive text field. */
     Desc?: string;
     /** `QuantityFor` transactions: If an item line add on a transaction request specifies `Quantity` and `Amount` but not `Rate`, QuickBooks will use `Quantity` and `Amount` to calculate `Rate`. Likewise, if a request specifies `Quantity` and `Rate` but not `Amount`, QuickBooks will calculate the `Amount`. If a transaction add request includes a reference to an `ItemDiscount` item, do not include a `Quantity` element as well, or you will get an error. For Item requests: `Quantity` indicates how many of this item there are. */
@@ -2642,6 +2648,8 @@ export interface ItemLineMod {
     SerialNumber?: string;
     /** The lot number of the asset. */
     LotNumber?: string;
+    /** The expiration date of the inventory serial/lot number. Expiration `Date` is supported from QB Desktop 2023 (USA & Canada) and SDK 16.0. */
+    ExpirationDateForSerialLotNumber?: string;
     /** A descriptive text field. */
     Desc?: string;
     /** `QuantityFor` transactions: If an item line add on a transaction request specifies `Quantity` and `Amount` but not `Rate`, QuickBooks will use `Quantity` and `Amount` to calculate `Rate`. Likewise, if a request specifies `Quantity` and `Rate` but not `Amount`, QuickBooks will calculate the `Amount`. If a transaction add request includes a reference to an `ItemDiscount` item, do not include a `Quantity` element as well, or you will get an error. For Item requests: `Quantity` indicates how many of this item there are. */
@@ -2696,6 +2704,8 @@ export interface ItemLineRet {
     SerialNumber?: string;
     /** The lot number of the asset. */
     LotNumber?: string;
+    /** The expiration date of the inventory serial/lot number. Expiration `Date` is supported from QB Desktop 2023 (USA & Canada) and SDK 16.0. */
+    ExpirationDateForSerialLotNumber: string;
     /** A descriptive text field. */
     Desc?: string;
     /** `QuantityFor` transactions: If an item line add on a transaction request specifies `Quantity` and `Amount` but not `Rate`, QuickBooks will use `Quantity` and `Amount` to calculate `Rate`. Likewise, if a request specifies `Quantity` and `Rate` but not `Amount`, QuickBooks will calculate the `Amount`. If a transaction add request includes a reference to an `ItemDiscount` item, do not include a `Quantity` element as well, or you will get an error. For Item requests: `Quantity` indicates how many of this item there are. */

package/package.json

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