conductor-node 0.0.10 → 0.0.13

package/README.md

@@ -1,12 +1,10 @@
 # Conductor Node.js Library
 
-The Conductor Node.js library provides convenient access to the Conductor API from applications written in server-side JavaScript.
-
-There are zero dependencies.
+The Conductor Node.js library provides convenient access to the Conductor API from applications written in server-side JavaScript. Zero dependencies.
 
 ## Requirements
 
-1. A running version of QuickBooks Desktop with QuickBooks Web Connector configured for Conductor. See the [Conductor Getting Started guide](https://www.notion.so/conductor-io/Conductor-Documentation-Getting-Started-7f0f42593d444337b0b3200c771d98e6) for help.
+1. A running version of QuickBooks Desktop with QuickBooks Web Connector configured for Conductor. See the [Conductor Getting Started guide](https://www.notion.so/conductor-io/Conductor-Documentation-Getting-Started-7f0f42593d444337b0b3200c771d98e6).
 2. A Conductor API key from Danny.
 
 ## Installation
@@ -21,7 +19,7 @@ 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 in their `.qwc` file that you provided them.
+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.
 
 ```ts
 import Conductor from "conductor-node";

package/dist/Client.d.ts

@@ -2,5 +2,5 @@ import ClientQBD from "./qb/ClientQBD";
 export default class Client {
     /** QuickBooks Desktop integration. */
     readonly qbd: ClientQBD;
-    constructor(apiKey: string, verbose?: boolean);
+    constructor(apiKey: string, verbose?: boolean, environment?: string);
 }

package/dist/Client.js

@@ -7,10 +7,11 @@ const ClientQBD_1 = __importDefault(require("./qb/ClientQBD"));
 class Client {
     /** QuickBooks Desktop integration. */
     qbd;
-    constructor(apiKey, verbose = false) {
-        // Do not assign `apiKey` and `verbose` to the root `Client` to not expose
-        // the properties to the user (amid the integrations, like `ClientQBD`).
-        this.qbd = new ClientQBD_1.default(apiKey, verbose);
+    constructor(apiKey, verbose = false, environment = "development") {
+        // Do not assign the passed parameters to the root `Client` to avoid
+        // exposing them as properties to the user and mixing them with the
+        // integrations, like `qbd`.
+        this.qbd = new ClientQBD_1.default(apiKey, verbose, environment);
     }
 }
 exports.default = Client;

package/dist/qb/ClientQBD.d.ts

@@ -1,10 +1,12 @@
 import type { AccountAdd, AccountQueryRq, AccountRet } from "../qb/qbXMLTypes/Account";
+import type { CustomerQueryRq, CustomerRet } from "../qb/qbXMLTypes/Customer";
 import type { EmployeeAdd, EmployeeMod, EmployeeQueryRq, EmployeeRet } from "../qb/qbXMLTypes/Employee";
 import type { VendorQueryRq, VendorRet } from "../qb/qbXMLTypes/Vendor";
 export default class ClientQBD {
     private readonly apiKey;
     private readonly verbose;
-    constructor(apiKey: string, verbose: boolean);
+    private readonly serverURL;
+    constructor(apiKey: string, verbose: boolean, environment: string);
     /**
      * Send any QBXML request to QuickBooks Desktop.
      *
@@ -12,26 +14,39 @@ export default class ClientQBD {
      */
     sendRequest(qbwcUsername: string, requestObj: object): Promise<object>;
     /**
-     * This message allows you to 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.
+     * 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: AccountAdd): Promise<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.
+     * `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: AccountQueryRq): Promise<AccountRet>;
     /**
-     * Adds an employee with personal data about the employee as well as certain payroll-related data.
+     * 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: CustomerQueryRq): Promise<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
      */

package/dist/qb/ClientQBD.js

@@ -1,12 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const SERVER_URL = "https://conductor.ngrok.io";
 class ClientQBD {
     apiKey;
     verbose;
-    constructor(apiKey, verbose) {
+    serverURL;
+    constructor(apiKey, verbose, environment) {
         this.apiKey = apiKey;
         this.verbose = verbose;
+        if (environment === "development") {
+            this.serverURL = "https://conductor.ngrok.io";
+        }
+        else {
+            throw new Error(`Unsupported environment: ${environment}`);
+        }
     }
     /**
      * Send any QBXML request to QuickBooks Desktop.
@@ -17,7 +23,7 @@ class ClientQBD {
         if (this.verbose) {
             console.log(`Client sent request for user ${qbwcUsername}:`, JSON.stringify(requestObj, null, 2));
         }
-        const response = await fetch(SERVER_URL, {
+        const response = await fetch(this.serverURL, {
             body: JSON.stringify({ qbwcUsername, requestObj }),
             headers: {
                 "Content-Type": "application/json",
@@ -32,9 +38,9 @@ class ClientQBD {
         return responseObj;
     }
     /**
-     * This message allows you to 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.
+     * 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
      */
@@ -49,12 +55,12 @@ class ClientQBD {
         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.
+     * `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
      */
@@ -69,7 +75,29 @@ class ClientQBD {
         return responseBody;
     }
     /**
-     * Adds an employee with personal data about the employee as well as certain payroll-related data.
+     * 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
      */

package/dist/qb/qbXMLTypes/Account.d.ts

@@ -1,4 +1,4 @@
-import type { ActiveStatus, CurrencyFilter, CurrencyRef, DataExtRet, NameFilter, NameRangeFilter, SalesTaxCodeRef } from "../../qb/qbXMLTypes/shared";
+import type { ActiveStatus, CurrencyFilter, CurrencyRef, DataExtRet, NameFilter, NameRangeFilter, ParentRef, SalesTaxCodeRef } from "../../qb/qbXMLTypes/shared";
 export interface AccountAddRq {
     AccountAdd: AccountAdd;
     IncludeRetElement?: string;
@@ -238,10 +238,6 @@ export interface AccountRet {
     CurrencyRef?: CurrencyRef;
     DataExtRet?: DataExtRet;
 }
-interface ParentRef {
-    ListID?: string;
-    FullName?: string;
-}
 declare type AccountType = "AccountsPayable" | "AccountsReceivable" | "Bank" | "CostOfGoodsSold" | "CreditCard" | "Equity" | "Expense" | "FixedAsset" | "Income" | "LongTermLiability" | "NonPosting" | "OtherAsset" | "OtherCurrentAsset" | "OtherCurrentLiability" | "OtherExpense" | "OtherIncome";
 declare type SpecialAccountType = "AccountsPayable" | "AccountsReceivable" | "CondenseItemAdjustmentExpenses" | "CostOfGoodsSold" | "DirectDepositLiabilities" | "Estimates" | "ExchangeGainLoss" | "InventoryAssets" | "ItemReceiptAccount" | "OpeningBalanceEquity" | "PayrollExpenses" | "PayrollLiabilities" | "PettyCash" | "PurchaseOrders" | "ReconciliationDifferences" | "RetainedEarnings" | "SalesOrders" | "SalesTaxPayable" | "UncategorizedExpenses" | "UncategorizedIncome" | "UndepositedFunds";
 declare type CashFlowClassification = "Financing" | "Investing" | "None" | "NotApplicable" | "Operating";

package/dist/qb/qbXMLTypes/Customer.d.ts

@@ -0,0 +1,152 @@
+import type { ActiveStatus, AdditionalContactRef, AdditionalNotesRet, ClassFilter, ClassRef, ContactsRet, CurrencyFilter, CurrencyRef, DataExtRet, NameFilter, NameRangeFilter, ParentRef, SalesTaxCodeRef, SalesTaxCountry, ShipAddress, TermsRef, TotalBalanceFilter } from "../../qb/qbXMLTypes/shared";
+export interface CustomerQueryRq {
+    ListID?: string;
+    FullName?: string;
+    MaxReturned?: number;
+    ActiveStatus?: ActiveStatus;
+    FromModifiedDate?: Date;
+    ToModifiedDate?: Date;
+    NameFilter?: NameFilter;
+    NameRangeFilter?: NameRangeFilter;
+    TotalBalanceFilter?: TotalBalanceFilter;
+    CurrencyFilter?: CurrencyFilter;
+    ClassFilter?: ClassFilter;
+    IncludeRetElement?: string;
+    OwnerID?: string;
+}
+export interface CustomerQueryRs {
+    CustomerRet?: CustomerRet;
+}
+export interface CustomerRet {
+    ListID: string;
+    TimeCreated: Date;
+    TimeModified: Date;
+    EditSequence: string;
+    Name: string;
+    FullName: string;
+    IsActive?: boolean;
+    ClassRef?: ClassRef;
+    ParentRef?: ParentRef;
+    Sublevel: number;
+    CompanyName?: string;
+    Salutation?: string;
+    FirstName?: string;
+    MiddleName?: string;
+    LastName?: string;
+    JobTitle?: string;
+    BillAddress?: BillAddress;
+    BillAddressBlock?: BillAddressBlock;
+    ShipAddress?: ShipAddress;
+    ShipAddressBlock?: ShipAddressBlock;
+    ShipToAddress?: ShipToAddress;
+    Phone?: string;
+    AltPhone?: string;
+    Fax?: string;
+    Email?: string;
+    Cc?: string;
+    Contact?: string;
+    AltContact?: string;
+    AdditionalContactRef?: AdditionalContactRef;
+    ContactsRet?: ContactsRet;
+    CustomerTypeRef?: CustomerTypeRef;
+    TermsRef?: TermsRef;
+    SalesRepRef?: SalesRepRef;
+    Balance?: string;
+    TotalBalance?: string;
+    SalesTaxCodeRef?: SalesTaxCodeRef;
+    ItemSalesTaxRef?: ItemSalesTaxRef;
+    SalesTaxCountry?: SalesTaxCountry;
+    ResaleNumber?: string;
+    AccountNumber?: string;
+    CreditLimit?: string;
+    PreferredPaymentMethodRef?: PreferredPaymentMethodRef;
+    CreditCardInfo?: CreditCardInfo;
+    JobStatus?: JobStatus;
+    JobStartDate?: Date;
+    JobProjectedEndDate?: Date;
+    JobEndDate?: Date;
+    JobDesc?: string;
+    JobTypeRef?: JobTypeRef;
+    Notes?: string;
+    AdditionalNotesRet?: AdditionalNotesRet;
+    PreferredDeliveryMethod?: PreferredDeliveryMethod;
+    PriceLevelRef?: PriceLevelRef;
+    ExternalGUID?: string;
+    TaxRegistrationNumber?: string;
+    CurrencyRef?: CurrencyRef;
+    DataExtRet?: DataExtRet;
+}
+interface BillAddress {
+    Addr1?: string;
+    Addr2?: string;
+    Addr3?: string;
+    Addr4?: string;
+    Addr5?: string;
+    City?: string;
+    State?: string;
+    PostalCode?: string;
+    Country?: string;
+    Note?: string;
+}
+interface BillAddressBlock {
+    Addr1?: string;
+    Addr2?: string;
+    Addr3?: string;
+    Addr4?: string;
+    Addr5?: string;
+}
+interface ShipAddressBlock {
+    Addr1?: string;
+    Addr2?: string;
+    Addr3?: string;
+    Addr4?: string;
+    Addr5?: string;
+}
+interface ShipToAddress {
+    Addr1?: string;
+    Addr2?: string;
+    Addr3?: string;
+    Addr4?: string;
+    Addr5?: string;
+    City?: string;
+    State?: string;
+    PostalCode?: string;
+    Country?: string;
+    Note?: string;
+    DefaultShipTo?: boolean;
+}
+interface CustomerTypeRef {
+    ListID?: string;
+    FullName?: string;
+}
+interface SalesRepRef {
+    ListID?: string;
+    FullName?: string;
+}
+interface ItemSalesTaxRef {
+    ListID?: string;
+    FullName?: string;
+}
+interface PreferredPaymentMethodRef {
+    ListID?: string;
+    FullName?: string;
+}
+interface CreditCardInfo {
+    CreditCardNumber?: string;
+    ExpirationMonth?: number;
+    ExpirationYear?: number;
+    NameOnCard?: string;
+    CreditCardAddress?: string;
+    CreditCardPostalCode?: string;
+}
+declare type JobStatus = "Awarded" | "Closed" | "InProgress" | "None" | "NotAwarded" | "Pending";
+interface JobTypeRef {
+    ListID?: string;
+    FullName?: string;
+}
+declare type PreferredDeliveryMethod = "Email" | "Fax" | "None";
+interface PriceLevelRef {
+    ListID?: string;
+    FullName?: string;
+}
+export {};

package/dist/qb/qbXMLTypes/Customer.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/qb/qbXMLTypes/Vendor.d.ts

@@ -1,4 +1,4 @@
-import type { ActiveStatus, AdditionalContactRef, AdditionalNotesRet, BillingRateRef, ClassRef, CurrencyFilter, CurrencyRef, DataExtRet, NameFilter, NameRangeFilter, SalesTaxCodeRef } from "../../qb/qbXMLTypes/shared";
+import type { ActiveStatus, AdditionalContactRef, AdditionalNotesRet, BillingRateRef, ClassFilter, ClassRef, ContactsRet, CurrencyFilter, CurrencyRef, DataExtRet, NameFilter, NameRangeFilter, SalesTaxCodeRef, SalesTaxCountry, ShipAddress, TermsRef, TotalBalanceFilter } from "../../qb/qbXMLTypes/shared";
 export interface VendorQueryRq {
     ListID?: string;
     FullName?: string;
@@ -17,32 +17,71 @@ export interface VendorQueryRq {
 export interface VendorQueryRs {
     VendorRet?: VendorRet;
 }
-interface TotalBalanceFilter {
-    Operator: Operator;
-    Amount: string;
-}
-declare type Operator = "Equal" | "GreaterThan" | "GreaterThanEqual" | "LessThan" | "LessThanEqual";
-interface ClassFilter {
-    ListID?: string;
-    FullName?: string;
-    ListIDWithChildren?: string;
-    FullNameWithChildren?: string;
-}
 export interface VendorRet {
     ListID: string;
     TimeCreated: Date;
     TimeModified: Date;
     EditSequence: string;
     Name: string;
+    /**
+     * If `IsActive` is `true`, this object is currently enabled for use by
+     * QuickBooks. The default value is `true`.
+     */
     IsActive?: boolean;
+    /**
+     * Classes can be used to separate transactions into meaningful categories.
+     * (For example, transactions could be classified according to department,
+     * business location, or type of work.) In QuickBooks, class tracking is off
+     * by default. A `ClassRef` aggregate refers to one of these named classes.
+     * For example, in a `TimeTracking` message, `ClassRef` refers to the
+     * QuickBooks class into which the timed activity falls. If a `ClassRef`
+     * aggregate includes both `FullName` and `ListID`, `FullName` will be
+     * ignored. In an `InvoiceAdd` request, if you specify a `ClassRef` for the
+     * whole invoice, that same `ClassRef` is automatically used in the line
+     * items. If you want to clear that (that is, have NO `ClassRef` for the line
+     * item, you can clear it in the line item by simply not specifying it in the
+     * line item.
+     */
     ClassRef?: ClassRef;
+    /**
+     * Is the current entity a tax agency.
+     */
     IsTaxAgency?: boolean;
+    /**
+     * The name of the QuickBooks user’s business, as specified in QuickBooks.
+     * `CompanyName` and `Address` are used on invoices, checks, and other forms.
+     * (`LegalCompanyName` and `LegalAddress`, on the other hand, are used on a
+     * company’s tax forms and pay stubs.)
+     */
     CompanyName?: string;
+    /**
+     * A formal reference, such as Mr. or Dr., that precedes a name.
+     */
     Salutation?: string;
+    /**
+     * The first name of a customer, vendor, employee, or person on the “other
+     * names” list.
+     */
     FirstName?: string;
+    /**
+     * The middle name of a customer, vendor, employee, or person on the “other
+     * names” list.
+     */
     MiddleName?: string;
+    /**
+     * The last name of a customer, vendor, employee, or person on the “other
+     * names” list.
+     */
     LastName?: string;
+    /**
+     * The job title of a customer, vendor, employee, or person on the “other
+     * names” list.
+     */
     JobTitle?: string;
+    /**
+     * If an address request fails, some combination of address fields might be
+     * too long.
+     */
     VendorAddress?: VendorAddress;
     VendorAddressBlock?: VendorAddressBlock;
     ShipAddress?: ShipAddress;
@@ -101,40 +140,10 @@ interface VendorAddressBlock {
     Addr4?: string;
     Addr5?: string;
 }
-interface ShipAddress {
-    Addr1?: string;
-    Addr2?: string;
-    Addr3?: string;
-    Addr4?: string;
-    Addr5?: string;
-    City?: string;
-    State?: string;
-    PostalCode?: string;
-    Country?: string;
-    Note?: string;
-}
-interface ContactsRet {
-    ListID: string;
-    TimeCreated: Date;
-    TimeModified: Date;
-    EditSequence: string;
-    Contact?: string;
-    Salutation?: string;
-    FirstName?: string;
-    MiddleName?: string;
-    LastName?: string;
-    JobTitle?: string;
-    AdditionalContactRef?: AdditionalContactRef;
-}
 interface VendorTypeRef {
     ListID?: string;
     FullName?: string;
 }
-interface TermsRef {
-    ListID?: string;
-    FullName?: string;
-}
-declare type SalesTaxCountry = "Australia" | "Canada" | "UK" | "US";
 interface SalesTaxReturnRef {
     ListID?: string;
     FullNam?: string;

package/dist/qb/qbXMLTypes/shared.d.ts

@@ -61,4 +61,49 @@ export interface CurrencyRef {
     ListID?: string;
     FullName?: string;
 }
+export interface TotalBalanceFilter {
+    Operator: Operator;
+    Amount: string;
+}
+declare type Operator = "Equal" | "GreaterThan" | "GreaterThanEqual" | "LessThan" | "LessThanEqual";
+export interface ClassFilter {
+    ListID?: string;
+    FullName?: string;
+    ListIDWithChildren?: string;
+    FullNameWithChildren?: string;
+}
+export interface ParentRef {
+    ListID?: string;
+    FullName?: string;
+}
+export interface ShipAddress {
+    Addr1?: string;
+    Addr2?: string;
+    Addr3?: string;
+    Addr4?: string;
+    Addr5?: string;
+    City?: string;
+    State?: string;
+    PostalCode?: string;
+    Country?: string;
+    Note?: string;
+}
+export interface ContactsRet {
+    ListID: string;
+    TimeCreated: Date;
+    TimeModified: Date;
+    EditSequence: string;
+    Contact?: string;
+    Salutation?: string;
+    FirstName?: string;
+    MiddleName?: string;
+    LastName?: string;
+    JobTitle?: string;
+    AdditionalContactRef?: AdditionalContactRef;
+}
+export interface TermsRef {
+    ListID?: string;
+    FullName?: string;
+}
+export declare type SalesTaxCountry = "Australia" | "Canada" | "UK" | "US";
 export {};