conductor-node 0.4.1 → 1.0.1

package/dist/src/qbd/ClientQBD.js

@@ -1,266 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const BaseClient_1 = __importDefault(require("../BaseClient"));
-class ClientQBD extends BaseClient_1.default {
-    account = {
-        /**
-         * Perform the same activities as a user does in the QB New Account form,
-         * which can be accessed in QB by selecting "Lists" → "Chart of Accounts" →
-         * "Accounts" → "New".
-         *
-         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/AccountAdd
-         */
-        add: async (qbwcUsername, params) => this.sendRequestBase(qbwcUsername, { AccountAddRq: { AccountAdd: params } }, "AccountAddRs", "AccountRet"),
-        /**
-         * Modifies an account.
-         *
-         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/AccountMod
-         */
-        mod: async (qbwcUsername, params) => this.sendRequestBase(qbwcUsername, { AccountModRq: { AccountMod: params } }, "AccountModRs", "AccountRet"),
-        /**
-         * `AccountQuery` is a list query that returns data for all accounts that
-         * match the provided filter criteria. Notice that it returns only data
-         * internal to the account itself. It does not return any data about
-         * transactions involving the account. It does, however, return the parent
-         * account, if there is one. You can search across all accounts or you can
-         * specify an account type and search only those.
-         *
-         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/AccountQuery
-         */
-        query: async (qbwcUsername, params) => this.sendRequestBase(qbwcUsername, { AccountQueryRq: params }, "AccountQueryRs", "AccountRet"),
-    };
-    customer = {
-        /**
-         * The customer list includes information about the QuickBooks user’s
-         * customers and the individual jobs that are being performed for them. A
-         * `CustomerRef` aggregate refers to one of the customers (or customer jobs)
-         * on the list. In a request, if a `CustomerRef` aggregate includes both
-         * `FullName` and `ListID`, `FullName` will be ignored. Special cases to
-         * note:
-         *
-         * - In `SalesReceipt` and `ReceivePayment` requests, `CustomerRef` refers
-         *   to the customer or customer job to which the payment is credited.
-         *
-         * - In a `TimeTracking` request, CustomerRef refers to the customer or
-         *   customer job to which this time could be billed. If `IsBillable` is set
-         *   to true, `CustomerRef` is required in `TimeTrackingAdd`.
-         *
-         * - In an `ExpenseLineAdd` request, if `AccountRef` refers to an A/P
-         *   account, `CustomerRef` must refer to a vendor (not to a customer). If
-         *   `AccountRef` refers to any other type of account, the `CustomerRef`
-         *   must refer to a customer.
-         *
-         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CustomerAdd
-         */
-        add: async (qbwcUsername, params) => this.sendRequestBase(qbwcUsername, { CustomerAddRq: { CustomerAdd: params } }, "CustomerAddRs", "CustomerRet"),
-        /**
-         * Modifies the customer record.
-         *
-         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CustomerMod
-         */
-        mod: async (qbwcUsername, params) => this.sendRequestBase(qbwcUsername, { CustomerModRq: { CustomerMod: params } }, "CustomerModRs", "CustomerRet"),
-        /**
-         * Returns data for the specified customers.
-         *
-         * Important: We highly recommend that you use the `IncludeRetElement` tag
-         * in your `CustomerQuery` to include any data you want but do NOT include
-         * the `ShipAddress` data in the `Response`, unless you need to get the
-         * shipping address for a particular customer. Excluding the shipping
-         * address data will significantly improve the performance of the
-         * `CustomerQuery`.
-         *
-         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CustomerQuery
-         */
-        query: async (qbwcUsername, params) => this.sendRequestBase(qbwcUsername, { CustomerQueryRq: params }, "CustomerQueryRs", "CustomerRet"),
-    };
-    employee = {
-        /**
-         * Adds an employee with personal data about the employee as well as certain
-         * payroll-related data.
-         *
-         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/EmployeeAdd
-         */
-        add: async (qbwcUsername, params) => this.sendRequestBase(qbwcUsername, { EmployeeAddRq: { EmployeeAdd: params } }, "EmployeeAddRs", "EmployeeRet"),
-        /**
-         * Modifies an existing employee.
-         *
-         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/EmployeeMod
-         */
-        mod: async (qbwcUsername, params) => this.sendRequestBase(qbwcUsername, { EmployeeModRq: { EmployeeMod: params } }, "EmployeeModRs", "EmployeeRet"),
-        /**
-         * Returns employee data.
-         *
-         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/EmployeeQuery
-         */
-        query: async (qbwcUsername, params) => this.sendRequestBase(qbwcUsername, { EmployeeQueryRq: params }, "EmployeeQueryRs", "EmployeeRet"),
-    };
-    journalEntry = {
-        /**
-         * The debit and credit lines can be intermingled. A credit line can legally
-         * come first in the journal entry add.
-         *
-         * In traditional accounting, transactions are entered into the general
-         * journal and categorized exclusively by account. In QuickBooks, most
-         * transactions can be categorized either by account or by type (invoice,
-         * check, and so on). For a few activities in QuickBooks, you must use the
-         * general journal directly, for example for recording depreciation. Notice
-         * that you must supply the credit line and a corresponding debit line in
-         * the same request. It will not work to supply them in two distinct
-         * requests. You can supply as many credit lines and debit lines in one
-         * single request as you want so long as the total monetary amount from the
-         * credits equals the total monetary amount from the debits in that request.
-         *
-         * Finally, DO NOT supply negative sign for the monetary amounts. QuickBooks
-         * does that for you. If you do supply the negative sign, amounts will add
-         * instead of cancel and you’ll get a runtime error.
-         *
-         * Querying for Condensed Transactions: If you need the query to return
-         * condensed transactions, you can do this by using either an `Entity` or
-         * `Account` filter in the journal query request. Alternatively, you could
-         * use the The generic `TransactionQuery`, which can return condensed
-         * transactions.
-         *
-         * If the transaction is a home currency adjustment, QuickBooks will ignore
-         * the `IsAmountsEnteredInHomeCurrency`, `CurrencyRef`, and `ExchangeRate`
-         * elements.
-         *
-         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/JournalEntryAdd
-         */
-        add: async (qbwcUsername, params) => this.sendRequestBase(qbwcUsername, { JournalEntryAddRq: { JournalEntryAdd: params } }, "JournalEntryAddRs", "JournalEntryRet"),
-        /**
-         * Modifies a journal entry.
-         *
-         * If the transaction is a home currency adjustment, QuickBooks will ignore
-         * the `IsAmountsEnteredInHomeCurrency`, `CurrencyRef`, and `ExchangeRate`
-         * elements.
-         *
-         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/JournalEntryMod
-         */
-        mod: async (qbwcUsername, params) => this.sendRequestBase(qbwcUsername, { JournalEntryModRq: { JournalEntryMod: params } }, "JournalEntryModRs", "JournalEntryRet"),
-        /**
-         * In traditional accounting, transactions are entered into the general
-         * journal and categorized exclusively by account. In QuickBooks, most
-         * transactions can be categorized either by account or by type (invoice,
-         * check, and so on). For a few activities in QuickBooks, you must use the
-         * general journal directly, for example for recording depreciation. Notice
-         * that you must supply the credit line and a corresponding debit line in
-         * the same request. It will not work to supply them in two distinct
-         * requests. You can supply as many credit lines and debit lines in one
-         * single request as you want so long as the total monetary amount from the
-         * credits equals the total monetary amount from the debits in that request.
-         *
-         * Finally, DO NOT supply negative sign for the monetary amounts. QuickBooks
-         * does that for you. If you do supply the negative sign, amounts will add
-         * instead of cancel and you’ll get a runtime error.
-         *
-         * Querying for Condensed Transactions: If you need the query to return
-         * condensed transactions, you can do this by using either an `Entity` or
-         * `Account` filter in the journal query request. Alternatively, you could
-         * use the The generic `TransactionQuery`, which can return condensed
-         * transactions.
-         *
-         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/JournalEntryQuery
-         */
-        query: async (qbwcUsername, params) => this.sendRequestBase(qbwcUsername, { JournalEntryQueryRq: params }, "JournalEntryQueryRs", "JournalEntryRet"),
-    };
-    timeTracking = {
-        /**
-         * The time-tracking transactions that are returned in this query include
-         * time tracking information that was entered into QuickBooks manually or
-         * gathered using the QuickBooks “Timer” or “Stopwatch.” Note that the
-         * QuickBooks Timer application can run on its own without QuickBooks, but
-         * the QuickBooks SDK cannot access the Timer data directly. The Timer data
-         * must be imported into QuickBooks before it is accessible via the SDK.)
-         *
-         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TimeTrackingQuery
-         */
-        add: async (qbwcUsername, params) => this.sendRequestBase(qbwcUsername, { TimeTrackingAddRq: { TimeTrackingAdd: params } }, "TimeTrackingAddRs", "TimeTrackingRet"),
-        /**
-         * Modifies a time tracking transaction.
-         *
-         * This allows you to modify time entry and mark time entered as billed.
-         * Applications using qbXML spec levels less than 6.0 aren’t able to Modify
-         * a time tracking transaction. However, those applications can achieve the
-         * results of a modify operation by deleting the time tracking transaction
-         * (using `TxnDelRq`) and then re-adding it with the desired values. You can
-         * do this only if no other downstream transactions have used that
-         * particular time tracking transaction. (Otherwise, the `TxnDel` request
-         * will fail.) This differs slightly from the UI, which allows these
-         * transactions to be edited directly. However, even in the UI, modifying a
-         * time tracking transaction does not result in changes to any downstream
-         * transactions that use it. There is no link between an invoice and the
-         * time entries. However when you do the invoicing from QuickBooks,
-         * QuickBooks does mark the time entries as “billed.” If you don’t record
-         * the time entries as billed properly, then you get into a user workflow
-         * issue where every time the user creates an invoice for a customer, QB
-         * pops up a dialog asking if they want to bill the un-billed time (which
-         * you already billed from your app). That’s why beginning with QB2007 and
-         * qbXML spec 6.0 we added support for the “BillableStatus” field *and* add
-         * `TimeTrackingMod` so that you can mark the time as billed when you create
-         * an invoice for it.
-         *
-         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TimeTrackingMod
-         */
-        mod: async (qbwcUsername, params) => this.sendRequestBase(qbwcUsername, { TimeTrackingModRq: { TimeTrackingMod: params } }, "TimeTrackingModRs", "TimeTrackingRet"),
-        /**
-         * The time-tracking transactions that are returned in this query include
-         * time tracking information that was entered into QuickBooks manually or
-         * gathered using the QuickBooks “Timer” or “Stopwatch.” Note that the
-         * QuickBooks Timer application can run on its own without QuickBooks, but
-         * the QuickBooks SDK cannot access the Timer data directly. The Timer data
-         * must be imported into QuickBooks before it is accessible via the SDK.)
-         *
-         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TimeTrackingQuery
-         */
-        query: async (qbwcUsername, params) => this.sendRequestBase(qbwcUsername, { TimeTrackingQueryRq: params }, "TimeTrackingQueryRs", "TimeTrackingRet"),
-    };
-    vendor = {
-        /**
-         * Adds a vendor.
-         *
-         * A vendor is any person or company from whom a small business owner buys
-         * goods and services. (Banks and tax agencies usually are included on the
-         * vendor list.) A company’s vendor list contains information such as
-         * account balance and contact information about each vendor. A `VendorRef`
-         * aggregate refers to one of the vendors on the list. In a request, if a
-         * `VendorRef` aggregate includes both `FullName` and `ListID`, `FullName`
-         * will be ignored.
-         *
-         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/VendorAdd
-         */
-        add: async (qbwcUsername, params) => this.sendRequestBase(qbwcUsername, { VendorAddRq: { VendorAdd: params } }, "VendorAddRs", "VendorRet"),
-        /**
-         * Modifies a vendor.
-         *
-         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/VendorMod
-         */
-        mod: async (qbwcUsername, params) => this.sendRequestBase(qbwcUsername, { VendorModRq: { VendorMod: params } }, "VendorModRs", "VendorRet"),
-        /**
-         * Queries for the specified vendor or set of vendors.
-         *
-         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/VendorQuery
-         */
-        query: async (qbwcUsername, params) => this.sendRequestBase(qbwcUsername, { VendorQueryRq: params }, "VendorQueryRs", "VendorRet"),
-    };
-    /**
-     * Send any QBXML request to QuickBooks Desktop.
-     *
-     * Available APIs:
-     * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop
-     */
-    async sendRequest(qbwcUsername, requestObj) {
-        return this.sendAPIRequest("qbd", qbwcUsername, requestObj);
-    }
-    async sendRequestBase(qbwcUsername, params, responseKey, responseBodyKey) {
-        const response = (await this.sendRequest(qbwcUsername, params));
-        const responseBody = response[responseKey]?.[responseBodyKey];
-        if (responseBody == null) {
-            throw new Error("No response");
-        }
-        return responseBody;
-    }
-}
-exports.default = ClientQBD;