conductor-node 3.1.2 → 3.2.1

package/dist/{src/BaseClient.d.ts → BaseClient.d.ts}

@@ -1,4 +1,4 @@
-import type Client from "./Client";
+import type Client from "@conductor/client/Client";
 export default class BaseClient {
     protected readonly root: Client;
     constructor(client: Client);

package/dist/{src/Client.d.ts → Client.d.ts}

@@ -1,5 +1,5 @@
-import type { Environment } from "./environment";
-import ClientQbd from "./qbd/ClientQbd";
+import type { Environment } from "@conductor/client/environment";
+import ClientQbd from "@conductor/client/qbd/ClientQbd";
 export interface ClientOptions {
     /** Log the each request and response. */
     verbose?: boolean;

package/dist/{src/Client.js → Client.js}

@@ -3,8 +3,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const environment_1 = require("./environment");
-const ClientQbd_1 = __importDefault(require("./qbd/ClientQbd"));
+const environment_1 = require("@conductor/client/environment");
+const ClientQbd_1 = __importDefault(require("@conductor/client/qbd/ClientQbd"));
 const graphql_request_1 = require("graphql-request");
 class Client {
     /** QuickBooks Desktop integration. */

package/dist/__tests__/Client.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/Client.test.js

@@ -0,0 +1,16 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const Client_1 = __importDefault(require("@conductor/client/Client"));
+describe("Client", () => {
+    test("Create a new Client", () => {
+        const client = new Client_1.default("mock_api_key");
+        expect(client).toBeInstanceOf(Client_1.default);
+    });
+    test("Create a new Client with options", () => {
+        const client = new Client_1.default("mock_api_key", { environment: "staging" });
+        expect(client).toBeInstanceOf(Client_1.default);
+    });
+});

package/dist/{src/qbd → qbd}/ClientQbd.d.ts

@@ -1,5 +1,5 @@
-import BaseClient from "../BaseClient";
-import type * as qbd from "../qbd/qbdTypes";
+import BaseClient from "@conductor/client/BaseClient";
+import type * as qbd from "@conductor/client/qbd/qbdTypes";
 export default class ClientQbd extends BaseClient {
     account: {
         /**
@@ -28,6 +28,75 @@ export default class ClientQbd extends BaseClient {
          */
         query: (integrationUserConnectionId: string, params: qbd.AccountQueryRq) => Promise<NonNullable<qbd.AccountQueryRs["AccountRet"]>>;
     };
+    check: {
+        /**
+         * The amount of a check is the total of the amounts assigned to expense
+         * lines and item lines. You can write a check for:
+         * - Any expense that you track through expense accounts.
+         * - The following types of items: fixed asset, non-inventory part, service,
+         *   and other charge.
+         * - Putting money into your petty cash account.
+         * - Inventory part items (if you use the inventory/purchase order feature).
+         *
+         * You cannot use a `CheckAdd` for any of the following:
+         * - Paying a bill by check; instead, use a `BillPaymentCheckAdd`.
+         * - Paying employees or create paychecks.
+         * - Paying payroll taxes and liabilities.
+         * - Paying sales tax.
+         * - Paying for received items.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CheckAdd
+         */
+        add: (integrationUserConnectionId: string, params: qbd.CheckAddRq["CheckAdd"]) => Promise<NonNullable<qbd.CheckAddRs["CheckRet"]>>;
+        /**
+         * Modifies an existing Check. Notice that you cannot use this to modify BillPaymentChecks.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CheckMod
+         */
+        mod: (integrationUserConnectionId: string, params: qbd.CheckModRq["CheckMod"]) => Promise<NonNullable<qbd.CheckModRs["CheckRet"]>>;
+        /**
+         * Returns certain types of checks based on the supplied query criteria.
+         * Note that `BillPaymentChecks`, payroll checks, and liability checks are
+         * not returned.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CheckQuery
+         */
+        query: (integrationUserConnectionId: string, params: qbd.CheckQueryRq) => Promise<NonNullable<qbd.CheckQueryRs["CheckRet"]>>;
+    };
+    class: {
+        /**
+         * 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.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ClassAdd
+         */
+        add: (integrationUserConnectionId: string, params: qbd.ClassAddRq["ClassAdd"]) => Promise<NonNullable<qbd.ClassAddRs["ClassRet"]>>;
+        /**
+         * Modifies the specified class.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ClassMod
+         */
+        mod: (integrationUserConnectionId: string, params: qbd.ClassModRq["ClassMod"]) => Promise<NonNullable<qbd.ClassModRs["ClassRet"]>>;
+        /**
+         * Queries for existing classes.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ClassQuery
+         */
+        query: (integrationUserConnectionId: string, params: qbd.ClassQueryRq) => Promise<NonNullable<qbd.ClassQueryRs["ClassRet"]>>;
+    };
     customer: {
         /**
          * The customer list includes information about the QuickBooks user’s
@@ -93,6 +162,61 @@ export default class ClientQbd extends BaseClient {
          */
         query: (integrationUserConnectionId: string, params: qbd.EmployeeQueryRq) => Promise<NonNullable<qbd.EmployeeQueryRs["EmployeeRet"]>>;
     };
+    itemService: {
+        /**
+         * Adds a service item, which is an item that refers to services that a
+         * business charges for or purchases. Examples include specialized labor,
+         * consulting hours, and professional fees. An `ItemServiceRef` aggregate
+         * refers to an item on the ItemService list. In a request, if an
+         * `ItemServiceRef` aggregate includes both `FullName` and `ListID`,
+         * `FullName` will be ignored.
+         *
+         * In a `TimeTracking` message, `ItemServiceRef` refers to the type of work.
+         * If no `CustomerRef` is specified, then `ItemServiceRef` is not needed. If
+         * `IsBillable` is set to true, then `TimeTrackingAdd` must include both
+         * `ItemServiceRef` and `CustomerRef`.
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemServiceAdd
+         */
+        add: (integrationUserConnectionId: string, params: qbd.ItemServiceAddRq["ItemServiceAdd"]) => Promise<NonNullable<qbd.ItemServiceAddRs["ItemServiceRet"]>>;
+        /**
+         * Modifies an existing service item.
+         *
+         * About `SalesOrPurchaseMod` versus `SalesAndPurchaseMod` in an
+         * `ItemServiceMod` request:
+         * - You cannot change the reimbursable status of a service item through the
+         *   SDK. For example, if a service item is marked as non-reimbursable in
+         *   QuickBooks, you cannot send a modify request that includes a
+         *   `SalesAndPurchaseMod` aggregate. Similarly, if you send an
+         *   `ItemServiceAdd` request that includes a `SalesOrPurchase` aggregate,
+         *   you cannot later modify that item using a `SalesAndPurchaseMod`
+         *   aggregate.
+         * - You can modify the various account references using the appropriate
+         *   account reference aggregate and the matching `RefToExistingTxns`
+         *   boolean. You need to use the boolean when you change an account ref
+         *   because the QuickBooks UI displays a prompt asking whether the change
+         *   should apply to existing transactions or not.
+         *   - Specifying `False` means that the mod will not take affect if there
+         *     are existing transactions.
+         *   - Specifying `True` for the boolean basically dismisses this with a
+         *     “Yes” answer, allowing your changes to be made and changes any
+         *     existing transactions that use the item with that `AccountRef`.
+         *     Setting this to `True` should be used with caution and normally only
+         *     after some user has indicated that they want those changes made to
+         *     all those existing transactions! If any affected transactions are
+         *     protected by a closing date and password, the `AccountRef` changes
+         *     will not be made and so the `Mod` request will return an error
+         *     without making the requested `Mod`.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemServiceMod
+         */
+        mod: (integrationUserConnectionId: string, params: qbd.ItemServiceModRq["ItemServiceMod"]) => Promise<NonNullable<qbd.ItemServiceModRs["ItemServiceRet"]>>;
+        /**
+         * Queries for the specified service item or set of items.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemServiceQuery
+         */
+        query: (integrationUserConnectionId: string, params: qbd.ItemServiceQueryRq) => Promise<NonNullable<qbd.ItemServiceQueryRs["ItemServiceRet"]>>;
+    };
     journalEntry: {
         /**
          * The debit and credit lines can be intermingled. A credit line can legally

package/dist/{src/qbd → qbd}/ClientQbd.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 BaseClient_1 = __importDefault(require("../BaseClient"));
+const BaseClient_1 = __importDefault(require("@conductor/client/BaseClient"));
 class ClientQbd extends BaseClient_1.default {
     account = {
         /**
@@ -32,6 +32,75 @@ class ClientQbd extends BaseClient_1.default {
          */
         query: async (integrationUserConnectionId, params) => this.sendRequestBase(integrationUserConnectionId, { AccountQueryRq: params }, "AccountQueryRs", "AccountRet"),
     };
+    check = {
+        /**
+         * The amount of a check is the total of the amounts assigned to expense
+         * lines and item lines. You can write a check for:
+         * - Any expense that you track through expense accounts.
+         * - The following types of items: fixed asset, non-inventory part, service,
+         *   and other charge.
+         * - Putting money into your petty cash account.
+         * - Inventory part items (if you use the inventory/purchase order feature).
+         *
+         * You cannot use a `CheckAdd` for any of the following:
+         * - Paying a bill by check; instead, use a `BillPaymentCheckAdd`.
+         * - Paying employees or create paychecks.
+         * - Paying payroll taxes and liabilities.
+         * - Paying sales tax.
+         * - Paying for received items.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CheckAdd
+         */
+        add: async (integrationUserConnectionId, params) => this.sendRequestBase(integrationUserConnectionId, { CheckAddRq: { CheckAdd: params } }, "CheckAddRs", "CheckRet"),
+        /**
+         * Modifies an existing Check. Notice that you cannot use this to modify BillPaymentChecks.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CheckMod
+         */
+        mod: async (integrationUserConnectionId, params) => this.sendRequestBase(integrationUserConnectionId, { CheckModRq: { CheckMod: params } }, "CheckModRs", "CheckRet"),
+        /**
+         * Returns certain types of checks based on the supplied query criteria.
+         * Note that `BillPaymentChecks`, payroll checks, and liability checks are
+         * not returned.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CheckQuery
+         */
+        query: async (integrationUserConnectionId, params) => this.sendRequestBase(integrationUserConnectionId, { CheckQueryRq: params }, "CheckQueryRs", "CheckRet"),
+    };
+    class = {
+        /**
+         * 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.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ClassAdd
+         */
+        add: async (integrationUserConnectionId, params) => this.sendRequestBase(integrationUserConnectionId, { ClassAddRq: { ClassAdd: params } }, "ClassAddRs", "ClassRet"),
+        /**
+         * Modifies the specified class.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ClassMod
+         */
+        mod: async (integrationUserConnectionId, params) => this.sendRequestBase(integrationUserConnectionId, { ClassModRq: { ClassMod: params } }, "ClassModRs", "ClassRet"),
+        /**
+         * Queries for existing classes.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ClassQuery
+         */
+        query: async (integrationUserConnectionId, params) => this.sendRequestBase(integrationUserConnectionId, { ClassQueryRq: params }, "ClassQueryRs", "ClassRet"),
+    };
     customer = {
         /**
          * The customer list includes information about the QuickBooks user’s
@@ -97,6 +166,61 @@ class ClientQbd extends BaseClient_1.default {
          */
         query: async (integrationUserConnectionId, params) => this.sendRequestBase(integrationUserConnectionId, { EmployeeQueryRq: params }, "EmployeeQueryRs", "EmployeeRet"),
     };
+    itemService = {
+        /**
+         * Adds a service item, which is an item that refers to services that a
+         * business charges for or purchases. Examples include specialized labor,
+         * consulting hours, and professional fees. An `ItemServiceRef` aggregate
+         * refers to an item on the ItemService list. In a request, if an
+         * `ItemServiceRef` aggregate includes both `FullName` and `ListID`,
+         * `FullName` will be ignored.
+         *
+         * In a `TimeTracking` message, `ItemServiceRef` refers to the type of work.
+         * If no `CustomerRef` is specified, then `ItemServiceRef` is not needed. If
+         * `IsBillable` is set to true, then `TimeTrackingAdd` must include both
+         * `ItemServiceRef` and `CustomerRef`.
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemServiceAdd
+         */
+        add: async (integrationUserConnectionId, params) => this.sendRequestBase(integrationUserConnectionId, { ItemServiceAddRq: { ItemServiceAdd: params } }, "ItemServiceAddRs", "ItemServiceRet"),
+        /**
+         * Modifies an existing service item.
+         *
+         * About `SalesOrPurchaseMod` versus `SalesAndPurchaseMod` in an
+         * `ItemServiceMod` request:
+         * - You cannot change the reimbursable status of a service item through the
+         *   SDK. For example, if a service item is marked as non-reimbursable in
+         *   QuickBooks, you cannot send a modify request that includes a
+         *   `SalesAndPurchaseMod` aggregate. Similarly, if you send an
+         *   `ItemServiceAdd` request that includes a `SalesOrPurchase` aggregate,
+         *   you cannot later modify that item using a `SalesAndPurchaseMod`
+         *   aggregate.
+         * - You can modify the various account references using the appropriate
+         *   account reference aggregate and the matching `RefToExistingTxns`
+         *   boolean. You need to use the boolean when you change an account ref
+         *   because the QuickBooks UI displays a prompt asking whether the change
+         *   should apply to existing transactions or not.
+         *   - Specifying `False` means that the mod will not take affect if there
+         *     are existing transactions.
+         *   - Specifying `True` for the boolean basically dismisses this with a
+         *     “Yes” answer, allowing your changes to be made and changes any
+         *     existing transactions that use the item with that `AccountRef`.
+         *     Setting this to `True` should be used with caution and normally only
+         *     after some user has indicated that they want those changes made to
+         *     all those existing transactions! If any affected transactions are
+         *     protected by a closing date and password, the `AccountRef` changes
+         *     will not be made and so the `Mod` request will return an error
+         *     without making the requested `Mod`.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemServiceMod
+         */
+        mod: async (integrationUserConnectionId, params) => this.sendRequestBase(integrationUserConnectionId, { ItemServiceModRq: { ItemServiceMod: params } }, "ItemServiceModRs", "ItemServiceRet"),
+        /**
+         * Queries for the specified service item or set of items.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemServiceQuery
+         */
+        query: async (integrationUserConnectionId, params) => this.sendRequestBase(integrationUserConnectionId, { ItemServiceQueryRq: params }, "ItemServiceQueryRs", "ItemServiceRet"),
+    };
     journalEntry = {
         /**
          * The debit and credit lines can be intermingled. A credit line can legally

package/dist/qbd/__tests__/ClientQbd.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/qbd/__tests__/ClientQbd.test.js

@@ -0,0 +1,26 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const Client_1 = __importDefault(require("@conductor/client/Client"));
+describe("ClientQbd", () => {
+    const client = new Client_1.default("sk_test_miter", { environment: "staging" });
+    jest.setTimeout(10000);
+    describe("Mock staging request", () => {
+        test("Returns success", async () => {
+            const response = await client.qbd.customer.add("mock_qbd_user_connection_id", { Name: `Test Customer ${Date.now()}` });
+            expect(response).toBeDefined();
+        });
+        test("Throws an error for an unrecognizable field", async () => {
+            try {
+                await client.qbd.customer.add("mock_qbd_user_connection_id", 
+                // @ts-expect-error - Intentionally passing an invalid field.
+                { UnrecognizableField: true });
+            }
+            catch (error) {
+                expect(error).toBeDefined();
+            }
+        });
+    });
+});