conductor-node 3.3.0 → 3.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,5 +1,7 @@
1
1
  import type { Environment } from "./environment";
2
2
  import ClientQbd from "./qbd/ClientQbd";
3
+ import type * as QbdTypes from "./qbd/qbdTypes";
4
+ export { QbdTypes };
3
5
  export interface ClientOptions {
4
6
  /** Log the each request and response. */
5
7
  verbose?: boolean;
@@ -42,7 +42,7 @@ class Client {
42
42
  // integration clients to access it.
43
43
  async integrationRequest(integrationRequestParams) {
44
44
  if (this.verbose) {
45
- console.log(`Client sent request to ${this.serverURL}:`, JSON.stringify(integrationRequestParams, null, 2));
45
+ console.log(`Client sent request to ${this.serverURL}:`, JSON.stringify(integrationRequestParams, undefined, 2));
46
46
  console.time("Request time");
47
47
  }
48
48
  const response = await this.gqlClient.request(`#graphql
@@ -54,7 +54,7 @@ class Client {
54
54
  const responseBody = response.integrationRequest;
55
55
  if (this.verbose) {
56
56
  console.timeEnd("Request time");
57
- console.log(`Client received response from ${this.serverURL}:`, JSON.stringify(responseBody, null, 2));
57
+ console.log(`Client received response from ${this.serverURL}:`, JSON.stringify(responseBody, undefined, 2));
58
58
  }
59
59
  return responseBody;
60
60
  }
@@ -5,12 +5,15 @@ const STAGING_BASE_URL = "https://staging.api.conductor.is";
5
5
  const DEVELOPMENT_BASE_URL = "https://conductor.ngrok.io";
6
6
  function envToBaseServerURL(environment) {
7
7
  switch (environment) {
8
- case "staging":
8
+ case "staging": {
9
9
  return STAGING_BASE_URL;
10
- case "development":
10
+ }
11
+ case "development": {
11
12
  return DEVELOPMENT_BASE_URL;
12
- default:
13
+ }
14
+ default: {
13
15
  throw new Error("Invalid environment");
16
+ }
14
17
  }
15
18
  }
16
19
  exports.envToBaseServerURL = envToBaseServerURL;
@@ -1,5 +1,5 @@
1
1
  import BaseClient from "../BaseClient";
2
- import type * as qbd from "../qbd/qbdTypes";
2
+ import type * as QbdTypes from "../qbd/qbdTypes";
3
3
  export default class ClientQbd extends BaseClient {
4
4
  account: {
5
5
  /**
@@ -9,13 +9,13 @@ export default class ClientQbd extends BaseClient {
9
9
  *
10
10
  * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/AccountAdd
11
11
  */
12
- add: (integrationUserConnectionId: string, params: qbd.AccountAddRq["AccountAdd"]) => Promise<NonNullable<qbd.AccountAddRs["AccountRet"]>>;
12
+ add: (integrationUserConnectionId: string, params: QbdTypes.AccountAddRq["AccountAdd"]) => Promise<NonNullable<QbdTypes.AccountAddRs["AccountRet"]>>;
13
13
  /**
14
14
  * Modifies an account.
15
15
  *
16
16
  * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/AccountMod
17
17
  */
18
- mod: (integrationUserConnectionId: string, params: qbd.AccountModRq["AccountMod"]) => Promise<NonNullable<qbd.AccountModRs["AccountRet"]>>;
18
+ mod: (integrationUserConnectionId: string, params: QbdTypes.AccountModRq["AccountMod"]) => Promise<NonNullable<QbdTypes.AccountModRs["AccountRet"]>>;
19
19
  /**
20
20
  * `AccountQuery` is a list query that returns data for all accounts that
21
21
  * match the provided filter criteria. Notice that it returns only data
@@ -26,7 +26,7 @@ export default class ClientQbd extends BaseClient {
26
26
  *
27
27
  * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/AccountQuery
28
28
  */
29
- query: (integrationUserConnectionId: string, params: qbd.AccountQueryRq) => Promise<NonNullable<qbd.AccountQueryRs["AccountRet"]>>;
29
+ query: (integrationUserConnectionId: string, params: QbdTypes.AccountQueryRq) => Promise<NonNullable<QbdTypes.AccountQueryRs["AccountRet"]>>;
30
30
  };
31
31
  bill: {
32
32
  /**
@@ -81,7 +81,7 @@ export default class ClientQbd extends BaseClient {
81
81
  *
82
82
  * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BillAdd
83
83
  */
84
- add: (integrationUserConnectionId: string, params: qbd.BillAddRq["BillAdd"]) => Promise<NonNullable<qbd.BillAddRs["BillRet"]>>;
84
+ add: (integrationUserConnectionId: string, params: QbdTypes.BillAddRq["BillAdd"]) => Promise<NonNullable<QbdTypes.BillAddRs["BillRet"]>>;
85
85
  /**
86
86
  * Edit an existing Bill, similar to editing a Bill in the Enter Bills form
87
87
  * in the QuickBooks UI.
@@ -117,7 +117,7 @@ export default class ClientQbd extends BaseClient {
117
117
  *
118
118
  * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BillMod
119
119
  */
120
- mod: (integrationUserConnectionId: string, params: qbd.BillModRq["BillMod"]) => Promise<NonNullable<qbd.BillModRs["BillRet"]>>;
120
+ mod: (integrationUserConnectionId: string, params: QbdTypes.BillModRq["BillMod"]) => Promise<NonNullable<QbdTypes.BillModRs["BillRet"]>>;
121
121
  /**
122
122
  * Provides functionality found in the Find/Advanced-Find window to find
123
123
  * bills that are to be paid by check. The Find/Advanced-Find windows can be
@@ -164,7 +164,7 @@ export default class ClientQbd extends BaseClient {
164
164
  *
165
165
  * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BillQuery
166
166
  */
167
- query: (integrationUserConnectionId: string, params: qbd.BillQueryRq) => Promise<NonNullable<qbd.BillQueryRs["BillRet"]>>;
167
+ query: (integrationUserConnectionId: string, params: QbdTypes.BillQueryRq) => Promise<NonNullable<QbdTypes.BillQueryRs["BillRet"]>>;
168
168
  };
169
169
  billPaymentCheck: {
170
170
  /**
@@ -200,7 +200,7 @@ export default class ClientQbd extends BaseClient {
200
200
  *
201
201
  * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BillPaymentCheckAdd
202
202
  */
203
- add: (integrationUserConnectionId: string, params: qbd.BillPaymentCheckAddRq["BillPaymentCheckAdd"]) => Promise<NonNullable<qbd.BillPaymentCheckAddRs["BillPaymentCheckRet"]>>;
203
+ add: (integrationUserConnectionId: string, params: QbdTypes.BillPaymentCheckAddRq["BillPaymentCheckAdd"]) => Promise<NonNullable<QbdTypes.BillPaymentCheckAddRs["BillPaymentCheckRet"]>>;
204
204
  /**
205
205
  * Modifies the specified bill payment check.
206
206
  *
@@ -247,7 +247,7 @@ export default class ClientQbd extends BaseClient {
247
247
  *
248
248
  * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BillPaymentCheckMod
249
249
  */
250
- mod: (integrationUserConnectionId: string, params: qbd.BillPaymentCheckModRq["BillPaymentCheckMod"]) => Promise<NonNullable<qbd.BillPaymentCheckModRs["BillPaymentCheckRet"]>>;
250
+ mod: (integrationUserConnectionId: string, params: QbdTypes.BillPaymentCheckModRq["BillPaymentCheckMod"]) => Promise<NonNullable<QbdTypes.BillPaymentCheckModRs["BillPaymentCheckRet"]>>;
251
251
  /**
252
252
  * Provides functionality found in the Find/Advanced-Find window to find
253
253
  * bill payments paid by check. The Find/Advanced-Find windows can be
@@ -281,7 +281,7 @@ export default class ClientQbd extends BaseClient {
281
281
  *
282
282
  * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BillPaymentCheckQuery
283
283
  */
284
- query: (integrationUserConnectionId: string, params: qbd.BillPaymentCheckQueryRq) => Promise<NonNullable<qbd.BillPaymentCheckQueryRs["BillPaymentCheckRet"]>>;
284
+ query: (integrationUserConnectionId: string, params: QbdTypes.BillPaymentCheckQueryRq) => Promise<NonNullable<QbdTypes.BillPaymentCheckQueryRs["BillPaymentCheckRet"]>>;
285
285
  };
286
286
  check: {
287
287
  /**
@@ -302,13 +302,13 @@ export default class ClientQbd extends BaseClient {
302
302
  *
303
303
  * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CheckAdd
304
304
  */
305
- add: (integrationUserConnectionId: string, params: qbd.CheckAddRq["CheckAdd"]) => Promise<NonNullable<qbd.CheckAddRs["CheckRet"]>>;
305
+ add: (integrationUserConnectionId: string, params: QbdTypes.CheckAddRq["CheckAdd"]) => Promise<NonNullable<QbdTypes.CheckAddRs["CheckRet"]>>;
306
306
  /**
307
307
  * Modifies an existing Check. Notice that you cannot use this to modify BillPaymentChecks.
308
308
  *
309
309
  * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CheckMod
310
310
  */
311
- mod: (integrationUserConnectionId: string, params: qbd.CheckModRq["CheckMod"]) => Promise<NonNullable<qbd.CheckModRs["CheckRet"]>>;
311
+ mod: (integrationUserConnectionId: string, params: QbdTypes.CheckModRq["CheckMod"]) => Promise<NonNullable<QbdTypes.CheckModRs["CheckRet"]>>;
312
312
  /**
313
313
  * Returns certain types of checks based on the supplied query criteria.
314
314
  * Note that `BillPaymentChecks`, payroll checks, and liability checks are
@@ -316,7 +316,7 @@ export default class ClientQbd extends BaseClient {
316
316
  *
317
317
  * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CheckQuery
318
318
  */
319
- query: (integrationUserConnectionId: string, params: qbd.CheckQueryRq) => Promise<NonNullable<qbd.CheckQueryRs["CheckRet"]>>;
319
+ query: (integrationUserConnectionId: string, params: QbdTypes.CheckQueryRq) => Promise<NonNullable<QbdTypes.CheckQueryRs["CheckRet"]>>;
320
320
  };
321
321
  class: {
322
322
  /**
@@ -338,19 +338,19 @@ export default class ClientQbd extends BaseClient {
338
338
  *
339
339
  * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ClassAdd
340
340
  */
341
- add: (integrationUserConnectionId: string, params: qbd.ClassAddRq["ClassAdd"]) => Promise<NonNullable<qbd.ClassAddRs["ClassRet"]>>;
341
+ add: (integrationUserConnectionId: string, params: QbdTypes.ClassAddRq["ClassAdd"]) => Promise<NonNullable<QbdTypes.ClassAddRs["ClassRet"]>>;
342
342
  /**
343
343
  * Modifies the specified class.
344
344
  *
345
345
  * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ClassMod
346
346
  */
347
- mod: (integrationUserConnectionId: string, params: qbd.ClassModRq["ClassMod"]) => Promise<NonNullable<qbd.ClassModRs["ClassRet"]>>;
347
+ mod: (integrationUserConnectionId: string, params: QbdTypes.ClassModRq["ClassMod"]) => Promise<NonNullable<QbdTypes.ClassModRs["ClassRet"]>>;
348
348
  /**
349
349
  * Queries for existing classes.
350
350
  *
351
351
  * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ClassQuery
352
352
  */
353
- query: (integrationUserConnectionId: string, params: qbd.ClassQueryRq) => Promise<NonNullable<qbd.ClassQueryRs["ClassRet"]>>;
353
+ query: (integrationUserConnectionId: string, params: QbdTypes.ClassQueryRq) => Promise<NonNullable<QbdTypes.ClassQueryRs["ClassRet"]>>;
354
354
  };
355
355
  customer: {
356
356
  /**
@@ -375,13 +375,13 @@ export default class ClientQbd extends BaseClient {
375
375
  *
376
376
  * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CustomerAdd
377
377
  */
378
- add: (integrationUserConnectionId: string, params: qbd.CustomerAddRq["CustomerAdd"]) => Promise<NonNullable<qbd.CustomerAddRs["CustomerRet"]>>;
378
+ add: (integrationUserConnectionId: string, params: QbdTypes.CustomerAddRq["CustomerAdd"]) => Promise<NonNullable<QbdTypes.CustomerAddRs["CustomerRet"]>>;
379
379
  /**
380
380
  * Modifies the customer record.
381
381
  *
382
382
  * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CustomerMod
383
383
  */
384
- mod: (integrationUserConnectionId: string, params: qbd.CustomerModRq["CustomerMod"]) => Promise<NonNullable<qbd.CustomerModRs["CustomerRet"]>>;
384
+ mod: (integrationUserConnectionId: string, params: QbdTypes.CustomerModRq["CustomerMod"]) => Promise<NonNullable<QbdTypes.CustomerModRs["CustomerRet"]>>;
385
385
  /**
386
386
  * Returns data for the specified customers.
387
387
  *
@@ -394,7 +394,7 @@ export default class ClientQbd extends BaseClient {
394
394
  *
395
395
  * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CustomerQuery
396
396
  */
397
- query: (integrationUserConnectionId: string, params: qbd.CustomerQueryRq) => Promise<NonNullable<qbd.CustomerQueryRs["CustomerRet"]>>;
397
+ query: (integrationUserConnectionId: string, params: QbdTypes.CustomerQueryRq) => Promise<NonNullable<QbdTypes.CustomerQueryRs["CustomerRet"]>>;
398
398
  };
399
399
  employee: {
400
400
  /**
@@ -403,19 +403,19 @@ export default class ClientQbd extends BaseClient {
403
403
  *
404
404
  * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/EmployeeAdd
405
405
  */
406
- add: (integrationUserConnectionId: string, params: qbd.EmployeeAddRq["EmployeeAdd"]) => Promise<NonNullable<qbd.EmployeeAddRs["EmployeeRet"]>>;
406
+ add: (integrationUserConnectionId: string, params: QbdTypes.EmployeeAddRq["EmployeeAdd"]) => Promise<NonNullable<QbdTypes.EmployeeAddRs["EmployeeRet"]>>;
407
407
  /**
408
408
  * Modifies an existing employee.
409
409
  *
410
410
  * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/EmployeeMod
411
411
  */
412
- mod: (integrationUserConnectionId: string, params: qbd.EmployeeModRq["EmployeeMod"]) => Promise<NonNullable<qbd.EmployeeModRs["EmployeeRet"]>>;
412
+ mod: (integrationUserConnectionId: string, params: QbdTypes.EmployeeModRq["EmployeeMod"]) => Promise<NonNullable<QbdTypes.EmployeeModRs["EmployeeRet"]>>;
413
413
  /**
414
414
  * Returns employee data.
415
415
  *
416
416
  * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/EmployeeQuery
417
417
  */
418
- query: (integrationUserConnectionId: string, params: qbd.EmployeeQueryRq) => Promise<NonNullable<qbd.EmployeeQueryRs["EmployeeRet"]>>;
418
+ query: (integrationUserConnectionId: string, params: QbdTypes.EmployeeQueryRq) => Promise<NonNullable<QbdTypes.EmployeeQueryRs["EmployeeRet"]>>;
419
419
  };
420
420
  itemService: {
421
421
  /**
@@ -432,7 +432,7 @@ export default class ClientQbd extends BaseClient {
432
432
  * `ItemServiceRef` and `CustomerRef`.
433
433
  * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemServiceAdd
434
434
  */
435
- add: (integrationUserConnectionId: string, params: qbd.ItemServiceAddRq["ItemServiceAdd"]) => Promise<NonNullable<qbd.ItemServiceAddRs["ItemServiceRet"]>>;
435
+ add: (integrationUserConnectionId: string, params: QbdTypes.ItemServiceAddRq["ItemServiceAdd"]) => Promise<NonNullable<QbdTypes.ItemServiceAddRs["ItemServiceRet"]>>;
436
436
  /**
437
437
  * Modifies an existing service item.
438
438
  *
@@ -464,13 +464,13 @@ export default class ClientQbd extends BaseClient {
464
464
  *
465
465
  * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemServiceMod
466
466
  */
467
- mod: (integrationUserConnectionId: string, params: qbd.ItemServiceModRq["ItemServiceMod"]) => Promise<NonNullable<qbd.ItemServiceModRs["ItemServiceRet"]>>;
467
+ mod: (integrationUserConnectionId: string, params: QbdTypes.ItemServiceModRq["ItemServiceMod"]) => Promise<NonNullable<QbdTypes.ItemServiceModRs["ItemServiceRet"]>>;
468
468
  /**
469
469
  * Queries for the specified service item or set of items.
470
470
  *
471
471
  * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemServiceQuery
472
472
  */
473
- query: (integrationUserConnectionId: string, params: qbd.ItemServiceQueryRq) => Promise<NonNullable<qbd.ItemServiceQueryRs["ItemServiceRet"]>>;
473
+ query: (integrationUserConnectionId: string, params: QbdTypes.ItemServiceQueryRq) => Promise<NonNullable<QbdTypes.ItemServiceQueryRs["ItemServiceRet"]>>;
474
474
  };
475
475
  journalEntry: {
476
476
  /**
@@ -504,7 +504,7 @@ export default class ClientQbd extends BaseClient {
504
504
  *
505
505
  * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/JournalEntryAdd
506
506
  */
507
- add: (integrationUserConnectionId: string, params: qbd.JournalEntryAddRq["JournalEntryAdd"]) => Promise<NonNullable<qbd.JournalEntryAddRs["JournalEntryRet"]>>;
507
+ add: (integrationUserConnectionId: string, params: QbdTypes.JournalEntryAddRq["JournalEntryAdd"]) => Promise<NonNullable<QbdTypes.JournalEntryAddRs["JournalEntryRet"]>>;
508
508
  /**
509
509
  * Modifies a journal entry.
510
510
  *
@@ -514,7 +514,7 @@ export default class ClientQbd extends BaseClient {
514
514
  *
515
515
  * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/JournalEntryMod
516
516
  */
517
- mod: (integrationUserConnectionId: string, params: qbd.JournalEntryModRq["JournalEntryMod"]) => Promise<NonNullable<qbd.JournalEntryModRs["JournalEntryRet"]>>;
517
+ mod: (integrationUserConnectionId: string, params: QbdTypes.JournalEntryModRq["JournalEntryMod"]) => Promise<NonNullable<QbdTypes.JournalEntryModRs["JournalEntryRet"]>>;
518
518
  /**
519
519
  * In traditional accounting, transactions are entered into the general
520
520
  * journal and categorized exclusively by account. In QuickBooks, most
@@ -539,7 +539,7 @@ export default class ClientQbd extends BaseClient {
539
539
  *
540
540
  * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/JournalEntryQuery
541
541
  */
542
- query: (integrationUserConnectionId: string, params: qbd.JournalEntryQueryRq) => Promise<NonNullable<qbd.JournalEntryQueryRs["JournalEntryRet"]>>;
542
+ query: (integrationUserConnectionId: string, params: QbdTypes.JournalEntryQueryRq) => Promise<NonNullable<QbdTypes.JournalEntryQueryRs["JournalEntryRet"]>>;
543
543
  };
544
544
  timeTracking: {
545
545
  /**
@@ -552,7 +552,7 @@ export default class ClientQbd extends BaseClient {
552
552
  *
553
553
  * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TimeTrackingQuery
554
554
  */
555
- add: (integrationUserConnectionId: string, params: qbd.TimeTrackingAddRq["TimeTrackingAdd"]) => Promise<NonNullable<qbd.TimeTrackingAddRs["TimeTrackingRet"]>>;
555
+ add: (integrationUserConnectionId: string, params: QbdTypes.TimeTrackingAddRq["TimeTrackingAdd"]) => Promise<NonNullable<QbdTypes.TimeTrackingAddRs["TimeTrackingRet"]>>;
556
556
  /**
557
557
  * Modifies a time tracking transaction.
558
558
  *
@@ -579,7 +579,7 @@ export default class ClientQbd extends BaseClient {
579
579
  *
580
580
  * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TimeTrackingMod
581
581
  */
582
- mod: (integrationUserConnectionId: string, params: qbd.TimeTrackingModRq["TimeTrackingMod"]) => Promise<NonNullable<qbd.TimeTrackingModRs["TimeTrackingRet"]>>;
582
+ mod: (integrationUserConnectionId: string, params: QbdTypes.TimeTrackingModRq["TimeTrackingMod"]) => Promise<NonNullable<QbdTypes.TimeTrackingModRs["TimeTrackingRet"]>>;
583
583
  /**
584
584
  * The time-tracking transactions that are returned in this query include
585
585
  * time tracking information that was entered into QuickBooks manually or
@@ -590,7 +590,7 @@ export default class ClientQbd extends BaseClient {
590
590
  *
591
591
  * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TimeTrackingQuery
592
592
  */
593
- query: (integrationUserConnectionId: string, params: qbd.TimeTrackingQueryRq) => Promise<NonNullable<qbd.TimeTrackingQueryRs["TimeTrackingRet"]>>;
593
+ query: (integrationUserConnectionId: string, params: QbdTypes.TimeTrackingQueryRq) => Promise<NonNullable<QbdTypes.TimeTrackingQueryRs["TimeTrackingRet"]>>;
594
594
  };
595
595
  vendor: {
596
596
  /**
@@ -606,19 +606,19 @@ export default class ClientQbd extends BaseClient {
606
606
  *
607
607
  * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/VendorAdd
608
608
  */
609
- add: (integrationUserConnectionId: string, params: qbd.VendorAddRq["VendorAdd"]) => Promise<NonNullable<qbd.VendorAddRs["VendorRet"]>>;
609
+ add: (integrationUserConnectionId: string, params: QbdTypes.VendorAddRq["VendorAdd"]) => Promise<NonNullable<QbdTypes.VendorAddRs["VendorRet"]>>;
610
610
  /**
611
611
  * Modifies a vendor.
612
612
  *
613
613
  * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/VendorMod
614
614
  */
615
- mod: (integrationUserConnectionId: string, params: qbd.VendorModRq["VendorMod"]) => Promise<NonNullable<qbd.VendorModRs["VendorRet"]>>;
615
+ mod: (integrationUserConnectionId: string, params: QbdTypes.VendorModRq["VendorMod"]) => Promise<NonNullable<QbdTypes.VendorModRs["VendorRet"]>>;
616
616
  /**
617
617
  * Queries for the specified vendor or set of vendors.
618
618
  *
619
619
  * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/VendorQuery
620
620
  */
621
- query: (integrationUserConnectionId: string, params: qbd.VendorQueryRq) => Promise<NonNullable<qbd.VendorQueryRs["VendorRet"]>>;
621
+ query: (integrationUserConnectionId: string, params: QbdTypes.VendorQueryRq) => Promise<NonNullable<QbdTypes.VendorQueryRs["VendorRet"]>>;
622
622
  };
623
623
  /**
624
624
  * Send any QBXML request to QuickBooks Desktop.
@@ -6,21 +6,25 @@ Object.defineProperty(exports, "__esModule", { value: true });
6
6
  const Client_1 = __importDefault(require("../../Client"));
7
7
  describe("ClientQbd", () => {
8
8
  const client = new Client_1.default("sk_test_miter", { environment: "staging" });
9
- jest.setTimeout(10000);
9
+ const mockQbdUserConnectionId = "mock_qbd_user_connection_id";
10
+ jest.setTimeout(10_000);
10
11
  describe("Mock staging request", () => {
11
12
  test("Returns success", async () => {
12
- const response = await client.qbd.customer.add("mock_qbd_user_connection_id", { Name: `Test Customer ${Date.now()}` });
13
+ expect.hasAssertions();
14
+ const response = await client.qbd.customer.query(mockQbdUserConnectionId, {
15
+ MaxReturned: 3,
16
+ NameFilter: {
17
+ Name: "Mock",
18
+ MatchCriterion: "StartsWith",
19
+ },
20
+ });
13
21
  expect(response).toBeDefined();
14
22
  });
15
23
  test("Throws an error for an unrecognizable field", async () => {
16
- try {
17
- await client.qbd.customer.add("mock_qbd_user_connection_id",
18
- // @ts-expect-error - Intentionally passing an invalid field.
19
- { UnrecognizableField: true });
20
- }
21
- catch (error) {
22
- expect(error).toBeDefined();
23
- }
24
+ expect.hasAssertions();
25
+ await expect(async () => client.qbd.customer.add(mockQbdUserConnectionId,
26
+ // @ts-expect-error - Intentionally passing an invalid field.
27
+ { UnrecognizableField: true })).rejects.toThrow("This element is not expected.");
24
28
  });
25
29
  });
26
30
  });