conductor-node 0.2.1 → 0.4.0

package/README.md

@@ -25,8 +25,8 @@ To send a request to a specific QuickBooks Desktop user, you must also supply th
 import Conductor from "conductor-node";
 const conductor = new Conductor({ apiKey: "sk_test_..." });
 
-conductor.qbd
-  .accountAdd("mock_qbwc_username", {
+conductor.qbd.account
+  .add("mock_qbwc_username", {
     Name: "Test Account",
     AccountType: "Bank",
     OpenBalance: "100",

package/dist/src/qbd/ClientQBD.d.ts

@@ -4,167 +4,197 @@ export interface QBXMLObj {
     [apiName: string]: object;
 }
 export default class ClientQBD extends BaseClient {
+    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: (qbwcUsername: string, params: qbd.AccountAddRq["AccountAdd"]) => Promise<qbd.AccountAddRs["AccountRet"]>;
+        /**
+         * Modifies an account.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/AccountMod
+         */
+        mod: (qbwcUsername: string, params: qbd.AccountModRq["AccountMod"]) => Promise<qbd.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: (qbwcUsername: string, params: qbd.AccountQueryRq) => Promise<qbd.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: (qbwcUsername: string, params: qbd.CustomerAddRq["CustomerAdd"]) => Promise<qbd.CustomerAddRs["CustomerRet"]>;
+        /**
+         * Modifies the customer record.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CustomerMod
+         */
+        mod: (qbwcUsername: string, params: qbd.CustomerModRq["CustomerMod"]) => Promise<qbd.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: (qbwcUsername: string, params: qbd.CustomerQueryRq) => Promise<qbd.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: (qbwcUsername: string, params: qbd.EmployeeAddRq["EmployeeAdd"]) => Promise<qbd.EmployeeAddRs["EmployeeRet"]>;
+        /**
+         * Modifies an existing employee.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/EmployeeMod
+         */
+        mod: (qbwcUsername: string, params: qbd.EmployeeModRq["EmployeeMod"]) => Promise<qbd.EmployeeModRs["EmployeeRet"]>;
+        /**
+         * Returns employee data.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/EmployeeQuery
+         */
+        query: (qbwcUsername: string, params: qbd.EmployeeQueryRq) => Promise<qbd.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: (qbwcUsername: string, params: qbd.JournalEntryAddRq) => Promise<qbd.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: (qbwcUsername: string, params: qbd.JournalEntryModRq["JournalEntryMod"]) => Promise<qbd.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: (qbwcUsername: string, params: qbd.JournalEntryQueryRq) => Promise<qbd.JournalEntryQueryRs["JournalEntryRet"]>;
+    };
+    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: (qbwcUsername: string, params: qbd.VendorAddRq["VendorAdd"]) => Promise<qbd.VendorAddRs["VendorRet"]>;
+        /**
+         * Modifies a vendor.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/VendorMod
+         */
+        mod: (qbwcUsername: string, params: qbd.VendorModRq["VendorMod"]) => Promise<qbd.VendorModRs["VendorRet"]>;
+        /**
+         * Queries for the specified vendor or set of vendors.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/VendorQuery
+         */
+        query: (qbwcUsername: string, params: qbd.VendorQueryRq) => Promise<qbd.VendorQueryRs["VendorRet"]>;
+    };
     /**
      * Send any QBXML request to QuickBooks Desktop.
      *
      * Available APIs: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop
      */
     sendRequest(qbwcUsername: string, requestObj: QBXMLObj): Promise<QBXMLObj>;
-    /**
-     * 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
-     */
-    accountAdd(qbwcUsername: string, params: qbd.AccountAddRq["AccountAdd"]): Promise<qbd.AccountAddRs["AccountRet"]>;
-    /**
-     * Modifies an account.
-     *
-     * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/AccountMod
-     */
-    accountMod(qbwcUsername: string, params: qbd.AccountModRq["AccountMod"]): Promise<qbd.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
-     */
-    accountQuery(qbwcUsername: string, params: qbd.AccountQueryRq): Promise<qbd.AccountQueryRs["AccountRet"]>;
-    /**
-     * 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
-     */
-    customerAdd(qbwcUsername: string, params: qbd.CustomerAddRq["CustomerAdd"]): Promise<qbd.CustomerAddRs["CustomerRet"]>;
-    /**
-     * Modifies the customer record.
-     *
-     * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CustomerMod
-     */
-    customerMod(qbwcUsername: string, params: qbd.CustomerModRq["CustomerMod"]): Promise<qbd.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
-     */
-    customerQuery(qbwcUsername: string, params: qbd.CustomerQueryRq): Promise<qbd.CustomerQueryRs["CustomerRet"]>;
-    /**
-     * 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
-     */
-    employeeAdd(qbwcUsername: string, params: qbd.EmployeeAddRq["EmployeeAdd"]): Promise<qbd.EmployeeAddRs["EmployeeRet"]>;
-    /**
-     * Modifies an existing employee.
-     *
-     * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/EmployeeMod
-     */
-    employeeMod(qbwcUsername: string, params: qbd.EmployeeModRq["EmployeeMod"]): Promise<qbd.EmployeeModRs["EmployeeRet"]>;
-    /**
-     * Returns employee data.
-     *
-     * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/EmployeeQuery
-     */
-    employeeQuery(qbwcUsername: string, params: qbd.EmployeeQueryRq): Promise<qbd.EmployeeQueryRs["EmployeeRet"]>;
-    /**
-     * 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
-     */
-    journalEntryAdd(qbwcUsername: string, params: qbd.JournalEntryAddRq): Promise<qbd.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
-     */
-    journalEntryMod(qbwcUsername: string, params: qbd.JournalEntryModRq["JournalEntryMod"]): Promise<qbd.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
-     */
-    journalEntryQuery(qbwcUsername: string, params: qbd.JournalEntryQueryRq): Promise<qbd.JournalEntryQueryRs["JournalEntryRet"]>;
-    /**
-     * Queries for the specified vendor or set of vendors.
-     *
-     * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/VendorQuery
-     */
-    vendorQuery(qbwcUsername: string, params: qbd.VendorQueryRq): Promise<qbd.VendorQueryRs["VendorRet"]>;
 }