conductor-node 11.4.4 → 11.5.0

package/README.md

@@ -15,14 +15,14 @@
   <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
   <a href="https://docs.conductor.is">Docs</a>
   <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
-  <a href="https://docs.conductor.is/qbd-objects">Examples</a>
+  <a href="https://docs.conductor.is/qbd-examples">Examples</a>
   <br />
   <hr />
 </div>
 
 ## What is Conductor?
 
-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 is a TypeScript-first Node.js API for **QuickBooks Desktop** (sometimes called 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.
 
 We also offer a [REST API](https://docs.conductor.is/usage/rest).
 
@@ -43,7 +43,7 @@ Conductor, the company, is building a data integration platform for vertical Saa
 
 ## Requirements
 
-1. A Conductor API key pair: one secret key, one publishable key. Please [complete this form](https://forms.gle/1LTGXy2Hcyzw6qWa6) to join the beta.
+1. A Conductor API key pair: one secret key, one publishable key. Please [complete this form](https://73a5v9t55ed.typeform.com/to/VRX7rfrN) to join the beta.
 2. Node.js v16 or later.
 
 ## Installation

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "conductor-node",
-    "version": "11.4.4",
+    "version": "11.5.0",
     "description": "QuickBooks Desktop API for Node.js and TypeScript",
     "keywords": [
         "QuickBooks",
@@ -18,8 +18,8 @@
     ],
     "homepage": "https://conductor.is",
     "repository": "github:conductor-is/conductor-node",
-    "author": "Conductor <support@conductor.is>",
     "license": "MIT",
+    "author": "Conductor <support@conductor.is>",
     "type": "commonjs",
     "main": "dist/src/index.js",
     "types": "dist/src/index.d.ts",
@@ -28,21 +28,21 @@
         "dist/package.json"
     ],
     "scripts": {
-        "prepack": "yarn --silent tsc && yarn --silent delete-compiled-dev-files && yarn --silent tsc-alias",
-        "delete-compiled-dev-files": "rm -rf `find ./dist -type d -name __tests__` ./dist/src/utils/test/*",
-        "postpack": "rm -rf dist",
         "clean": "rm -rf dist package conductor-node-*.tgz tsconfig.tsbuildinfo",
+        "delete-compiled-dev-files": "rm -rf `find ./dist -type d -name __tests__` ./dist/src/utils/test/*",
         "diff": "yarn pack && npm diff --diff=conductor-node@latest --diff=conductor-node-v$(node -p \"require('./package.json').version\").tgz && yarn clean",
+        "prepack": "yarn --silent tsc && yarn --silent delete-compiled-dev-files && yarn --silent tsc-alias",
+        "postpack": "rm -rf dist",
         "prepublishOnly": "yarn jest"
     },
-    "engines": {
-        "node": ">=16"
-    },
     "dependencies": {
         "axios": "^1.4.0"
     },
     "devDependencies": {
         "axios-mock-adapter": "^1.21.4",
         "tsc-alias": "^1.7.0"
+    },
+    "engines": {
+        "node": ">=16"
     }
 }

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

@@ -2563,6 +2563,30 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.TransferInventoryQueryRq) => Promise<NonNullable<QbdTypes.TransferInventoryQueryRs["TransferInventoryRet"]>>;
     };
+    /**
+     * Query deleted transaction elements, such as invoices, bills, and checks.
+     */
+    txnDeleted: {
+        /**
+         * Returns all transaction elements deleted within the last 90 days, grouped
+         * according to object type.
+         *
+         * For example, if the request specifies `TxnDelType` elements of `Bill` and
+         * then `Check`, it will return all the `Bill` deletes first, then all the
+         * `Check` deletes.
+         *
+         * By default, the records are returned in ascending order, according to the
+         * “real” delete time. For example:
+         * - If transaction A is deleted at 10 a.m. and B is deleted at 11 a.m., the
+         *   query request will return A first, then B.
+         * - However, if the QuickBooks user moves the clock back before deleting B
+         *   (for example, B is deleted at 9 a.m.), the query will still return
+         *   first A then B, because B was deleted after A in “real” time.
+         *
+         * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TxnDeletedQuery
+         */
+        query: (endUserId: string, params: QbdTypes.TxnDeletedQueryRq) => Promise<NonNullable<QbdTypes.TxnDeletedQueryRs["TxnDeletedRet"]>>;
+    };
     /**
      * A vehicle is used to add, select, and manage vehicles for tracking and
      * billing mileage.

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

@@ -2568,6 +2568,30 @@ class QbdIntegration extends BaseIntegration_1.default {
          */
         query: async (endUserId, params = {}) => this.sendRequestWrapper(endUserId, { TransferInventoryQueryRq: params }, "TransferInventoryQueryRs", "TransferInventoryRet"),
     };
+    /**
+     * Query deleted transaction elements, such as invoices, bills, and checks.
+     */
+    txnDeleted = {
+        /**
+         * Returns all transaction elements deleted within the last 90 days, grouped
+         * according to object type.
+         *
+         * For example, if the request specifies `TxnDelType` elements of `Bill` and
+         * then `Check`, it will return all the `Bill` deletes first, then all the
+         * `Check` deletes.
+         *
+         * By default, the records are returned in ascending order, according to the
+         * “real” delete time. For example:
+         * - If transaction A is deleted at 10 a.m. and B is deleted at 11 a.m., the
+         *   query request will return A first, then B.
+         * - However, if the QuickBooks user moves the clock back before deleting B
+         *   (for example, B is deleted at 9 a.m.), the query will still return
+         *   first A then B, because B was deleted after A in “real” time.
+         *
+         * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TxnDeletedQuery
+         */
+        query: async (endUserId, params) => this.sendRequestWrapper(endUserId, { TxnDeletedQueryRq: params }, "TxnDeletedQueryRs", "TxnDeletedRet"),
+    };
     /**
      * A vehicle is used to add, select, and manage vehicles for tracking and
      * billing mileage.

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

@@ -3597,6 +3597,12 @@ export type DateMacro = "All" | "LastCalendarQuarter" | "LastCalendarQuarterToDa
 export type DecimalPlaces = "0" | "2";
 /** @default: Period */
 export type DecimalSeparator = "Comma" | "Period";
+export interface DeletedDateRangeFilter {
+    /** Selects objects deleted on or after this date. Both `FromDeletedDate` and `ToDeletedDate` must be between 1970-01-01 and 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST). (But note that `ListDeletedQuery` requests will only return records deleted within the last 90 days, even if the specified `FromDeletedDate` is earlier.) If `FromDeletedDate` includes a date but not a time (for example, if you set it to 2002-02-14), the time is assumed to be zero (2003-02-14T00:00:00). If you omit `FromDeletedDate`, it will be set to 1970-01-01T00:00:00 (1969-12-31T16:00:00-08:00 PST). */
+    FromDeletedDate?: string;
+    /** Selects objects deleted on or before this date. Both `ToDeletedDate` and `FromDeletedDate` must be between 1970-01-01 and 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST). If `ToDeletedDate` includes a date but not a time (for example, if you set it to 2002-02-14), the time is assumed to be the end of the day (2003-02-14T23:59:59). If you omit `ToDeletedDate` altogether, then it will be set to 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST). */
+    ToDeletedDate?: string;
+}
 export interface DepositAdd {
     /** The date of the transaction. In some cases, if you leave `TxnDate` out of an -Add message, QuickBooks will prefill `TxnDate` with the date of the last-saved transaction of the same type. */
     TxnDate?: string;
@@ -12205,6 +12211,30 @@ export interface TxnDateRangeFilter {
     The list given when you click `IQBENDateMacroType` shows the complete list of valid version 3.0 values. */
     DateMacro?: DateMacro;
 }
+export interface TxnDeletedQueryRq {
+    /** A list of enum values showing which types of deleted transactions the query will return. */
+    TxnDelType: TxnDelType | TxnDelType[];
+    /** Filters according to delete dates (within the last 90 days). */
+    DeletedDateRangeFilter?: DeletedDateRangeFilter;
+    /** 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 TxnDeletedQueryRs {
+    TxnDeletedRet: TxnDeletedRet[];
+}
+export interface TxnDeletedRet {
+    /** The type of transaction to be deleted. */
+    TxnDelType: TxnDelType;
+    /** QuickBooks generates a unique `TxnID` for each transaction that is added to QuickBooks. A `TxnID` returned from a request can be used to refer to the transaction in subsequent requests. Notice that you cannot supply the `TxnID` of a `TimeTracking` transaction to `TransactionQueryRq` requests. If you do, you get an error stating that no such record could be found, even though the transaction is in QuickBooks. This behavior reflects the behavior in the QuicKBooks UI in the Find window. */
+    TxnID: string;
+    /** Time the object was created. */
+    TimeCreated: string;
+    /** The time when this list or transaction object was deleted. */
+    TimeDeleted: string;
+    /** A string of characters that refers to this transaction and that can be arbitrarily changed by the QuickBooks user. In a `BillPaymentCheckAdd` request, if you want to set the check number, use `RefNumber`.`Note` (especially relevant to `CheckAdd` requests): When `RefNumber` is left blank in an SDK transaction add request (that is, or ), the `RefNumber` will be left blank in QuickBooks. This behavior is new as of QBFC3. It used to select the next sequential reference number since the last one used by QuickBooks, as though no `RefNumber` had been provided. This is especially relevant to `CheckAdd` requests because with the current behavior, you will not know the number until the check is printed. */
+    RefNumber?: string;
+}
+export type TxnDelType = "ARRefundCreditCard" | "Bill" | "BillPaymentCheck" | "BillPaymentCreditCard" | "BuildAssembly" | "Charge" | "Check" | "CreditCardCharge" | "CreditCardCredit" | "CreditMemo" | "Deposit" | "Estimate" | "InventoryAdjustment" | "Invoice" | "ItemReceipt" | "JournalEntry" | "PayrollLiabilityAdjustment [PRIVATE]" | "PayrollPriorPayment [PRIVATE]" | "PayrollYearToDateAdjustment [PRIVATE]" | "PurchaseOrder" | "ReceivePayment" | "SalesOrder" | "SalesReceipt" | "SalesTaxPaymentCheck" | "TimeTracking" | "TransferInventory" | "VehicleMileage" | "VendorCredit";
 export type TxnType = "ARRefundCreditCard" | "Bill" | "BillPaymentCheck" | "BillPaymentCreditCard" | "BuildAssembly" | "Charge" | "Check" | "CreditCardCharge" | "CreditCardCredit" | "CreditMemo" | "Deposit" | "Estimate" | "InventoryAdjustment" | "Invoice" | "ItemReceipt" | "JournalEntry" | "LiabilityAdjustment" | "Paycheck" | "PayrollLiabilityCheck" | "PurchaseOrder" | "ReceivePayment" | "SalesOrder" | "SalesReceipt" | "SalesTaxPaymentCheck" | "Transfer" | "VendorCredit" | "YTDAdjustment";
 export type TxnTypeFilter = "All" | "ARRefundCreditCard" | "Bill" | "BillPaymentCheck" | "BillPaymentCreditCard" | "BuildAssembly" | "Charge" | "Check" | "CreditCardCharge" | "CreditCardCredit" | "CreditMemo" | "Deposit" | "Estimate" | "InventoryAdjustment" | "Invoice" | "ItemReceipt" | "JournalEntry" | "LiabilityAdjustment" | "Paycheck" | "PayrollLiabilityCheck" | "PurchaseOrder" | "ReceivePayment" | "SalesOrder" | "SalesReceipt" | "SalesTaxPaymentCheck" | "Transfer" | "VendorCredit" | "YTDAdjustment";
 export interface UnitOfMeasureSetRef {

package/dist/src/resources/AuthSessionsResource.d.ts

@@ -26,14 +26,10 @@ export interface AuthSession {
     readonly expiresAt: string;
     /**
      * The URL to which Conductor will redirect the end-user to return to your app
-     * after they complete the authentication flow. If `null`, their browser tab
-     * will close instead.
+     * after they complete the authentication flow. If `undefined`, their browser
+     * tab will close instead.
      */
     readonly redirectUrl: string | undefined;
-    /**
-     * @deprecated Use `redirectUrl` instead.
-     */
-    readonly returnUrl?: string | undefined;
 }
 export interface AuthSessionCreateInput {
     /**
@@ -57,10 +53,6 @@ export interface AuthSessionCreateInput {
      * tab will close instead.
      */
     readonly redirectUrl?: string;
-    /**
-     * @deprecated Use `redirectUrl` instead.
-     */
-    readonly returnUrl?: string;
 }
 export default class AuthSessionsResource extends BaseResource {
     protected readonly ROUTE = "/auth_sessions";

package/dist/src/resources/AuthSessionsResource.js

@@ -12,9 +12,6 @@ class AuthSessionsResource extends BaseResource_1.default {
      * flow.
      */
     async create(input) {
-        if (input.returnUrl !== undefined) {
-            console.warn("The `returnUrl` parameter is deprecated. Please use `redirectUrl` instead.");
-        }
         const { data } = await this.httpClient.post(this.ROUTE, input);
         return data;
     }

package/dist/src/resources/EndUsersResource.d.ts

@@ -2,7 +2,9 @@ import BaseResource from "../resources/BaseResource";
 import type { IntegrationSlug } from "../resources/IntegrationConnectionsResource";
 export interface EndUser {
     /**
-     * The unique identifier for the object.
+     * The unique identifier for this EndUser. You must save this value to your
+     * database because it is how you identify the target of your requests in the
+     * future.
      */
     readonly id: string;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "conductor-node",
-  "version": "11.4.4",
+  "version": "11.5.0",
   "description": "QuickBooks Desktop API for Node.js and TypeScript",
   "keywords": [
     "QuickBooks",
@@ -18,8 +18,8 @@
   ],
   "homepage": "https://conductor.is",
   "repository": "github:conductor-is/conductor-node",
-  "author": "Conductor <support@conductor.is>",
   "license": "MIT",
+  "author": "Conductor <support@conductor.is>",
   "type": "commonjs",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
@@ -28,21 +28,21 @@
     "dist/package.json"
   ],
   "scripts": {
-    "prepack": "yarn --silent tsc && yarn --silent delete-compiled-dev-files && yarn --silent tsc-alias",
-    "delete-compiled-dev-files": "rm -rf `find ./dist -type d -name __tests__` ./dist/src/utils/test/*",
-    "postpack": "rm -rf dist",
     "clean": "rm -rf dist package conductor-node-*.tgz tsconfig.tsbuildinfo",
+    "delete-compiled-dev-files": "rm -rf `find ./dist -type d -name __tests__` ./dist/src/utils/test/*",
     "diff": "yarn pack && npm diff --diff=conductor-node@latest --diff=conductor-node-v$(node -p \"require('./package.json').version\").tgz && yarn clean",
+    "prepack": "yarn --silent tsc && yarn --silent delete-compiled-dev-files && yarn --silent tsc-alias",
+    "postpack": "rm -rf dist",
     "prepublishOnly": "yarn jest"
   },
-  "engines": {
-    "node": ">=16"
-  },
   "dependencies": {
     "axios": "^1.4.0"
   },
   "devDependencies": {
     "axios-mock-adapter": "^1.21.4",
     "tsc-alias": "^1.7.0"
+  },
+  "engines": {
+    "node": ">=16"
   }
 }