conductor-node 0.1.4 → 0.2.0

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>(username: string, requestObj: T, apiPath: string): Promise<T>;
+    protected sendAPIRequest<T>(apiPath: string, username: string, requestObj: T): Promise<T>;
 }

package/dist/src/BaseClient.js

@@ -16,7 +16,7 @@ class BaseClient {
         this.verbose = verbose;
         this.serverURL = (0, environment_1.envToBaseServerURL)(environment);
     }
-    async sendAPIRequest(username, requestObj, apiPath) {
+    async sendAPIRequest(apiPath, username, requestObj) {
         const apiServerURL = `${this.serverURL}/${apiPath}`;
         if (this.verbose) {
             console.log(`Client sent request to ${apiServerURL} for user ${username}:`, JSON.stringify(requestObj, null, 2));

package/dist/src/Client.d.ts

@@ -1,5 +1,5 @@
 import type { BaseClientOptions } from "./BaseClient";
-import ClientQBD from "./qb/ClientQBD";
+import ClientQBD from "./qbd/ClientQBD";
 export default class Client {
     /** QuickBooks Desktop integration. */
     readonly qbd: ClientQBD;

package/dist/src/Client.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const ClientQBD_1 = __importDefault(require("./qb/ClientQBD"));
+const ClientQBD_1 = __importDefault(require("./qbd/ClientQBD"));
 class Client {
     /** QuickBooks Desktop integration. */
     qbd;

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

@@ -0,0 +1,170 @@
+import BaseClient from "../BaseClient";
+import type * as qbd from "../qbd/qbdTypes";
+export interface QBXMLObj {
+    [apiName: string]: object;
+}
+export default class ClientQBD extends BaseClient {
+    /**
+     * 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"]>;
+}

package/dist/src/qbd/ClientQBD.js

@@ -0,0 +1,291 @@
+"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 {
+    /**
+     * 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);
+    }
+    /**
+     * 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
+     */
+    async accountAdd(qbwcUsername, params) {
+        const response = (await this.sendRequest(qbwcUsername, {
+            AccountAddRq: { AccountAdd: params },
+        }));
+        const responseBody = response.AccountAddRs.AccountRet;
+        if (!responseBody) {
+            throw new Error("No response");
+        }
+        return responseBody;
+    }
+    /**
+     * Modifies an account.
+     *
+     * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/AccountMod
+     */
+    async accountMod(qbwcUsername, params) {
+        const response = (await this.sendRequest(qbwcUsername, {
+            AccountModRq: { AccountMod: params },
+        }));
+        const responseBody = response.AccountModRs.AccountRet;
+        if (!responseBody) {
+            throw new Error("No response");
+        }
+        return responseBody;
+    }
+    /**
+     * `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
+     */
+    async accountQuery(qbwcUsername, params) {
+        const response = (await this.sendRequest(qbwcUsername, {
+            AccountQueryRq: params,
+        }));
+        const responseBody = response.AccountQueryRs.AccountRet;
+        if (!responseBody) {
+            throw new Error("No response");
+        }
+        return responseBody;
+    }
+    /**
+     * 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
+     */
+    async customerAdd(qbwcUsername, params) {
+        const response = (await this.sendRequest(qbwcUsername, {
+            CustomerAddRq: { CustomerAdd: params },
+        }));
+        const responseBody = response.CustomerAddRs.CustomerRet;
+        if (!responseBody) {
+            throw new Error("No response");
+        }
+        return responseBody;
+    }
+    /**
+     * Modifies the customer record.
+     *
+     * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CustomerMod
+     */
+    async customerMod(qbwcUsername, params) {
+        const response = (await this.sendRequest(qbwcUsername, {
+            CustomerModRq: { CustomerMod: params },
+        }));
+        const responseBody = response.CustomerModRs.CustomerRet;
+        if (!responseBody) {
+            throw new Error("No response");
+        }
+        return responseBody;
+    }
+    /**
+     * 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
+     */
+    async customerQuery(qbwcUsername, params) {
+        const response = (await this.sendRequest(qbwcUsername, {
+            CustomerQueryRq: params,
+        }));
+        const responseBody = response.CustomerQueryRs.CustomerRet;
+        if (!responseBody) {
+            throw new Error("No response");
+        }
+        return responseBody;
+    }
+    /**
+     * 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
+     */
+    async employeeAdd(qbwcUsername, params) {
+        const response = (await this.sendRequest(qbwcUsername, {
+            EmployeeAddRq: { EmployeeAdd: params },
+        }));
+        const responseBody = response.EmployeeAddRs.EmployeeRet;
+        if (!responseBody) {
+            throw new Error("No response");
+        }
+        return responseBody;
+    }
+    /**
+     * Modifies an existing employee.
+     *
+     * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/EmployeeMod
+     */
+    async employeeMod(qbwcUsername, params) {
+        const response = (await this.sendRequest(qbwcUsername, {
+            EmployeeModRq: { EmployeeMod: params },
+        }));
+        const responseBody = response.EmployeeModRs.EmployeeRet;
+        if (!responseBody) {
+            throw new Error("No response");
+        }
+        return responseBody;
+    }
+    /**
+     * Returns employee data.
+     *
+     * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/EmployeeQuery
+     */
+    async employeeQuery(qbwcUsername, params) {
+        const response = (await this.sendRequest(qbwcUsername, {
+            EmployeeQueryRq: params,
+        }));
+        const responseBody = response.EmployeeQueryRs.EmployeeRet;
+        if (!responseBody) {
+            throw new Error("No response");
+        }
+        return responseBody;
+    }
+    /**
+     * 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
+     */
+    async journalEntryAdd(qbwcUsername, params) {
+        const response = (await this.sendRequest(qbwcUsername, {
+            JournalEntryAddRq: params,
+        }));
+        const responseBody = response.JournalEntryAddRs.JournalEntryRet;
+        if (!responseBody) {
+            throw new Error("No response");
+        }
+        return responseBody;
+    }
+    /**
+     * 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
+     */
+    async journalEntryMod(qbwcUsername, params) {
+        const response = (await this.sendRequest(qbwcUsername, {
+            JournalEntryModRq: { JournalEntryMod: params },
+        }));
+        const responseBody = response.JournalEntryModRs.JournalEntryRet;
+        if (!responseBody) {
+            throw new Error("No response");
+        }
+        return responseBody;
+    }
+    /**
+     * 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
+     */
+    async journalEntryQuery(qbwcUsername, params) {
+        const response = (await this.sendRequest(qbwcUsername, {
+            JournalEntryQueryRq: params,
+        }));
+        const responseBody = response.JournalEntryQueryRs.JournalEntryRet;
+        if (!responseBody) {
+            throw new Error("No response");
+        }
+        return responseBody;
+    }
+    /**
+     * Queries for the specified vendor or set of vendors.
+     *
+     * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/VendorQuery
+     */
+    async vendorQuery(qbwcUsername, params) {
+        const response = (await this.sendRequest(qbwcUsername, {
+            VendorQueryRq: params,
+        }));
+        const responseBody = response.VendorQueryRs.VendorRet;
+        if (!responseBody) {
+            throw new Error("No response");
+        }
+        return responseBody;
+    }
+}
+exports.default = ClientQBD;