conductor-node 8.0.3 → 8.2.0

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

@@ -287,6 +287,40 @@ class QbdIntegration extends BaseIntegration_1.default {
          */
         query: async (integrationConnectionId, params) => this.sendRequestBase(integrationConnectionId, { BillPaymentCheckQueryRq: params }, "BillPaymentCheckQueryRs", "BillPaymentCheckRet"),
     };
+    charge = {
+        /**
+         * Adds a customer charge. A `Charge` contains information about a statement
+         * charge. (A `CreditCardCharge` object, on the other hand, refers to a
+         * credit card charge incurred by the QuickBooks user.)
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ChargeAdd
+         */
+        add: async (integrationConnectionId, params) => this.sendRequestBase(integrationConnectionId, { ChargeAddRq: { ChargeAdd: params } }, "ChargeAddRs", "ChargeRet"),
+        /**
+         * Modifies the specified charge.
+         *
+         * Some fields in a `ChargeMod` request cannot be cleared. If any of the
+         * following fields is included in a charge modify request, it must contain
+         * a value:
+         * - `CustomerRef`
+         * - `TxnDate`
+         * - `ItemRef`
+         * - `Quantity`
+         * - `Rate`
+         * - `Amount`
+         * - `ARAccountRef`
+         * - `OverrideItemAccountRef`
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ChargeMod
+         */
+        mod: async (integrationConnectionId, params) => this.sendRequestBase(integrationConnectionId, { ChargeModRq: { ChargeMod: params } }, "ChargeModRs", "ChargeRet"),
+        /**
+         * Returns information about statement charges.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ChargeQuery
+         */
+        query: async (integrationConnectionId, params) => this.sendRequestBase(integrationConnectionId, { ChargeQueryRq: params }, "ChargeQueryRs", "ChargeRet"),
+    };
     check = {
         /**
          * The amount of a check is the total of the amounts assigned to expense
@@ -458,6 +492,211 @@ class QbdIntegration extends BaseIntegration_1.default {
          */
         query: async (integrationConnectionId, params) => this.sendRequestBase(integrationConnectionId, { EmployeeQueryRq: params }, "EmployeeQueryRs", "EmployeeRet"),
     };
+    estimate = {
+        /**
+         * Adds an estimate. A QuickBooks estimate is a description of a sale that
+         * the QuickBooks user proposes to make to a current or prospective
+         * customer. An estimate might also be called a “bid” or a “proposal.” In
+         * QuickBooks, estimates and invoices use similar fields, and an estimate
+         * can be converted into an invoice after the customer accepts the estimate.
+         *
+         * An estimate is a non-posting transaction, so it does not affect a
+         * company’s balance sheet or income statement.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/EstimateAdd
+         */
+        add: async (integrationConnectionId, params) => this.sendRequestBase(integrationConnectionId, { EstimateAddRq: { EstimateAdd: params } }, "EstimateAddRs", "EstimateRet"),
+        /**
+         * Modifies the specified estimate.
+         *
+         * Some fields in an `EstimateMod` request cannot be cleared. If any of the
+         * following fields is included in an estimate modify request, it must
+         * contain a value:
+         * - `CustomerRef`
+         * - `TemplateRef`
+         * - `TxnDate`
+         * - `IsActive`
+         * - `CreateChangeOrder`
+         * - `DueDate`
+         * - `ItemSalesTaxRef`
+         *
+         * Within `EstimateLineMod` or `EstimateLineGroupMod`:
+         * - `ItemRef`
+         * - `Quantity`
+         * - `Rate`
+         * - `Amount`>
+         * - `SalesTaxCodeRef`
+         * - `Markup`
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/EstimateMod
+         */
+        mod: async (integrationConnectionId, params) => this.sendRequestBase(integrationConnectionId, { EstimateModRq: { EstimateMod: params } }, "EstimateModRs", "EstimateRet"),
+        /**
+         * Queries for the specified estimate or set of estimates.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/EstimateQuery
+         */
+        query: async (integrationConnectionId, params) => this.sendRequestBase(integrationConnectionId, { EstimateQueryRq: params }, "EstimateQueryRs", "EstimateRet"),
+    };
+    invoice = {
+        /**
+         * Adds an invoice.
+         *
+         * An invoice records the amount owed by a customer who purchased goods or
+         * services but did not pay in full at the time of the sale. If full payment
+         * is received at the time of the sale, it is recorded as a sales receipt,
+         * not an invoice.
+         *
+         * In QuickBooks, invoices and estimates use similar fields, and an estimate
+         * can be converted into an invoice after the customer accepts the estimate.
+         * However, in the SDK, there is currently no ability to create an invoice
+         * directly from an estimate (you cannot link an invoice to an estimate).
+         *
+         * If you Add an invoice that has an inventory item on it, QB will
+         * automatically calculate COGS and post it to the COGS account. (The
+         * inventory item will need to be setup to post to the COGS account and must
+         * have a unit cost in it.) However, notice that such an InvoiceAdd has
+         * sales prices, not cost, so the Add is not impacting the cost of the item.
+         * The cost of the item is only affected by purchases (bills and item
+         * receipts) sales and inventory adjustments.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/InvoiceAdd
+         */
+        add: async (integrationConnectionId, params) => this.sendRequestBase(integrationConnectionId, { InvoiceAddRq: { InvoiceAdd: params } }, "InvoiceAddRs", "InvoiceRet"),
+        /**
+         * Modifies an existing invoice. If you are modifying existing line items,
+         * supply an `InvoiceLineMod` and `TxnLineID` for each line you want to
+         * modify. If you want to add a new line, supply an `InvoiceLineMod` with
+         * its `TxnLineID` value set to -1.
+         *
+         * Some fields in an `InvoiceMod` request cannot be cleared. If any of the
+         * following fields is included in an invoice modify request, it must
+         * contain a value:
+         * - `CustomerRef`
+         * - `ARAccountRef`
+         * - `TemplateRef`
+         * - `TxnDate`
+         * - `IsPending`
+         * - `DueDate`
+         * - `ItemSalesTaxRef`
+         * - `ShipDate`
+         * - `IsToBePrinted`
+         *
+         * Within `InvoiceLineMod` or `InvoiceLineGroupMod`:
+         * - `ItemRef`
+         * - `Quantity`
+         * - `Rate`
+         * - `Amount`
+         * - `SalesTaxCodeRef`
+         * - `OverrideItemAccountRef`
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/InvoiceMod
+         */
+        mod: async (integrationConnectionId, params) => this.sendRequestBase(integrationConnectionId, { InvoiceModRq: { InvoiceMod: params } }, "InvoiceModRs", "InvoiceRet"),
+        /**
+         * Returns invoice data.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/InvoiceQuery
+         */
+        query: async (integrationConnectionId, params) => this.sendRequestBase(integrationConnectionId, { InvoiceQueryRq: params }, "InvoiceQueryRs", "InvoiceRet"),
+    };
+    itemInventory = {
+        /**
+         * Adds an inventory item. An inventory item is any merchandise or part that
+         * a business purchases, tracks as inventory, and then resells. In
+         * QuickBooks, information about an inventory item is grouped into three
+         * categories:
+         * 1. Purchase Information includes `PurchaseDesc`, `PurchaseCost`,
+         *    `COGSAccountRef`, and `PrefVendorRef`.
+         * 2. Sales Information includes `SalesDesc`, `SalesPrice`, and
+         *    `SalesTaxCodeRef`.
+         * 3. Inventory Information includes `AssetAccountRef`, `ReorderPoint`,
+         *    `QuantityOnHand`, `TotalValue`, and `InventoryDate`.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemInventoryAdd
+         */
+        add: async (integrationConnectionId, params) => this.sendRequestBase(integrationConnectionId, { ItemInventoryAddRq: { ItemInventoryAdd: params } }, "ItemInventoryAddRs", "ItemInventoryRet"),
+        /**
+         * Modifies an inventory item.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemInventoryMod
+         */
+        mod: async (integrationConnectionId, params) => this.sendRequestBase(integrationConnectionId, { ItemInventoryModRq: { ItemInventoryMod: params } }, "ItemInventoryModRs", "ItemInventoryRet"),
+        /**
+         * Queries for the specified inventory item or set of items.
+         *
+         * Notice that certain modifications to the item can be caused by other
+         * transactions, such as `ItemReceipts` where the item’s on hand quantity is
+         * increased. Modifications through these transactions do not result in
+         * changing the `TimeModified` stamp (only the `Mod` operation will do
+         * that), but those changes will be detected when you use the
+         * `FromModifiedDate`/`ToModifiedDate` filters in your query. Notice that
+         * you cannot get an inventory asset value from QuickBooks using this query.
+         * Instead, you need to use the General Summary Report query (which
+         * currently doesn’t include Assembly Items). Suppose you needed a way to
+         * search for the amount on hand of items that have had their amount changed
+         * since a certain date. Again, you would not use this query, but a
+         * `GeneralDetailReportQuery` that has its `GeneralDetailReportType` set to
+         * “InventoryValuationDetail”. This will tell you which items changed by how
+         * much. Also, suppose you wanted the on-hand quantity from QB as of a
+         * specific date. You would use a General Summary Report of the type
+         * Inventory Valuation Summary. (Again, this report doesn’t include
+         * Inventory Assemblies.)
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemInventoryQuery
+         */
+        query: async (integrationConnectionId, params) => this.sendRequestBase(integrationConnectionId, { ItemInventoryQueryRq: params }, "ItemInventoryQueryRs", "ItemInventoryRet"),
+    };
+    itemNonInventory = {
+        /**
+         * Adds a non-inventory item, which is any material or part that a business
+         * buys but does not keep on hand as inventory. There are two types of
+         * non-inventory items:
+         * 1. Materials or parts that are part of the business’s overhead (for
+         *    example, office supplies
+         * 2. Materials or parts that the business buys to finish a specific job and
+         *    then charges back to the customer.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemNonInventoryAdd
+         */
+        add: async (integrationConnectionId, params) => this.sendRequestBase(integrationConnectionId, { ItemNonInventoryAddRq: { ItemNonInventoryAdd: params } }, "ItemNonInventoryAddRs", "ItemNonInventoryRet"),
+        /**
+         * Modifies a non inventory item.
+         *
+         * About `SalesOrPurchaseMod` versus `SalesAndPurchaseMod` in an
+         * `ItemNonInventoryMod` request: You cannot change the reimbursable status
+         * of a non-inventory item through the SDK. For example, if a non-inventory
+         * item is marked as non-reimbursable in QuickBooks, you cannot send a
+         * modify request that includes a `SalesAndPurchaseMod` aggregate.
+         * Similarly, if you send an `ItemNonInventoryAdd` request that includes a
+         * `SalesOrPurchase` aggregate, you cannot later modify that item using a
+         * `SalesAndPurchaseMod` aggregate.
+         *
+         * You can modify the various account references using the appropriate
+         * account reference aggregate and the matching Apply Account
+         * `RefToExistingTxns` boolean. You need to use the boolean when you change
+         * an account ref because the QuickBooks UI displays a prompt asking whether
+         * the change should apply to existing transactions or not. Specifying True
+         * for the boolean basically dismisses this with a “Yes” answer, allowing
+         * your changes to be made and changes any existing transactions that use
+         * the item with that `AccountRef`. Specifying “False” means that the mod will
+         * not take affect if there are existing transactions. Setting this to
+         * “True” should be used with caution and normally only after some user has
+         * indicated that they want those changes made to all those existing
+         * transactions! If any affected transactions are protected by a closing
+         * date and password, the `AccountRef` changes will not be made and so the Mod
+         * request will return an error without making the requested Mod.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemNonInventoryMod
+         */
+        mod: async (integrationConnectionId, params) => this.sendRequestBase(integrationConnectionId, { ItemNonInventoryModRq: { ItemNonInventoryMod: params } }, "ItemNonInventoryModRs", "ItemNonInventoryRet"),
+        /**
+         * Queries for the specified non-inventory item or set of items.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemNonInventoryQuery
+         */
+        query: async (integrationConnectionId, params) => this.sendRequestBase(integrationConnectionId, { ItemNonInventoryQueryRq: params }, "ItemNonInventoryQueryRs", "ItemNonInventoryRet"),
+    };
     itemService = {
         /**
          * Adds a service item, which is an item that refers to services that a
@@ -633,6 +872,47 @@ class QbdIntegration extends BaseIntegration_1.default {
          */
         query: async (integrationConnectionId, params) => this.sendRequestBase(integrationConnectionId, { TimeTrackingQueryRq: params }, "TimeTrackingQueryRs", "TimeTrackingRet"),
     };
+    purchaseOrder = {
+        /**
+         * Adds a purchase order, which is an order submitted to a vendor. You can
+         * use ItemReceiptAdd to receive items against a purchase order as items
+         * arrive from the vendor. A purchase order is a non-posting transaction, so
+         * it does not affect a company’s balance sheet or income statement.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/PurchaseOrderQuery
+         */
+        add: async (integrationConnectionId, params) => this.sendRequestBase(integrationConnectionId, { PurchaseOrderAddRq: { PurchaseOrderAdd: params } }, "PurchaseOrderAddRs", "PurchaseOrderRet"),
+        /**
+         * Modifies a purchase order.
+         *
+         * Some fields in a `PurchaseOrderMod` request cannot be cleared. If any of
+         * the following fields is included in a purchase order modify request, it
+         * must contain a value:
+         * - `TemplateRef`
+         * - `TxnDate`
+         * - `DueDate`
+         * - `ExpectedDate`
+         * - `IsManuallyClosed`
+         * - `IsToBePrinted`
+         *
+         * Within `PurchaseOrderLineMod` or `PurchaseOrderLineGroupMod`:
+         * - `ItemRef`
+         * - `Quantity`
+         * - `Rate`
+         * - `Amount`
+         * - `IsManuallyClosed`
+         * - `OverrideItemAccountRef`
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/PurchaseOrderMod
+         */
+        mod: async (integrationConnectionId, params) => this.sendRequestBase(integrationConnectionId, { PurchaseOrderModRq: { PurchaseOrderMod: params } }, "PurchaseOrderModRs", "PurchaseOrderRet"),
+        /**
+         * Queries for the specified purchase order or set of orders.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/PurchaseOrderQuery
+         */
+        query: async (integrationConnectionId, params) => this.sendRequestBase(integrationConnectionId, { PurchaseOrderQueryRq: params }, "PurchaseOrderQueryRs", "PurchaseOrderRet"),
+    };
     vendor = {
         /**
          * Adds a vendor.
@@ -668,7 +948,7 @@ class QbdIntegration extends BaseIntegration_1.default {
      * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop
      */
     async sendRequest(integrationConnectionId, requestObject) {
-        return this.client.sendIntegrationRequest({
+        return this.sendIntegrationRequest({
             integrationConnectionId,
             requestObject,
         });