conductor-node 0.4.0 → 1.0.0

package/README.md

@@ -19,14 +19,15 @@ The package must be configured with your account's secret key, which is availabl
 
 Currently supports executing any [QuickBooks Desktop API](https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop) via JSON and receiving the response in JSON. In the future, Conductor will incorporate extensive typings for these APIs.
 
-To send a request to a specific QuickBooks Desktop user, you must also supply the username that is in their `.qwc` file that you provided them.
+To send a request to a specific QuickBooks Desktop user, you must also supply their user id.
 
 ```ts
 import Conductor from "conductor-node";
 const conductor = new Conductor({ apiKey: "sk_test_..." });
 
+const mock_qbwc_user_id = "1";
 conductor.qbd.account
-  .add("mock_qbwc_username", {
+  .add(mock_qbwc_user_id, {
     Name: "Test Account",
     AccountType: "Bank",
     OpenBalance: "100",

package/dist/src/BaseClient.d.ts

@@ -9,5 +9,5 @@ export default class BaseClient {
     protected readonly verbose: boolean;
     protected readonly serverURL: string;
     constructor({ apiKey, verbose, environment, }: BaseClientOptions);
-    protected sendAPIRequest<T>(apiPath: string, username: string, requestObj: T): Promise<T>;
+    protected sendAPIRequest<T>(apiPath: string, qbwcUserId: string, requestObj: T): Promise<T>;
 }

package/dist/src/BaseClient.js

@@ -16,13 +16,13 @@ class BaseClient {
         this.verbose = verbose;
         this.serverURL = (0, environment_1.envToBaseServerURL)(environment);
     }
-    async sendAPIRequest(apiPath, username, requestObj) {
+    async sendAPIRequest(apiPath, qbwcUserId, requestObj) {
         const apiServerURL = `${this.serverURL}/${apiPath}`;
         if (this.verbose) {
-            console.log(`Client sent request to ${apiServerURL} for user ${username}:`, JSON.stringify(requestObj, null, 2));
+            console.log(`Client sent request to ${apiServerURL} for user ${qbwcUserId}:`, JSON.stringify(requestObj, null, 2));
         }
         const response = await fetch(apiServerURL, {
-            body: JSON.stringify({ username, requestObj }),
+            body: JSON.stringify({ qbwcUserId, requestObj }),
             headers: {
                 "Content-Type": "application/json",
                 Authorization: `Bearer ${this.apiKey}`,
@@ -35,7 +35,7 @@ class BaseClient {
         }
         const responseObj = (await response.json());
         if (this.verbose) {
-            console.log(`Client received response for user ${username}:`, JSON.stringify(responseObj, null, 2));
+            console.log(`Client received response for user ${qbwcUserId}:`, JSON.stringify(responseObj, null, 2));
         }
         return responseObj;
     }

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

@@ -12,13 +12,13 @@ export default class ClientQBD extends BaseClient {
          *
          * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/AccountAdd
          */
-        add: (qbwcUsername: string, params: qbd.AccountAddRq["AccountAdd"]) => Promise<qbd.AccountAddRs["AccountRet"]>;
+        add: (qbwcUserId: string, params: qbd.AccountAddRq["AccountAdd"]) => Promise<NonNullable<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"]>;
+        mod: (qbwcUserId: string, params: qbd.AccountModRq["AccountMod"]) => Promise<NonNullable<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
@@ -29,7 +29,7 @@ export default class ClientQBD extends BaseClient {
          *
          * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/AccountQuery
          */
-        query: (qbwcUsername: string, params: qbd.AccountQueryRq) => Promise<qbd.AccountQueryRs["AccountRet"]>;
+        query: (qbwcUserId: string, params: qbd.AccountQueryRq) => Promise<NonNullable<qbd.AccountQueryRs["AccountRet"]>>;
     };
     customer: {
         /**
@@ -37,41 +37,43 @@ export default class ClientQBD extends BaseClient {
          * 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:
+         * `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 `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.
+         * - 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"]>;
+        add: (qbwcUserId: string, params: qbd.CustomerAddRq["CustomerAdd"]) => Promise<NonNullable<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"]>;
+        mod: (qbwcUserId: string, params: qbd.CustomerModRq["CustomerMod"]) => Promise<NonNullable<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`.
+         * 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"]>;
+        query: (qbwcUserId: string, params: qbd.CustomerQueryRq) => Promise<NonNullable<qbd.CustomerQueryRs["CustomerRet"]>>;
     };
     employee: {
         /**
@@ -80,19 +82,19 @@ export default class ClientQBD extends BaseClient {
          *
          * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/EmployeeAdd
          */
-        add: (qbwcUsername: string, params: qbd.EmployeeAddRq["EmployeeAdd"]) => Promise<qbd.EmployeeAddRs["EmployeeRet"]>;
+        add: (qbwcUserId: string, params: qbd.EmployeeAddRq["EmployeeAdd"]) => Promise<NonNullable<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"]>;
+        mod: (qbwcUserId: string, params: qbd.EmployeeModRq["EmployeeMod"]) => Promise<NonNullable<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"]>;
+        query: (qbwcUserId: string, params: qbd.EmployeeQueryRq) => Promise<NonNullable<qbd.EmployeeQueryRs["EmployeeRet"]>>;
     };
     journalEntry: {
         /**
@@ -104,11 +106,11 @@ export default class ClientQBD extends BaseClient {
          * 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.
+         * 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
@@ -116,8 +118,8 @@ export default class ClientQBD extends BaseClient {
          *
          * 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
+         * `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
@@ -126,7 +128,7 @@ export default class ClientQBD extends BaseClient {
          *
          * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/JournalEntryAdd
          */
-        add: (qbwcUsername: string, params: qbd.JournalEntryAddRq) => Promise<qbd.JournalEntryAddRs["JournalEntryRet"]>;
+        add: (qbwcUserId: string, params: qbd.JournalEntryAddRq["JournalEntryAdd"]) => Promise<NonNullable<qbd.JournalEntryAddRs["JournalEntryRet"]>>;
         /**
          * Modifies a journal entry.
          *
@@ -136,18 +138,18 @@ export default class ClientQBD extends BaseClient {
          *
          * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/JournalEntryMod
          */
-        mod: (qbwcUsername: string, params: qbd.JournalEntryModRq["JournalEntryMod"]) => Promise<qbd.JournalEntryModRs["JournalEntryRet"]>;
+        mod: (qbwcUserId: string, params: qbd.JournalEntryModRq["JournalEntryMod"]) => Promise<NonNullable<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.
+         * 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
@@ -155,13 +157,64 @@ export default class ClientQBD extends BaseClient {
          *
          * 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
+         * `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"]>;
+        query: (qbwcUserId: string, params: qbd.JournalEntryQueryRq) => Promise<NonNullable<qbd.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: (qbwcUserId: string, params: qbd.TimeTrackingAddRq["TimeTrackingAdd"]) => Promise<NonNullable<qbd.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: (qbwcUserId: string, params: qbd.TimeTrackingModRq["TimeTrackingMod"]) => Promise<NonNullable<qbd.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: (qbwcUserId: string, params: qbd.TimeTrackingQueryRq) => Promise<NonNullable<qbd.TimeTrackingQueryRs["TimeTrackingRet"]>>;
     };
     vendor: {
         /**
@@ -169,32 +222,34 @@ export default class ClientQBD extends BaseClient {
          *
          * 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.
+         * 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"]>;
+        add: (qbwcUserId: string, params: qbd.VendorAddRq["VendorAdd"]) => Promise<NonNullable<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"]>;
+        mod: (qbwcUserId: string, params: qbd.VendorModRq["VendorMod"]) => Promise<NonNullable<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"]>;
+        query: (qbwcUserId: string, params: qbd.VendorQueryRq) => Promise<NonNullable<qbd.VendorQueryRs["VendorRet"]>>;
     };
     /**
      * Send any QBXML request to QuickBooks Desktop.
      *
-     * Available APIs: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop
+     * Available APIs:
+     * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop
      */
-    sendRequest(qbwcUsername: string, requestObj: QBXMLObj): Promise<QBXMLObj>;
+    sendRequest(qbwcUserId: string, requestObj: QBXMLObj): Promise<QBXMLObj>;
+    private sendRequestBase;
 }