conductor-node 9.3.0 → 9.4.1

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "conductor-node",
-    "version": "9.3.0",
+    "version": "9.4.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/graphql/graphqlOperationWrapper.js

@@ -80,7 +80,7 @@ function wrapError(error) {
             if (errorExtensions["code"] === "GRAPHQL_VALIDATION_FAILED") {
                 return new error_1.ConductorInvalidRequestError({
                     code: "CLIENT_OUTDATED",
-                    message: `Your version of "${package_json_1.default.name}" is not longer compatible with the Conductor server. Please run "yarn upgrade ${package_json_1.default.name} --latest" to update.`,
+                    message: `Your version of "${package_json_1.default.name}" is no longer compatible with the Conductor server. Please run "yarn upgrade ${package_json_1.default.name} --latest" to update.`,
                     httpStatusCode: response.status,
                 });
             }

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

@@ -112,9 +112,6 @@ export default class QbdIntegration extends BaseIntegration {
          * - `BillableStatus`
          * - `OverrideItemAccountRef`
          *
-         * (For more details about what it means for a field to be clearable or not
-         * clearable, see the QB SDK Programmer’s Guide.)
-         *
          * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BillMod
          */
         mod: (integrationConnectionId: string, params: QbdTypes.BillModRq["BillMod"]) => Promise<NonNullable<QbdTypes.BillModRs["BillRet"]>>;
@@ -283,6 +280,35 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (integrationConnectionId: string, params: QbdTypes.BillPaymentCheckQueryRq) => Promise<NonNullable<QbdTypes.BillPaymentCheckQueryRs["BillPaymentCheckRet"]>>;
     };
+    billingRate: {
+        /**
+         * Adds a billing rate to the billing rate level list.
+         *
+         * After a billing rate is created, it can be assigned to an employee or
+         * vendor (`VendorAdd`/`VendorMod`, `EmployeeAdd`/`EmployeeMod`) via the
+         * `BillingRateRef` element in the appropriate request. Then, once the
+         * billing rate is assigned to an employee or vendor, if you use that
+         * employee or vendor in a time transaction (`TimeTrackingAdd`), then the
+         * billing rate will override the rate specified by the service item used in
+         * the time transaction.
+         *
+         * Use `FixedBillingRate` to override all service items with a fixed rate.
+         * Use `BillingRatePerItem` to override a specific service item. If you want
+         * to specify more than one service item, you’ll need to use one
+         * `BillingRatePerItem` aggregate for each service item.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BillingRateAdd
+         */
+        add: (integrationConnectionId: string, params: QbdTypes.BillingRateAddRq["BillingRateAdd"]) => Promise<NonNullable<QbdTypes.BillingRateAddRs["BillingRateRet"]>>;
+        /**
+         * Returns all billing rates, or billing rates filtered by modified date, or
+         * filtered by billing rate name, or filtered by the service item referenced
+         * in the billing rate.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BillingRateQuery
+         */
+        query: (integrationConnectionId: string, params: QbdTypes.BillingRateQueryRq) => Promise<NonNullable<QbdTypes.BillingRateQueryRs["BillingRateRet"]>>;
+    };
     charge: {
         /**
          * Adds a customer charge. A `Charge` contains information about a statement
@@ -400,6 +426,101 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (integrationConnectionId: string, params: QbdTypes.CompanyQueryRq) => Promise<NonNullable<QbdTypes.CompanyQueryRs["CompanyRet"]>>;
     };
+    creditCardCharge: {
+        /**
+         * A credit card charge is a general charge incurred when a QuickBooks user
+         * makes a purchase using a credit card. Credit card charges for purchases
+         * can be tracked as expenses (in expense accounts) or as items.
+         *
+         * The current balance on the credit card becomes part of the accounts
+         * payable balance. If a balance is carried on the credit card across time,
+         * finance or interest charges can be tracked in QuickBooks.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CreditCardChargeAdd
+         */
+        add: (integrationConnectionId: string, params: QbdTypes.CreditCardChargeAddRq["CreditCardChargeAdd"]) => Promise<NonNullable<QbdTypes.CreditCardChargeAddRs["CreditCardChargeRet"]>>;
+        /**
+         * The Credit Card charge mod request allows you to modify an existing
+         * credit card charge transaction using the SDK. You can modify most of the
+         * fields that can be modified in the QuickBooks UI. That is, this request
+         * can be used to modify Purchased from, date, credit card and modify lines
+         * from the item table and the expense table.
+         *
+         * The following list describes what you can and cannot due with this
+         * request:
+         * - You can modify or clear the following fields: Ref Num and Memo
+         * - You can modify (not clear) transaction date
+         * - You can change the credit card account to support the scenario where
+         *   the credit card transaction was created and posted to the wrong credit
+         *   card account (impacts your accounting).
+         * - You can modify the Purchase from field (Payee Name) to change the Payee
+         *   Name on the credit card transaction to a different name (employee, job,
+         *   customer, vendor, other name). This field cannot be cleared since it is
+         *   required by QB business logic
+         * - You cannot modify the amount due directly! (However the amount due will
+         *   change when you modify the transaction lines.)
+         * - You cannot change a Charge to a Credit.
+         * - You cannot Void the charge. Use TxnVoid instead.
+         * - You can clear the entire expense table or the entire item table, but
+         *   you cannot clear both tables at the same time.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CreditCardChargeMod
+         */
+        mod: (integrationConnectionId: string, params: QbdTypes.CreditCardChargeModRq["CreditCardChargeMod"]) => Promise<NonNullable<QbdTypes.CreditCardChargeModRs["CreditCardChargeRet"]>>;
+        /**
+         * Queries for the specified credit card charge or charges.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CreditCardChargeQuery
+         */
+        query: (integrationConnectionId: string, params: QbdTypes.CreditCardChargeQueryRq) => Promise<NonNullable<QbdTypes.CreditCardChargeQueryRs["CreditCardChargeRet"]>>;
+    };
+    creditCardCredit: {
+        /**
+         * If a QuickBooks user returns merchandise and receives credit, the credit
+         * is entered in QuickBooks and assigned to the appropriate expense account.
+         * Typically, the assigned expense account reflects the same account,
+         * customer, and class that were assigned when the merchandise was first
+         * purchased. (The original purchase would be described by a
+         * `CreditCardCharge` message.)
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CreditCardCreditAdd
+         */
+        add: (integrationConnectionId: string, params: QbdTypes.CreditCardCreditAddRq["CreditCardCreditAdd"]) => Promise<NonNullable<QbdTypes.CreditCardCreditAddRs["CreditCardCreditRet"]>>;
+        /**
+         * The Credit Card credit mod request allows you to modify an existing
+         * credit card credit transaction using the SDK. You can modify most of the
+         * fields that can be modified in the QuickBooks UI. That is, this request
+         * can be used to modify Purchased from, date, credit card and modify lines
+         * from the item table and the expense table.
+         *
+         * The following list describes what you can and cannot due with this
+         * request:
+         * - You can modify or clear the following fields: Ref Num and Memo
+         * - You can modify (not clear) transaction date
+         * - You can change the credit card account to support the scenario where
+         *   the credit card transaction was created and posted to the wrong credit
+         *   card account (impacts your accounting).
+         * - You can modify the Purchase from field (Payee Name) to change the Payee
+         *   Name on the credit card transaction to a different name (employee, job,
+         *   customer, vendor, other name). This field cannot be cleared since it is
+         *   required by QB business logic
+         * - You cannot modify the amount due directly! (However the amount due will
+         *   change when you modify the transaction lines.)
+         * - You cannot change a Credit to a Charge.
+         * - You cannot Void the credit. Use TxnVoid instead.
+         * - You can clear the entire expense table or the entire item table, but
+         *   you cannot clear both tables at the same time.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CreditCardCreditMod
+         */
+        mod: (integrationConnectionId: string, params: QbdTypes.CreditCardCreditModRq["CreditCardCreditMod"]) => Promise<NonNullable<QbdTypes.CreditCardCreditModRs["CreditCardCreditRet"]>>;
+        /**
+         * Queries for the specified credit or set of credits.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CreditCardCreditQuery
+         */
+        query: (integrationConnectionId: string, params: QbdTypes.CreditCardCreditQueryRq) => Promise<NonNullable<QbdTypes.CreditCardCreditQueryRs["CreditCardCreditRet"]>>;
+    };
     customer: {
         /**
          * The customer list includes information about the QuickBooks user’s
@@ -444,6 +565,27 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (integrationConnectionId: string, params: QbdTypes.CustomerQueryRq) => Promise<NonNullable<QbdTypes.CustomerQueryRs["CustomerRet"]>>;
     };
+    customerType: {
+        /**
+         * Customer types allow business owners to categorize customers in ways that
+         * are meaningful for their businesses. For example, a customer type might
+         * indicate which industry a customer represents, or which part of the
+         * country a customer is in.
+         *
+         * A `CustomerTypeRef` aggregate refers to one of the types on the
+         * CustomerType list. In a request, if a `CustomerTypeRef` aggregate
+         * includes both `FullName` and `ListID`, `FullName` will be ignored.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CustomerTypeAdd
+         */
+        add: (integrationConnectionId: string, params: QbdTypes.CustomerTypeAddRq["CustomerTypeAdd"]) => Promise<NonNullable<QbdTypes.CustomerTypeAddRs["CustomerTypeRet"]>>;
+        /**
+         * Queries for the specified customer type or set of types.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CustomerTypeQuery
+         */
+        query: (integrationConnectionId: string, params: QbdTypes.CustomerTypeQueryRq) => Promise<NonNullable<QbdTypes.CustomerTypeQueryRs["CustomerTypeRet"]>>;
+    };
     deposit: {
         /**
          * After you receive payments from customers (see `ReceivePayment`), you can
@@ -534,6 +676,60 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (integrationConnectionId: string, params: QbdTypes.EstimateQueryRq) => Promise<NonNullable<QbdTypes.EstimateQueryRs["EstimateRet"]>>;
     };
+    inventoryAdjustment: {
+        /**
+         * Adds an inventory adjustment.
+         *
+         * If the following conditions aren’t met, you will receive an error if you
+         * try to add an inventory adjustment through the SDK:
+         * - The QuickBooks company file must be open in single-user mode, unless
+         *   you are using QuickBooks Enterprise edition, which allows multi-user
+         *   mode for this request. (This is also true in the user interface: you
+         *   cannot adjust the inventory while the company file is open in
+         *   multi-user mode, again except for Enterprise.)
+         * - The inventory adjustment form must be closed in the QuickBooks user
+         *   interface.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/InventoryAdjustmentAdd
+         */
+        add: (integrationConnectionId: string, params: QbdTypes.InventoryAdjustmentAddRq["InventoryAdjustmentAdd"]) => Promise<NonNullable<QbdTypes.InventoryAdjustmentAddRs["InventoryAdjustmentRet"]>>;
+        /**
+         * Modifies an inventory adjustment.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/InventoryAdjustmentMod
+         */
+        mod: (integrationConnectionId: string, params: QbdTypes.InventoryAdjustmentModRq["InventoryAdjustmentMod"]) => Promise<NonNullable<QbdTypes.InventoryAdjustmentModRs["InventoryAdjustmentRet"]>>;
+        /**
+         * Queries for the specified inventory adjustment or set of inventory
+         * adjustments.
+         *
+         * You cannot query an inventory adjustment while the inventory adjustment
+         * form is open in the QuickBooks user interface.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/InventoryAdjustmentQuery
+         */
+        query: (integrationConnectionId: string, params: QbdTypes.InventoryAdjustmentQueryRq) => Promise<NonNullable<QbdTypes.InventoryAdjustmentQueryRs["InventoryAdjustmentRet"]>>;
+    };
+    inventorySite: {
+        /**
+         * Adds an inventory site.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/InventorySiteAdd
+         */
+        add: (integrationConnectionId: string, params: QbdTypes.InventorySiteAddRq["InventorySiteAdd"]) => Promise<NonNullable<QbdTypes.InventorySiteAddRs["InventorySiteRet"]>>;
+        /**
+         * Modifies an inventory site.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/InventorySiteMod
+         */
+        mod: (integrationConnectionId: string, params: QbdTypes.InventorySiteModRq["InventorySiteMod"]) => Promise<NonNullable<QbdTypes.InventorySiteModRs["InventorySiteRet"]>>;
+        /**
+         * Queries for the specified inventory site or set of inventory sites.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/InventorySiteQuery
+         */
+        query: (integrationConnectionId: string, params: QbdTypes.InventorySiteQueryRq) => Promise<NonNullable<QbdTypes.InventorySiteQueryRs["InventorySiteRet"]>>;
+    };
     invoice: {
         /**
          * Adds an invoice.
@@ -628,8 +824,9 @@ export default class QbdIntegration extends BaseIntegration {
          */
         add: (integrationConnectionId: string, params: QbdTypes.ItemDiscountAddRq["ItemDiscountAdd"]) => Promise<NonNullable<QbdTypes.ItemDiscountAddRs["ItemDiscountRet"]>>;
         /**
-         * Modifies a discount item. Starting with qbXML spec 7.0, you can modify
-         * the account ref, using the AccountRef aggregate and the
+         * Modifies a discount item.
+         *
+         * You can modify the account ref, using the `AccountRef` aggregate and the
          * `ApplyAccountRefToExistingTxns` boolean. You need to use the
          * `ApplyAccountRefToExistingTxns` boolean because the QuickBooks UI
          * displays a prompt asking whether the change should apply to existing
@@ -1310,6 +1507,76 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (integrationConnectionId: string, params: QbdTypes.PurchaseOrderQueryRq) => Promise<NonNullable<QbdTypes.PurchaseOrderQueryRs["PurchaseOrderRet"]>>;
     };
+    salesReceipt: {
+        /**
+         * Adds a sales receipt to QuickBooks.
+         *
+         * Notice that access to sensitive data permissions are not required to use
+         * this request. However, if the application does not have access to
+         * sensitive data permission, then the response returned will not contain
+         * certain sensitive data. For example, even if credit card data is supplied
+         * in the `SalesReceiptAdd` request via the `CreditCardTxnInfo` aggregate,
+         * the response will not contain the corresponding aggregate.
+         *
+         * Sales receipts are used to record point-of-sale payments. Sales receipts
+         * include payments by cash, check, or credit card. Note: If full payment is
+         * not received at the time of the sale, do not use a sales receipt.
+         * Instead, use an invoice transaction and record the partial payment using
+         * a payment item.
+         *
+         * IMPORTANT: In a `SalesReceiptAdd` or `ReceivePaymentAdd` request that
+         * contains credit card transaction data supplied from QBMS transaction
+         * responses, you must specify the payment method (using the
+         * `PaymentMethodRef` aggregate).
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/SalesReceiptAdd
+         */
+        add: (integrationConnectionId: string, params: QbdTypes.SalesReceiptAddRq["SalesReceiptAdd"]) => Promise<NonNullable<QbdTypes.SalesReceiptAddRs["SalesReceiptRet"]>>;
+        /**
+         * Modifies an existing Sales receipt.
+         *
+         * IMPORTANT: In a `SalesReceiptMod` request that contains credit card
+         * transaction data supplied from QBMS transaction responses, you cannot
+         * change the total amount recorded in the sale.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/SalesReceiptMod
+         */
+        mod: (integrationConnectionId: string, params: QbdTypes.SalesReceiptModRq["SalesReceiptMod"]) => Promise<NonNullable<QbdTypes.SalesReceiptModRs["SalesReceiptRet"]>>;
+        /**
+         * Queries for the specified sales receipt or set of receipts.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/SalesReceiptQuery
+         */
+        query: (integrationConnectionId: string, params: QbdTypes.SalesReceiptQueryRq) => Promise<NonNullable<QbdTypes.SalesReceiptQueryRs["SalesReceiptRet"]>>;
+    };
+    salesRep: {
+        /**
+         * Adds a sales rep.
+         *
+         * The sales representative must be on the Employee, Vendor, or Other Names
+         * list within QuickBooks. Sales representative’s names and initials appear
+         * on the Rep drop-down list on QuickBooks sales forms.
+         *
+         * A `SalesRepRef` refers to a person on the `SalesRep` list. In a request,
+         * if a `SalesRepRef` aggregate includes both `FullName` and `ListID`,
+         * `FullName` will be ignored.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/SalesRepAdd
+         */
+        add: (integrationConnectionId: string, params: QbdTypes.SalesRepAddRq["SalesRepAdd"]) => Promise<NonNullable<QbdTypes.SalesRepAddRs["SalesRepRet"]>>;
+        /**
+         * Modifies a sales rep record.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/SalesRepMod
+         */
+        mod: (integrationConnectionId: string, params: QbdTypes.SalesRepModRq["SalesRepMod"]) => Promise<NonNullable<QbdTypes.SalesRepModRs["SalesRepRet"]>>;
+        /**
+         * Queries for the specified sales rep or set of reps.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/SalesRepQuery
+         */
+        query: (integrationConnectionId: string, params: QbdTypes.SalesRepQueryRq) => Promise<NonNullable<QbdTypes.SalesRepQueryRs["SalesRepRet"]>>;
+    };
     timeTracking: {
         /**
          * The time-tracking transactions that are returned in this query include