conductor-node 11.2.6 → 11.3.1

package/README.md

@@ -24,6 +24,8 @@
 
 Conductor is a TypeScript-first Node.js API for **QuickBooks Desktop** (also known as QuickBooks Enterprise). In just a few lines, get real-time access to fetch, create, or update [_any_ QuickBooks Desktop object type](https://docs.conductor.is/qbd/api#supported-object-types) and receive a fully-typed response. Check out [the documentation](https://docs.conductor.is) to get started.
 
+Conductor, the company, is building a data integration platform for vertical SaaS companies, starting with QuickBooks Desktop. Our team has spent over a decade building companies, scaling vast software systems, and obsessing over quality.
+
 <!-- markdownlint-disable MD033 -->
 <div align="center">
   <a href="https://docs.conductor.is"><img src="https://user-images.githubusercontent.com/170023/213273732-83dd6881-0b36-4787-820b-bd55cdc8444f.jpg" alt="QuickBooks Desktop autocomplete" width="600" /></a>
@@ -39,7 +41,7 @@ Conductor is a TypeScript-first Node.js API for **QuickBooks Desktop** (also kno
 
 ## Requirements
 
-1. A Conductor API key pair: one secret key, one publishable key. Please [email us](mailto:hello@conductor.is?subject=Conductor%20Beta) to join the private beta.
+1. A Conductor API key pair: one secret key, one publishable key. Please [email us](mailto:hello@conductor.is?subject=Conductor%20Beta%20Access&body=Hello!%20Tell%20us%20a%20bit%20about%20what%20you%20are%20building:%20) to join the beta.
 2. Node.js v16 or later.
 
 ## Installation
@@ -85,4 +87,4 @@ main();
 
 ## More Documentation
 
-Please see our full documentation with guides and code examples [available here](https://docs.conductor.is).
+Please see our [full documentation site](https://docs.conductor.is) for more docs, guides, and code examples.

package/dist/package.json

@@ -1,17 +1,19 @@
 {
     "name": "conductor-node",
-    "version": "11.2.6",
-    "description": "Easily integrate the entire QuickBooks Desktop API using fully-typed async TypeScript",
+    "version": "11.3.1",
+    "description": "QuickBooks Desktop API for Node.js and TypeScript",
     "keywords": [
+        "QuickBooks",
         "QuickBooks Desktop",
         "QuickBooks Enterprise",
-        "QuickBooks",
-        "Intuit",
         "QuickBooks Web Connector",
-        "qbXML",
         "QBWC",
+        "qbXML",
         "QB Desktop",
-        "QBD"
+        "QB Enterprise",
+        "QBD",
+        "QBE",
+        "Intuit"
     ],
     "homepage": "https://conductor.is",
     "repository": "github:conductor-is/conductor-node",

package/dist/src/Client.d.ts

@@ -14,9 +14,6 @@ export default class Client {
     readonly authSessions: AuthSessionsResource;
     /**
      * Executes any QuickBooks Desktop (QBD) API against the specified end-user.
-     * See the official [QuickBooks Desktop API
-     * Reference](https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop)
-     * for a complete list of available APIs.
      */
     readonly qbd: QbdIntegration;
     private readonly httpClient;

package/dist/src/Client.js

@@ -11,7 +11,6 @@ const AuthSessionsResource_1 = __importDefault(require("./resources/AuthSessions
 const EndUsersResource_1 = __importDefault(require("./resources/EndUsersResource"));
 const IntegrationConnectionsResource_1 = __importDefault(require("./resources/IntegrationConnectionsResource"));
 const checkForUpdates_1 = require("./utils/checkForUpdates");
-const http_1 = require("./utils/http");
 const axios_1 = __importDefault(require("axios"));
 class Client {
     endUsers;
@@ -19,9 +18,6 @@ class Client {
     authSessions;
     /**
      * Executes any QuickBooks Desktop (QBD) API against the specified end-user.
-     * See the official [QuickBooks Desktop API
-     * Reference](https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop)
-     * for a complete list of available APIs.
      */
     qbd;
     httpClient;
@@ -34,8 +30,14 @@ class Client {
         this.qbd = new QbdIntegration_1.default(this.httpClient);
     }
     createHttpClient(apiKey, verbose) {
+        // Use an environment variable for overriding the server URL for testing and
+        // development instead of checking `NODE_ENV` to allow `conductor-node`
+        // users to use the production API server when their `NODE_ENV` is set to
+        // "development".
+        const apiServerUrl = process.env["CONDUCTOR__MOCK_API_SERVER_URL"] ??
+            "https://api.conductor.is";
         const httpClient = axios_1.default.create({
-            baseURL: `${(0, http_1.getApiServerUrlForEnvironment)()}/v1`,
+            baseURL: `${apiServerUrl}/v1`,
             headers: this.createHeaders(apiKey),
             timeout: 0, // No timeout (default).
         });

package/dist/src/integrations/qbd/QbdIntegration.d.ts

@@ -1799,6 +1799,38 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.OtherNameQueryRq) => Promise<NonNullable<QbdTypes.OtherNameQueryRs["OtherNameRet"]>>;
     };
+    /**
+     * A payroll wage item describes and names a payment scheme, for example,
+     * Regular Pay or Overtime Pay.
+     */
+    payrollItemWage: {
+        /**
+         * Adds a payroll wage item. Each payroll wage item describes and names a
+         * payment scheme, for example, Regular Pay or Overtime Pay. A
+         * `PayrollItemWageRef` aggregate refers to one of these wage items. In a
+         * request, if a `PayrollItemWageRef` aggregate includes both `FullName` and
+         * `ListID`, `FullName` will be ignored.
+         *
+         * Within QuickBooks, a timesheet can specify a payroll wage item only if
+         * the following criteria are met:
+         * - The name on the timesheet (which corresponds to the EntityRef in the
+         *   `TimeTracking` object) is on the QuickBooks Employee list, and
+         * - The “Use time data to create paychecks” preference is turned on in the
+         *   QuickBooks Payroll Info window that provides detailed employee
+         *   information employee.
+         *
+         *
+         * See more:
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/PayrollItemWageAdd
+         */
+        add: (endUserId: string, params: QbdTypes.PayrollItemWageAddRq["PayrollItemWageAdd"]) => Promise<NonNullable<QbdTypes.PayrollItemWageAddRs["PayrollItemWageRet"]>>;
+        /**
+         * Queries for the specified payroll wage item or set of items.
+         *
+         * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/PayrollItemWageQuery
+         */
+        query: (endUserId: string, params?: QbdTypes.PayrollItemWageQueryRq) => Promise<NonNullable<QbdTypes.PayrollItemWageQueryRs["PayrollItemWageRet"]>>;
+    };
     /**
      * A price level is used to specify custom pricing for specific customers.
      * Once you create a price level for a customer, QuickBooks will automatically
@@ -2127,13 +2159,13 @@ export default class QbdIntegration extends BaseIntegration {
         /**
          * This report returns information from any of three QuickBooks payroll
          * reports:
-         * - Payroll summary report This report shows the total wages, taxes
+         * - Payroll summary report: This report shows the total wages, taxes
          *   withheld, deductions from net pay, additions to net pay, and
          *   employer-paid taxes and contributions for each employee on the payroll.
-         * - Employee earnings summary report This report shows information similar
+         * - Employee earnings summary report: This report shows information similar
          *   to the payroll summary report, but in a different layout. The report
          *   has a row for each employee and a column for each payroll item.
-         * - Payroll liability balances report This report lists the payroll
+         * - Payroll liability balances report: This report lists the payroll
          *   liabilities the QuickBooks company owes to various agencies, such as
          *   the federal government, your state government, insurance plan
          *   administrators, labor unions, etc. The report covers unpaid liabilities

package/dist/src/integrations/qbd/QbdIntegration.js

@@ -1804,6 +1804,38 @@ class QbdIntegration extends BaseIntegration_1.default {
          */
         query: async (endUserId, params = {}) => this.sendRequestWrapper(endUserId, { OtherNameQueryRq: params }, "OtherNameQueryRs", "OtherNameRet"),
     };
+    /**
+     * A payroll wage item describes and names a payment scheme, for example,
+     * Regular Pay or Overtime Pay.
+     */
+    payrollItemWage = {
+        /**
+         * Adds a payroll wage item. Each payroll wage item describes and names a
+         * payment scheme, for example, Regular Pay or Overtime Pay. A
+         * `PayrollItemWageRef` aggregate refers to one of these wage items. In a
+         * request, if a `PayrollItemWageRef` aggregate includes both `FullName` and
+         * `ListID`, `FullName` will be ignored.
+         *
+         * Within QuickBooks, a timesheet can specify a payroll wage item only if
+         * the following criteria are met:
+         * - The name on the timesheet (which corresponds to the EntityRef in the
+         *   `TimeTracking` object) is on the QuickBooks Employee list, and
+         * - The “Use time data to create paychecks” preference is turned on in the
+         *   QuickBooks Payroll Info window that provides detailed employee
+         *   information employee.
+         *
+         *
+         * See more:
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/PayrollItemWageAdd
+         */
+        add: async (endUserId, params) => this.sendRequestWrapper(endUserId, { PayrollItemWageAddRq: { PayrollItemWageAdd: params } }, "PayrollItemWageAddRs", "PayrollItemWageRet"),
+        /**
+         * Queries for the specified payroll wage item or set of items.
+         *
+         * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/PayrollItemWageQuery
+         */
+        query: async (endUserId, params = {}) => this.sendRequestWrapper(endUserId, { PayrollItemWageQueryRq: params }, "PayrollItemWageQueryRs", "PayrollItemWageRet"),
+    };
     /**
      * A price level is used to specify custom pricing for specific customers.
      * Once you create a price level for a customer, QuickBooks will automatically
@@ -2132,13 +2164,13 @@ class QbdIntegration extends BaseIntegration_1.default {
         /**
          * This report returns information from any of three QuickBooks payroll
          * reports:
-         * - Payroll summary report This report shows the total wages, taxes
+         * - Payroll summary report: This report shows the total wages, taxes
          *   withheld, deductions from net pay, additions to net pay, and
          *   employer-paid taxes and contributions for each employee on the payroll.
-         * - Employee earnings summary report This report shows information similar
+         * - Employee earnings summary report: This report shows information similar
          *   to the payroll summary report, but in a different layout. The report
          *   has a row for each employee and a column for each payroll item.
-         * - Payroll liability balances report This report lists the payroll
+         * - Payroll liability balances report: This report lists the payroll
          *   liabilities the QuickBooks company owes to various agencies, such as
          *   the federal government, your state government, insurance plan
          *   administrators, labor unions, etc. The report covers unpaid liabilities

package/dist/src/integrations/qbd/qbdTypes.d.ts

@@ -9074,12 +9074,89 @@ export interface PayrollDetailReportQueryRs {
     ReportRet: ReportRet[];
 }
 export type PayrollDetailReportType = "EmployeeStateTaxesDetail" | "PayrollItemDetail" | "PayrollReviewDetail" | "PayrollTransactionDetail" | "PayrollTransactionsByPayee";
+export interface PayrollItemWageAdd {
+    /** Description of the wage: for example, Regular Pay or Overtime Pay. */
+    Name: string;
+    /** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
+    IsActive?: boolean;
+    /** The type of pay. */
+    WageType: WageType;
+    /** Refers to an expense account. If an `ExpenseAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
+    ExpenseAccountRef: ExpenseAccountRef;
+}
+export interface PayrollItemWageAddRq {
+    PayrollItemWageAdd: PayrollItemWageAdd;
+    /** You use this if you want to limit the data that will be returned in the response. In this list, you specify the name of each top-level element or aggregate that you want to be returned in the response to the request. You cannot specify fields within an aggregate, for example, you cannot specify a `City` within an `Address`: you must specify `Address` and will get the entire address. The names specified in the list are not parsed, so you must be especially careful to supply valid names, properly cased. No error is returned in the status code if you specify an invalid name. Notice that if you want to return custom data or private data extensions, you must specify the `DataExtRet` element and you must supply the `OwnerID` set to either a value of 0 (custom data) or the GUID for the private data. */
+    IncludeRetElement?: string[] | string;
+}
+export interface PayrollItemWageAddRs {
+    PayrollItemWageRet?: PayrollItemWageRet;
+}
+export interface PayrollItemWageQueryRq {
+    /** One or more `ListID` values. Along with `FullName`, `ListID` is a way to identify a list object. When a list object is added to QuickBooks through the SDK or through the QuickBooks user interface, the server assigns it a `ListID`.
+  
+    A `ListID` is not unique across lists, but it is unique across each particular type of list. For example, two customers could not have the same `ListID`, and a customer could not have the same `ListID` as an employee (because Customer and Employee are both name lists). But a customer could have the same `ListID` as a non-inventory item. */
+    ListID?: string[] | string;
+    /** A list of one or more `FullName` values. `FullName` (along with `ListID`) is a way to identify a list object. The `FullName` is the name prefixed by the names of each ancestor, for example `Jones:Kitchen:Cabinets`. `FullName` values are not case-sensitive. */
+    FullName?: string[] | string;
+    /** Limits the number of objects that a query returns. (To get a count of how many objects could possibly be returned, use the `metaData` query attribute.) If you include a `MaxReturned` value, it must be at least 1. */
+    MaxReturned?: number;
+    /** Used in filters to select list objects based on whether or not they are currently enabled for use by QuickBooks. The default value is `asActiveOnly`, which selects only list objects that are active. */
+    ActiveStatus?: ActiveStatus;
+    /** Selects objects modified on or after this date. See the note below regarding QBFC usage.
+  
+    For desktop versions of QuickBooks, the `FromModifiedDate` and `ToModifiedDate` must be between 1970-01-01 and 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST). (The time portion of the field was not supported in qbXML version 1.0 or 1.1.) Also, for desktop versions of QuickBooks, if `FromModifiedDate` includes a date but not a time (for example, if you set `FromModifiedDate` to 2003-02-14), the time is assumed to be zero (2003-02-14T00:00:00). If you omit `FromModifiedDate`, it will be set to 1970-01-01T00:00:00 (1969-12-31T16:00:00-08:00 PST).
+  
+    For QBOE, the `FromModifiedDate` and `ToModifiedDate` must be between 1900-01-01T00:00:00 and 9999-12-31T00:00:00. If `FromModifiedDate` includes a date but not a time (for example, if you set `FromModifiedDate` to 2003-02-14), the time is assumed to be zero (2003-02-14T00:00:00). If you omit `FromModifiedDate`, it will be set to 1900-01-01T00:00:00.
+  
+    Note: When specifying this in QBFC, you need to supply the parameter `asDateOnly`, which is a Boolean. If `asDateOnly` is true, the date value will be represented as a date only (without a time). If `asDateOnly` is false, the date value will be represented as date and time, padded with zeros if necessary, and set to the beginning of the day if no time is provided. The `asDateOnly` parameter is especially useful in the `ToModifiedDate` field of a query: If `asDateOnly` is set to true in the `ToModifiedDate` field of a query, then the query includes elements modified up to the end of the day. If `asDateOnly` is false, the query includes elements modified up to the specified time (or up to the beginning of the day if no time is included). */
+    FromModifiedDate?: string;
+    /** Selects objects modified on or before this date. See the note below on QBFC usage.
+  
+    For desktop versions of QuickBooks, the `ToModifiedDate` and `FromModifiedDate` must be between 01/01/1970 and 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST). (Note that the time portion of the field was not supported in qbXML version 1.0 or 1.1.) If `ToModifiedDate` includes a date but not a time (for example, if you set `ToModifiedDate` to 2003-02-14), the time is assumed to be the end of the day (2003-02-14T23:59:59). If you omit `ToModifiedDate` altogether, it will be set to 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST).
+  
+    For QBOE, the `ToModifiedDate` and `FromModifiedDate` must be between 01/01/1900 and 9999-12-31T00:00:00. If `ToModifiedDate` includes a date but not a time (for example, if you set `ToModifiedDate` to 2003-02-14), the time is assumed to be the end of the day (2003-02-14T23:59:59). If you omit `ToModifiedDate` altogether, it will be set to 9999-12-31T00:00:00.
+  
+    Note: When specifying this in QBFC, you need to supply the parameter `asDateOnly`, which is a Boolean. If `asDateOnly` is true, the date value will be represented as a date only (without a time). If `asDateOnly` is false, the date value will be represented as date and time, padded with zeros if necessary, and set to the beginning of the day if no time is provided. The `asDateOnly` parameter is especially useful in the `ToModifiedDate` field of a query: If `asDateOnly` is set to true in the `ToModifiedDate` field of a query, then the query includes elements modified up to the end of the day. If `asDateOnly` is false, the query includes elements modified up to the specified time (or up to the beginning of the day if no time is included). */
+    ToModifiedDate?: string;
+    /** Filters according to the object’s `Name`. */
+    NameFilter?: NameFilter;
+    /** Filters according to the object’s `Name`. */
+    NameRangeFilter?: NameRangeFilter;
+    /** You use this if you want to limit the data that will be returned in the response. In this list, you specify the name of each top-level element or aggregate that you want to be returned in the response to the request. You cannot specify fields within an aggregate, for example, you cannot specify a `City` within an `Address`: you must specify `Address` and will get the entire address.
+  
+    The names specified in the list are not parsed, so you must be especially careful to supply valid names, properly cased. No error is returned in the status code if you specify an invalid name.
+  
+    Notice that if you want to return custom data or private data extensions, you must specify the `DataExtRet` element and you must supply the `OwnerID` set to either a value of 0 (custom data) or the GUID for the private data. */
+    IncludeRetElement?: string[] | string;
+}
+export interface PayrollItemWageQueryRs {
+    PayrollItemWageRet: PayrollItemWageRet[];
+}
 export interface PayrollItemWageRef {
     /** Along with `FullName`, `ListID` is a way to identify a list object. When a list object is added to QuickBooks through the SDK or through the QuickBooks user interface, the server assigns it a `ListID`. A `ListID` is not unique across lists, but it is unique across each particular type of list. For example, two customers could not have the same `ListID`, and a customer could not have the same `ListID` as an employee (because Customer and Employee are both name lists). But a customer could have the same `ListID` as a non-inventory item. */
     ListID?: string;
     /** `FullName` (along with `ListID`) is a way to identify a list object. The `FullName` is the name prefixed by the names of each ancestor, for example `Jones:Kitchen:Cabinets`. `FullName` values are not case-sensitive. */
     FullName?: string;
 }
+export interface PayrollItemWageRet {
+    /** Along with `FullName`, `ListID` is a way to identify a list object. When a list object is added to QuickBooks through the SDK or through the QuickBooks user interface, the server assigns it a `ListID`. A `ListID` is not unique across lists, but it is unique across each particular type of list. For example, two customers could not have the same `ListID`, and a customer could not have the same `ListID` as an employee (because Customer and Employee are both name lists). But a customer could have the same `ListID` as a non-inventory item. */
+    ListID: string;
+    /** Time the object was created. */
+    TimeCreated: string;
+    /** Time the object was last modified. */
+    TimeModified: string;
+    /** A number that the server generates and assigns to this object. Every time the object is changed, the server will change its `EditSequence` value. When you try to modify a list object, you must provide its `EditSequence`. The server compares the `EditSequence` you provide with the `EditSequence` in memory to make sure you are dealing with the latest copy of the object. If you are not, the server will reject the request and return an error. Because `EditSequence` is only used to check whether two objects match, there is no reason to interpret its value. */
+    EditSequence: string;
+    /** Description of the wage: for example, Regular Pay or Overtime Pay. */
+    Name: string;
+    /** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
+    IsActive?: boolean;
+    /** The type of pay. */
+    WageType: WageType;
+    /** Refers to an expense account. If an `ExpenseAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
+    ExpenseAccountRef: ExpenseAccountRef;
+}
 export interface PayrollSummaryReportQueryRq {
     /** The type of payroll report: `psrtEmployeeEarningsSummary` This report shows information similar to the payroll summary report, but in a different layout. The report has a row for each employee and a column for each payroll item. `psrtPayrollLiabilityBalances` This report lists the payroll liabilities the QuickBooks company owes to various agencies, such as the federal government, your state government, insurance plan administrators, labor unions, etc. The report covers unpaid liabilities incurred during the period of time shown in the From and To fields. If the company paid a liability incurred within the date range of the report, the report omits that liability, even if the payment occurred after the ending date of the report. `psrtPayrollSummary` This report shows the total wages, taxes withheld, deductions from net pay, additions to net pay, and employer-paid taxes and contributions for each employee on the payroll. */
     PayrollSummaryReportType: PayrollSummaryReportType;
@@ -12986,6 +13063,7 @@ export interface VendorTypeRet {
     /** The number of ancestors. For example, The customer job with `Name` = carpets and `FullName` = Jones:Building2:carpets would have a sublevel of 2. */
     Sublevel: number;
 }
+export type WageType = "Bonus" | "Commission" | "HourlyOvertime" | "HourlyRegular" | "HourlySick" | "HourlyVacation" | "SalaryRegular" | "SalarySick" | "SalaryVacation";
 export interface WorkersCompCodeAdd {
     /** The case-insensitive name of a list object, not including the names of its ancestors. `Name` must be unique, unless it is the `Name` of a “hierarchical” list object. List objects in different hierarchies can have duplicate names because their `FullNames` will still be unique. For example, two objects could both have the `Name` kitchen, but they could have unique `FullNames`, such as Job12:kitchen and Baker:kitchen. For built-in currencies, `Name` is the internationally accepted currency name and is not editable. */
     Name: string;

package/package.json

@@ -1,17 +1,19 @@
 {
   "name": "conductor-node",
-  "version": "11.2.6",
-  "description": "Easily integrate the entire QuickBooks Desktop API using fully-typed async TypeScript",
+  "version": "11.3.1",
+  "description": "QuickBooks Desktop API for Node.js and TypeScript",
   "keywords": [
+    "QuickBooks",
     "QuickBooks Desktop",
     "QuickBooks Enterprise",
-    "QuickBooks",
-    "Intuit",
     "QuickBooks Web Connector",
-    "qbXML",
     "QBWC",
+    "qbXML",
     "QB Desktop",
-    "QBD"
+    "QB Enterprise",
+    "QBD",
+    "QBE",
+    "Intuit"
   ],
   "homepage": "https://conductor.is",
   "repository": "github:conductor-is/conductor-node",

package/dist/src/utils/http.d.ts

@@ -1 +0,0 @@
-export declare function getApiServerUrlForEnvironment(): string;

package/dist/src/utils/http.js

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getApiServerUrlForEnvironment = void 0;
-function getApiServerUrlForEnvironment() {
-    // Do not check if `NODE_ENV` is "production" because that requires the
-    // developer to have set `NODE_ENV` to use `conductor` as expected.
-    if (["development", "test"].includes(process.env.NODE_ENV)) {
-        return "http://localhost:4000";
-    }
-    return "https://api.conductor.is";
-}
-exports.getApiServerUrlForEnvironment = getApiServerUrlForEnvironment;