conductor-node 0.4.1 → 1.0.1

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/package.json

@@ -1,13 +1,14 @@
 {
   "name": "conductor-node",
-  "version": "0.4.1",
+  "version": "1.0.1",
   "description": "Conductor API wrapper",
   "author": "Danny Nemer <hi@DannyNemer.com>",
   "license": "MIT",
-  "main": "dist/src/Client.js",
-  "types": "dist/src/Client.d.ts",
+  "type": "commonjs",
+  "main": "./dist/src/Client.js",
+  "types": "./dist/src/Client.d.ts",
   "files": [
-    "dist/src/**/*.[jt]s"
+    "./dist/src/**/*.[jt]s"
   ],
   "scripts": {
     "prepack": "yarn tsc && yarn tsc-alias",

package/dist/src/BaseClient.d.ts

@@ -1,13 +0,0 @@
-import type { Environment } from "./environment";
-export interface BaseClientOptions {
-    apiKey: string;
-    verbose?: boolean;
-    environment?: Environment;
-}
-export default class BaseClient {
-    protected readonly apiKey: string;
-    protected readonly verbose: boolean;
-    protected readonly serverURL: string;
-    constructor({ apiKey, verbose, environment, }: BaseClientOptions);
-    protected sendAPIRequest<T>(apiPath: string, username: string, requestObj: T): Promise<T>;
-}

package/dist/src/BaseClient.js

@@ -1,43 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const environment_1 = require("./environment");
-// Store properties via superclass `BaseClient` instead of on `Client` passed to
-// the integration clients (e.g., `ClientQBD`) to hide these properties from the
-// dev user while still allowing the integration clients to access them.
-//
-// Downside: These values are stored in each subclass instead of sharing a
-// single store (e.g., `Client`).
-class BaseClient {
-    apiKey;
-    verbose;
-    serverURL;
-    constructor({ apiKey, verbose = false, environment = "staging", }) {
-        this.apiKey = apiKey;
-        this.verbose = verbose;
-        this.serverURL = (0, environment_1.envToBaseServerURL)(environment);
-    }
-    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));
-        }
-        const response = await fetch(apiServerURL, {
-            body: JSON.stringify({ username, requestObj }),
-            headers: {
-                "Content-Type": "application/json",
-                Authorization: `Bearer ${this.apiKey}`,
-            },
-            method: "POST",
-        });
-        if (response.status >= 400) {
-            const errorMessage = (await response.text()) || response.statusText;
-            throw new Error(`Request to ${apiServerURL} failed with status ${response.status}: ${errorMessage}`);
-        }
-        const responseObj = (await response.json());
-        if (this.verbose) {
-            console.log(`Client received response for user ${username}:`, JSON.stringify(responseObj, null, 2));
-        }
-        return responseObj;
-    }
-}
-exports.default = BaseClient;

package/dist/src/Client.d.ts

@@ -1,7 +0,0 @@
-import type { BaseClientOptions } from "./BaseClient";
-import ClientQBD from "./qbd/ClientQBD";
-export default class Client {
-    /** QuickBooks Desktop integration. */
-    readonly qbd: ClientQBD;
-    constructor(options: BaseClientOptions);
-}

package/dist/src/Client.js

@@ -1,14 +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 ClientQBD_1 = __importDefault(require("./qbd/ClientQBD"));
-class Client {
-    /** QuickBooks Desktop integration. */
-    qbd;
-    constructor(options) {
-        this.qbd = new ClientQBD_1.default(options);
-    }
-}
-exports.default = Client;

package/dist/src/environment.d.ts

@@ -1,2 +0,0 @@
-export declare type Environment = "development" | "staging";
-export declare function envToBaseServerURL(environment: Environment): string;

package/dist/src/environment.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.envToBaseServerURL = void 0;
-const STAGING_BASE_URL = "https://conductor-vgag.onrender.com";
-const DEVELOPMENT_BASE_URL = "https://conductor.ngrok.io";
-function envToBaseServerURL(environment) {
-    switch (environment) {
-        case "staging":
-            return STAGING_BASE_URL;
-        case "development":
-            return DEVELOPMENT_BASE_URL;
-        default:
-            throw new Error("Invalid environment");
-    }
-}
-exports.envToBaseServerURL = envToBaseServerURL;

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

@@ -1,255 +0,0 @@
-import BaseClient from "../BaseClient";
-import type * as qbd from "../qbd/qbdTypes";
-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<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<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
-         * 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<NonNullable<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<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<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`.
-         *
-         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CustomerQuery
-         */
-        query: (qbwcUsername: string, params: qbd.CustomerQueryRq) => Promise<NonNullable<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<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<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<NonNullable<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["JournalEntryAdd"]) => Promise<NonNullable<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<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.
-         *
-         * 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<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: (qbwcUsername: 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: (qbwcUsername: 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: (qbwcUsername: string, params: qbd.TimeTrackingQueryRq) => Promise<NonNullable<qbd.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: (qbwcUsername: 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<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<NonNullable<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>;
-    private sendRequestBase;
-}