conductor-node 12.7.0 → 12.8.1

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.
Files changed (106) hide show
  1. package/CHANGELOG.md +23 -0
  2. package/README.md +4 -4
  3. package/package.json +1 -1
  4. package/resources/qbd/index.d.ts +2 -1
  5. package/resources/qbd/index.d.ts.map +1 -1
  6. package/resources/qbd/index.js +3 -2
  7. package/resources/qbd/index.js.map +1 -1
  8. package/resources/qbd/index.mjs +2 -1
  9. package/resources/qbd/index.mjs.map +1 -1
  10. package/resources/qbd/other-names.d.ts +690 -0
  11. package/resources/qbd/other-names.d.ts.map +1 -0
  12. package/resources/qbd/other-names.js +88 -0
  13. package/resources/qbd/other-names.js.map +1 -0
  14. package/resources/qbd/other-names.mjs +84 -0
  15. package/resources/qbd/other-names.mjs.map +1 -0
  16. package/resources/qbd/payment-methods.d.ts +35 -13
  17. package/resources/qbd/payment-methods.d.ts.map +1 -1
  18. package/resources/qbd/payment-methods.js +7 -14
  19. package/resources/qbd/payment-methods.js.map +1 -1
  20. package/resources/qbd/payment-methods.mjs +6 -12
  21. package/resources/qbd/payment-methods.mjs.map +1 -1
  22. package/resources/qbd/qbd.d.ts +6 -2
  23. package/resources/qbd/qbd.d.ts.map +1 -1
  24. package/resources/qbd/qbd.js +4 -1
  25. package/resources/qbd/qbd.js.map +1 -1
  26. package/resources/qbd/qbd.mjs +5 -2
  27. package/resources/qbd/qbd.mjs.map +1 -1
  28. package/src/_shims/auto/runtime-bun.ts +1 -1
  29. package/src/_shims/auto/runtime-node.ts +1 -1
  30. package/src/_shims/auto/runtime.ts +1 -1
  31. package/src/_shims/auto/types-node.ts +1 -1
  32. package/src/_shims/bun-runtime.ts +2 -2
  33. package/src/_shims/index.d.ts +3 -3
  34. package/src/_shims/index.mjs +1 -1
  35. package/src/_shims/node-runtime.ts +3 -3
  36. package/src/_shims/registry.ts +1 -1
  37. package/src/_shims/web-runtime.ts +3 -3
  38. package/src/core.ts +5 -5
  39. package/src/error.ts +1 -1
  40. package/src/index.ts +13 -13
  41. package/src/internal/qs/formats.ts +1 -1
  42. package/src/internal/qs/index.ts +3 -3
  43. package/src/internal/qs/stringify.ts +3 -3
  44. package/src/internal/qs/utils.ts +2 -2
  45. package/src/pagination.ts +1 -1
  46. package/src/resource.ts +1 -1
  47. package/src/resources/auth-sessions.ts +2 -2
  48. package/src/resources/end-users.ts +3 -3
  49. package/src/resources/index.ts +3 -3
  50. package/src/resources/qbd/account-tax-lines.ts +2 -2
  51. package/src/resources/qbd/accounts.ts +2 -2
  52. package/src/resources/qbd/bill-check-payments.ts +3 -3
  53. package/src/resources/qbd/bill-credit-card-payments.ts +3 -3
  54. package/src/resources/qbd/bills.ts +3 -3
  55. package/src/resources/qbd/checks.ts +3 -3
  56. package/src/resources/qbd/classes.ts +2 -2
  57. package/src/resources/qbd/company.ts +2 -2
  58. package/src/resources/qbd/credit-card-charges.ts +3 -3
  59. package/src/resources/qbd/credit-card-credits.ts +3 -3
  60. package/src/resources/qbd/credit-memos.ts +3 -3
  61. package/src/resources/qbd/customers.ts +3 -3
  62. package/src/resources/qbd/date-driven-terms.ts +2 -2
  63. package/src/resources/qbd/discount-items.ts +3 -3
  64. package/src/resources/qbd/employees.ts +3 -3
  65. package/src/resources/qbd/estimates.ts +3 -3
  66. package/src/resources/qbd/index.ts +56 -47
  67. package/src/resources/qbd/inventory-adjustments.ts +2 -2
  68. package/src/resources/qbd/inventory-assembly-items.ts +3 -3
  69. package/src/resources/qbd/inventory-items.ts +3 -3
  70. package/src/resources/qbd/inventory-sites.ts +2 -2
  71. package/src/resources/qbd/invoices.ts +3 -3
  72. package/src/resources/qbd/item-groups.ts +3 -3
  73. package/src/resources/qbd/item-receipts.ts +3 -3
  74. package/src/resources/qbd/item-sites.ts +3 -3
  75. package/src/resources/qbd/journal-entries.ts +3 -3
  76. package/src/resources/qbd/non-inventory-items.ts +3 -3
  77. package/src/resources/qbd/other-names.ts +855 -0
  78. package/src/resources/qbd/payment-methods.ts +42 -18
  79. package/src/resources/qbd/payroll-wage-items.ts +3 -3
  80. package/src/resources/qbd/preferences.ts +2 -2
  81. package/src/resources/qbd/price-levels.ts +2 -2
  82. package/src/resources/qbd/purchase-orders.ts +3 -3
  83. package/src/resources/qbd/qbd.ts +116 -95
  84. package/src/resources/qbd/receive-payments.ts +3 -3
  85. package/src/resources/qbd/sales-orders.ts +3 -3
  86. package/src/resources/qbd/sales-receipts.ts +3 -3
  87. package/src/resources/qbd/sales-representatives.ts +2 -2
  88. package/src/resources/qbd/sales-tax-codes.ts +2 -2
  89. package/src/resources/qbd/sales-tax-items.ts +3 -3
  90. package/src/resources/qbd/service-items.ts +3 -3
  91. package/src/resources/qbd/standard-terms.ts +2 -2
  92. package/src/resources/qbd/subtotal-items.ts +3 -3
  93. package/src/resources/qbd/time-tracking-activities.ts +3 -3
  94. package/src/resources/qbd/transactions.ts +3 -3
  95. package/src/resources/qbd/transfers.ts +3 -3
  96. package/src/resources/qbd/vendor-credits.ts +3 -3
  97. package/src/resources/qbd/vendors.ts +3 -3
  98. package/src/resources/qbd.ts +1 -1
  99. package/src/resources.ts +1 -1
  100. package/src/shims/node.ts +3 -3
  101. package/src/shims/web.ts +3 -3
  102. package/src/uploads.ts +4 -4
  103. package/src/version.ts +1 -1
  104. package/version.d.ts +1 -1
  105. package/version.js +1 -1
  106. package/version.mjs +1 -1
@@ -0,0 +1,690 @@
1
+ import { APIResource } from "../../resource.js";
2
+ import * as Core from "../../core.js";
3
+ export declare class OtherNames extends APIResource {
4
+ /**
5
+ * Creates a new other-name.
6
+ *
7
+ * @example
8
+ * ```ts
9
+ * const otherName = await client.qbd.otherNames.create({
10
+ * name: 'John Doe',
11
+ * conductorEndUserId: 'end_usr_1234567abcdefg',
12
+ * });
13
+ * ```
14
+ */
15
+ create(params: OtherNameCreateParams, options?: Core.RequestOptions): Core.APIPromise<OtherName>;
16
+ /**
17
+ * Retrieves an other-name by ID.
18
+ *
19
+ * @example
20
+ * ```ts
21
+ * const otherName = await client.qbd.otherNames.retrieve(
22
+ * '80000001-1234567890',
23
+ * { conductorEndUserId: 'end_usr_1234567abcdefg' },
24
+ * );
25
+ * ```
26
+ */
27
+ retrieve(id: string, params: OtherNameRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<OtherName>;
28
+ /**
29
+ * Updates an existing other-name.
30
+ *
31
+ * @example
32
+ * ```ts
33
+ * const otherName = await client.qbd.otherNames.update(
34
+ * '80000001-1234567890',
35
+ * {
36
+ * revisionNumber: '1721172183',
37
+ * conductorEndUserId: 'end_usr_1234567abcdefg',
38
+ * },
39
+ * );
40
+ * ```
41
+ */
42
+ update(id: string, params: OtherNameUpdateParams, options?: Core.RequestOptions): Core.APIPromise<OtherName>;
43
+ /**
44
+ * Returns a list of other-names. NOTE: QuickBooks Desktop does not support
45
+ * pagination for other-names; hence, there is no `cursor` parameter. Users
46
+ * typically have few other-names.
47
+ *
48
+ * @example
49
+ * ```ts
50
+ * const otherNames = await client.qbd.otherNames.list({
51
+ * conductorEndUserId: 'end_usr_1234567abcdefg',
52
+ * });
53
+ * ```
54
+ */
55
+ list(params: OtherNameListParams, options?: Core.RequestOptions): Core.APIPromise<OtherNameListResponse>;
56
+ }
57
+ export interface OtherName {
58
+ /**
59
+ * The unique identifier assigned by QuickBooks to this other-name. This ID is
60
+ * unique across all other-names but not across different QuickBooks object types.
61
+ */
62
+ id: string;
63
+ /**
64
+ * The other-name's account number, which appears in the QuickBooks chart of
65
+ * accounts, reports, and graphs.
66
+ *
67
+ * Note that if the "Use Account Numbers" preference is turned off in QuickBooks,
68
+ * the account number may not be visible in the user interface, but it can still be
69
+ * set and retrieved through the API.
70
+ */
71
+ accountNumber: string | null;
72
+ /**
73
+ * The other-name's address.
74
+ */
75
+ address: OtherName.Address | null;
76
+ /**
77
+ * The name of a alternate contact person for this other-name.
78
+ */
79
+ alternateContact: string | null;
80
+ /**
81
+ * The other-name's alternate telephone number.
82
+ */
83
+ alternatePhone: string | null;
84
+ /**
85
+ * The name of the company associated with this other-name. This name is used on
86
+ * invoices, checks, and other forms.
87
+ */
88
+ companyName: string | null;
89
+ /**
90
+ * The name of the primary contact person for this other-name.
91
+ */
92
+ contact: string | null;
93
+ /**
94
+ * The date and time when this other-name was created, in ISO 8601 format
95
+ * (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone
96
+ * in QuickBooks.
97
+ */
98
+ createdAt: string;
99
+ /**
100
+ * The custom fields for the other-name object, added as user-defined data
101
+ * extensions, not included in the standard QuickBooks object.
102
+ */
103
+ customFields: Array<OtherName.CustomField>;
104
+ /**
105
+ * The other-name's email address.
106
+ */
107
+ email: string | null;
108
+ /**
109
+ * A globally unique identifier (GUID) you, the developer, can provide for tracking
110
+ * this object in your external system. This field is immutable and can only be set
111
+ * during object creation.
112
+ */
113
+ externalId: string | null;
114
+ /**
115
+ * The other-name's fax number.
116
+ */
117
+ fax: string | null;
118
+ /**
119
+ * The first name of the contact person for this other-name.
120
+ */
121
+ firstName: string | null;
122
+ /**
123
+ * Indicates whether this other-name is active. Inactive objects are typically
124
+ * hidden from views and reports in QuickBooks. Defaults to `true`.
125
+ */
126
+ isActive: boolean;
127
+ /**
128
+ * The last name of the contact person for this other-name.
129
+ */
130
+ lastName: string | null;
131
+ /**
132
+ * The middle name of the contact person for this other-name.
133
+ */
134
+ middleName: string | null;
135
+ /**
136
+ * The case-insensitive unique name of this other-name, unique across all
137
+ * other-names.
138
+ *
139
+ * **NOTE**: Other-names do not have a `fullName` field because they are not
140
+ * hierarchical objects, which is why `name` is unique for them but not for objects
141
+ * that have parents.
142
+ */
143
+ name: string;
144
+ /**
145
+ * A note or comment about this other-name.
146
+ */
147
+ note: string | null;
148
+ /**
149
+ * The type of object. This value is always `"qbd_other_name"`.
150
+ */
151
+ objectType: 'qbd_other_name';
152
+ /**
153
+ * The other-name's primary telephone number.
154
+ */
155
+ phone: string | null;
156
+ /**
157
+ * The current QuickBooks-assigned revision number of this other-name object, which
158
+ * changes each time the object is modified. When updating this object, you must
159
+ * provide the most recent `revisionNumber` to ensure you're working with the
160
+ * latest data; otherwise, the update will return an error.
161
+ */
162
+ revisionNumber: string;
163
+ /**
164
+ * The formal salutation title that precedes the name of the contact person for
165
+ * this other-name, such as "Mr.", "Ms.", or "Dr.".
166
+ */
167
+ salutation: string | null;
168
+ /**
169
+ * The date and time when this other-name was last updated, in ISO 8601 format
170
+ * (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone
171
+ * in QuickBooks.
172
+ */
173
+ updatedAt: string;
174
+ }
175
+ export declare namespace OtherName {
176
+ /**
177
+ * The other-name's address.
178
+ */
179
+ interface Address {
180
+ /**
181
+ * The city, district, suburb, town, or village name of the address.
182
+ */
183
+ city: string | null;
184
+ /**
185
+ * The country name of the address.
186
+ */
187
+ country: string | null;
188
+ /**
189
+ * The first line of the address (e.g., street, PO Box, or company name).
190
+ */
191
+ line1: string | null;
192
+ /**
193
+ * The second line of the address, if needed (e.g., apartment, suite, unit, or
194
+ * building).
195
+ */
196
+ line2: string | null;
197
+ /**
198
+ * The third line of the address, if needed.
199
+ */
200
+ line3: string | null;
201
+ /**
202
+ * The fourth line of the address, if needed.
203
+ */
204
+ line4: string | null;
205
+ /**
206
+ * The fifth line of the address, if needed.
207
+ */
208
+ line5: string | null;
209
+ /**
210
+ * A note written at the bottom of the address in the form in which it appears,
211
+ * such as the invoice form.
212
+ */
213
+ note: string | null;
214
+ /**
215
+ * The postal code or ZIP code of the address.
216
+ */
217
+ postalCode: string | null;
218
+ /**
219
+ * The state, county, province, or region name of the address.
220
+ */
221
+ state: string | null;
222
+ }
223
+ interface CustomField {
224
+ /**
225
+ * The name of the custom field, unique for the specified `ownerId`. For public
226
+ * custom fields, this name is visible as a label in the QuickBooks UI.
227
+ */
228
+ name: string;
229
+ /**
230
+ * The identifier of the owner of the custom field, which QuickBooks internally
231
+ * calls a "data extension". For public custom fields visible in the UI, such as
232
+ * those added by the QuickBooks user, this is always "0". For private custom
233
+ * fields that are only visible to the application that created them, this is a
234
+ * valid GUID identifying the owning application. Internally, Conductor always
235
+ * fetches all public custom fields (those with an `ownerId` of "0") for all
236
+ * objects.
237
+ */
238
+ ownerId: string;
239
+ /**
240
+ * The data type of this custom field.
241
+ */
242
+ type: 'amount_type' | 'date_time_type' | 'integer_type' | 'percent_type' | 'price_type' | 'quantity_type' | 'string_1024_type' | 'string_255_type';
243
+ /**
244
+ * The value of this custom field. The maximum length depends on the field's data
245
+ * type.
246
+ */
247
+ value: string;
248
+ }
249
+ }
250
+ export interface OtherNameListResponse {
251
+ /**
252
+ * The array of other-names.
253
+ */
254
+ data: Array<OtherName>;
255
+ /**
256
+ * The type of object. This value is always `"list"`.
257
+ */
258
+ objectType: 'list';
259
+ /**
260
+ * The endpoint URL where this list can be accessed.
261
+ */
262
+ url: string;
263
+ }
264
+ export interface OtherNameCreateParams {
265
+ /**
266
+ * Body param: The case-insensitive unique name of this other-name, unique across
267
+ * all other-names.
268
+ *
269
+ * **NOTE**: Other-names do not have a `fullName` field because they are not
270
+ * hierarchical objects, which is why `name` is unique for them but not for objects
271
+ * that have parents.
272
+ *
273
+ * Maximum length: 31 characters.
274
+ */
275
+ name: string;
276
+ /**
277
+ * Header param: The ID of the EndUser to receive this request (e.g.,
278
+ * `"Conductor-End-User-Id: {{END_USER_ID}}"`).
279
+ */
280
+ conductorEndUserId: string;
281
+ /**
282
+ * Body param: The other-name's account number, which appears in the QuickBooks
283
+ * chart of accounts, reports, and graphs.
284
+ *
285
+ * Note that if the "Use Account Numbers" preference is turned off in QuickBooks,
286
+ * the account number may not be visible in the user interface, but it can still be
287
+ * set and retrieved through the API.
288
+ */
289
+ accountNumber?: string;
290
+ /**
291
+ * Body param: The other-name's address.
292
+ */
293
+ address?: OtherNameCreateParams.Address;
294
+ /**
295
+ * Body param: The name of a alternate contact person for this other-name.
296
+ */
297
+ alternateContact?: string;
298
+ /**
299
+ * Body param: The other-name's alternate telephone number.
300
+ */
301
+ alternatePhone?: string;
302
+ /**
303
+ * Body param: The name of the company associated with this other-name. This name
304
+ * is used on invoices, checks, and other forms.
305
+ */
306
+ companyName?: string;
307
+ /**
308
+ * Body param: The name of the primary contact person for this other-name.
309
+ */
310
+ contact?: string;
311
+ /**
312
+ * Body param: The other-name's email address.
313
+ */
314
+ email?: string;
315
+ /**
316
+ * Body param: A globally unique identifier (GUID) you, the developer, can provide
317
+ * for tracking this object in your external system. This field is immutable and
318
+ * can only be set during object creation.
319
+ *
320
+ * **IMPORTANT**: This field must be formatted as a valid GUID; otherwise,
321
+ * QuickBooks will return an error.
322
+ */
323
+ externalId?: string;
324
+ /**
325
+ * Body param: The other-name's fax number.
326
+ */
327
+ fax?: string;
328
+ /**
329
+ * Body param: The first name of the contact person for this other-name.
330
+ *
331
+ * Maximum length: 25 characters.
332
+ */
333
+ firstName?: string;
334
+ /**
335
+ * Body param: Indicates whether this other-name is active. Inactive objects are
336
+ * typically hidden from views and reports in QuickBooks. Defaults to `true`.
337
+ */
338
+ isActive?: boolean;
339
+ /**
340
+ * Body param: The last name of the contact person for this other-name.
341
+ *
342
+ * Maximum length: 25 characters.
343
+ */
344
+ lastName?: string;
345
+ /**
346
+ * Body param: The middle name of the contact person for this other-name.
347
+ *
348
+ * Maximum length: 5 characters.
349
+ */
350
+ middleName?: string;
351
+ /**
352
+ * Body param: A note or comment about this other-name.
353
+ */
354
+ note?: string;
355
+ /**
356
+ * Body param: The other-name's primary telephone number.
357
+ */
358
+ phone?: string;
359
+ /**
360
+ * Body param: The formal salutation title that precedes the name of the contact
361
+ * person for this other-name, such as "Mr.", "Ms.", or "Dr.".
362
+ */
363
+ salutation?: string;
364
+ }
365
+ export declare namespace OtherNameCreateParams {
366
+ /**
367
+ * The other-name's address.
368
+ */
369
+ interface Address {
370
+ /**
371
+ * The city, district, suburb, town, or village name of the address.
372
+ *
373
+ * Maximum length: 31 characters.
374
+ */
375
+ city?: string;
376
+ /**
377
+ * The country name of the address.
378
+ */
379
+ country?: string;
380
+ /**
381
+ * The first line of the address (e.g., street, PO Box, or company name).
382
+ *
383
+ * Maximum length: 41 characters.
384
+ */
385
+ line1?: string;
386
+ /**
387
+ * The second line of the address, if needed (e.g., apartment, suite, unit, or
388
+ * building).
389
+ *
390
+ * Maximum length: 41 characters.
391
+ */
392
+ line2?: string;
393
+ /**
394
+ * The third line of the address, if needed.
395
+ *
396
+ * Maximum length: 41 characters.
397
+ */
398
+ line3?: string;
399
+ /**
400
+ * The fourth line of the address, if needed.
401
+ *
402
+ * Maximum length: 41 characters.
403
+ */
404
+ line4?: string;
405
+ /**
406
+ * The fifth line of the address, if needed.
407
+ *
408
+ * Maximum length: 41 characters.
409
+ */
410
+ line5?: string;
411
+ /**
412
+ * A note written at the bottom of the address in the form in which it appears,
413
+ * such as the invoice form.
414
+ */
415
+ note?: string;
416
+ /**
417
+ * The postal code or ZIP code of the address.
418
+ *
419
+ * Maximum length: 13 characters.
420
+ */
421
+ postalCode?: string;
422
+ /**
423
+ * The state, county, province, or region name of the address.
424
+ *
425
+ * Maximum length: 21 characters.
426
+ */
427
+ state?: string;
428
+ }
429
+ }
430
+ export interface OtherNameRetrieveParams {
431
+ /**
432
+ * The ID of the EndUser to receive this request (e.g.,
433
+ * `"Conductor-End-User-Id: {{END_USER_ID}}"`).
434
+ */
435
+ conductorEndUserId: string;
436
+ }
437
+ export interface OtherNameUpdateParams {
438
+ /**
439
+ * Body param: The current QuickBooks-assigned revision number of the other-name
440
+ * object you are updating, which you can get by fetching the object first. Provide
441
+ * the most recent `revisionNumber` to ensure you're working with the latest data;
442
+ * otherwise, the update will return an error.
443
+ */
444
+ revisionNumber: string;
445
+ /**
446
+ * Header param: The ID of the EndUser to receive this request (e.g.,
447
+ * `"Conductor-End-User-Id: {{END_USER_ID}}"`).
448
+ */
449
+ conductorEndUserId: string;
450
+ /**
451
+ * Body param: The other-name's account number, which appears in the QuickBooks
452
+ * chart of accounts, reports, and graphs.
453
+ *
454
+ * Note that if the "Use Account Numbers" preference is turned off in QuickBooks,
455
+ * the account number may not be visible in the user interface, but it can still be
456
+ * set and retrieved through the API.
457
+ */
458
+ accountNumber?: string;
459
+ /**
460
+ * Body param: The other-name's address.
461
+ */
462
+ address?: OtherNameUpdateParams.Address;
463
+ /**
464
+ * Body param: The name of a alternate contact person for this other-name.
465
+ */
466
+ alternateContact?: string;
467
+ /**
468
+ * Body param: The other-name's alternate telephone number.
469
+ */
470
+ alternatePhone?: string;
471
+ /**
472
+ * Body param: The name of the company associated with this other-name. This name
473
+ * is used on invoices, checks, and other forms.
474
+ */
475
+ companyName?: string;
476
+ /**
477
+ * Body param: The name of the primary contact person for this other-name.
478
+ */
479
+ contact?: string;
480
+ /**
481
+ * Body param: The other-name's email address.
482
+ */
483
+ email?: string;
484
+ /**
485
+ * Body param: The other-name's fax number.
486
+ */
487
+ fax?: string;
488
+ /**
489
+ * Body param: The first name of the contact person for this other-name.
490
+ *
491
+ * Maximum length: 25 characters.
492
+ */
493
+ firstName?: string;
494
+ /**
495
+ * Body param: Indicates whether this other-name is active. Inactive objects are
496
+ * typically hidden from views and reports in QuickBooks. Defaults to `true`.
497
+ */
498
+ isActive?: boolean;
499
+ /**
500
+ * Body param: The last name of the contact person for this other-name.
501
+ *
502
+ * Maximum length: 25 characters.
503
+ */
504
+ lastName?: string;
505
+ /**
506
+ * Body param: The middle name of the contact person for this other-name.
507
+ *
508
+ * Maximum length: 5 characters.
509
+ */
510
+ middleName?: string;
511
+ /**
512
+ * Body param: The case-insensitive unique name of this other-name, unique across
513
+ * all other-names.
514
+ *
515
+ * **NOTE**: Other-names do not have a `fullName` field because they are not
516
+ * hierarchical objects, which is why `name` is unique for them but not for objects
517
+ * that have parents.
518
+ *
519
+ * Maximum length: 31 characters.
520
+ */
521
+ name?: string;
522
+ /**
523
+ * Body param: A note or comment about this other-name.
524
+ */
525
+ note?: string;
526
+ /**
527
+ * Body param: The other-name's primary telephone number.
528
+ */
529
+ phone?: string;
530
+ /**
531
+ * Body param: The formal salutation title that precedes the name of the contact
532
+ * person for this other-name, such as "Mr.", "Ms.", or "Dr.".
533
+ */
534
+ salutation?: string;
535
+ }
536
+ export declare namespace OtherNameUpdateParams {
537
+ /**
538
+ * The other-name's address.
539
+ */
540
+ interface Address {
541
+ /**
542
+ * The city, district, suburb, town, or village name of the address.
543
+ *
544
+ * Maximum length: 31 characters.
545
+ */
546
+ city?: string;
547
+ /**
548
+ * The country name of the address.
549
+ */
550
+ country?: string;
551
+ /**
552
+ * The first line of the address (e.g., street, PO Box, or company name).
553
+ *
554
+ * Maximum length: 41 characters.
555
+ */
556
+ line1?: string;
557
+ /**
558
+ * The second line of the address, if needed (e.g., apartment, suite, unit, or
559
+ * building).
560
+ *
561
+ * Maximum length: 41 characters.
562
+ */
563
+ line2?: string;
564
+ /**
565
+ * The third line of the address, if needed.
566
+ *
567
+ * Maximum length: 41 characters.
568
+ */
569
+ line3?: string;
570
+ /**
571
+ * The fourth line of the address, if needed.
572
+ *
573
+ * Maximum length: 41 characters.
574
+ */
575
+ line4?: string;
576
+ /**
577
+ * The fifth line of the address, if needed.
578
+ *
579
+ * Maximum length: 41 characters.
580
+ */
581
+ line5?: string;
582
+ /**
583
+ * A note written at the bottom of the address in the form in which it appears,
584
+ * such as the invoice form.
585
+ */
586
+ note?: string;
587
+ /**
588
+ * The postal code or ZIP code of the address.
589
+ *
590
+ * Maximum length: 13 characters.
591
+ */
592
+ postalCode?: string;
593
+ /**
594
+ * The state, county, province, or region name of the address.
595
+ *
596
+ * Maximum length: 21 characters.
597
+ */
598
+ state?: string;
599
+ }
600
+ }
601
+ export interface OtherNameListParams {
602
+ /**
603
+ * Header param: The ID of the EndUser to receive this request (e.g.,
604
+ * `"Conductor-End-User-Id: {{END_USER_ID}}"`).
605
+ */
606
+ conductorEndUserId: string;
607
+ /**
608
+ * Query param: Filter for specific other-names by their QuickBooks-assigned unique
609
+ * identifier(s).
610
+ *
611
+ * **IMPORTANT**: If you include this parameter, QuickBooks will ignore all other
612
+ * query parameters for this request.
613
+ *
614
+ * **NOTE**: If any of the values you specify in this parameter are not found, the
615
+ * request will return an error.
616
+ */
617
+ ids?: Array<string>;
618
+ /**
619
+ * Query param: The maximum number of objects to return.
620
+ *
621
+ * **IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for
622
+ * other-names. This parameter will limit the response size, but you cannot fetch
623
+ * subsequent results using a cursor. For pagination, use the name-range parameters
624
+ * instead (e.g., `nameFrom=A&nameTo=B`).
625
+ *
626
+ * When this parameter is omitted, the endpoint returns all other-names without
627
+ * limit, unlike paginated endpoints which default to 150 records. This is
628
+ * acceptable because other-names typically have low record counts.
629
+ */
630
+ limit?: number;
631
+ /**
632
+ * Query param: Filter for other-names whose `name` contains this substring,
633
+ * case-insensitive. NOTE: If you use this parameter, you cannot also use
634
+ * `nameStartsWith` or `nameEndsWith`.
635
+ */
636
+ nameContains?: string;
637
+ /**
638
+ * Query param: Filter for other-names whose `name` ends with this substring,
639
+ * case-insensitive. NOTE: If you use this parameter, you cannot also use
640
+ * `nameContains` or `nameStartsWith`.
641
+ */
642
+ nameEndsWith?: string;
643
+ /**
644
+ * Query param: Filter for other-names whose `name` is alphabetically greater than
645
+ * or equal to this value.
646
+ */
647
+ nameFrom?: string;
648
+ /**
649
+ * Query param: Filter for specific other-names by their name(s), case-insensitive.
650
+ * Like `id`, `name` is a unique identifier for an other-name.
651
+ *
652
+ * **IMPORTANT**: If you include this parameter, QuickBooks will ignore all other
653
+ * query parameters for this request.
654
+ *
655
+ * **NOTE**: If any of the values you specify in this parameter are not found, the
656
+ * request will return an error.
657
+ */
658
+ names?: Array<string>;
659
+ /**
660
+ * Query param: Filter for other-names whose `name` starts with this substring,
661
+ * case-insensitive. NOTE: If you use this parameter, you cannot also use
662
+ * `nameContains` or `nameEndsWith`.
663
+ */
664
+ nameStartsWith?: string;
665
+ /**
666
+ * Query param: Filter for other-names whose `name` is alphabetically less than or
667
+ * equal to this value.
668
+ */
669
+ nameTo?: string;
670
+ /**
671
+ * Query param: Filter for other-names that are active, inactive, or both.
672
+ */
673
+ status?: 'active' | 'all' | 'inactive';
674
+ /**
675
+ * Query param: Filter for other-names updated on or after this date and time, in
676
+ * ISO 8601 format (YYYY-MM-DDTHH:mm:ss). If you only provide a date (YYYY-MM-DD),
677
+ * the time is assumed to be 00:00:00 of that day.
678
+ */
679
+ updatedAfter?: string;
680
+ /**
681
+ * Query param: Filter for other-names updated on or before this date and time, in
682
+ * ISO 8601 format (YYYY-MM-DDTHH:mm:ss). If you only provide a date (YYYY-MM-DD),
683
+ * the time is assumed to be 23:59:59 of that day.
684
+ */
685
+ updatedBefore?: string;
686
+ }
687
+ export declare namespace OtherNames {
688
+ export { type OtherName as OtherName, type OtherNameListResponse as OtherNameListResponse, type OtherNameCreateParams as OtherNameCreateParams, type OtherNameRetrieveParams as OtherNameRetrieveParams, type OtherNameUpdateParams as OtherNameUpdateParams, type OtherNameListParams as OtherNameListParams, };
689
+ }
690
+ //# sourceMappingURL=other-names.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"other-names.d.ts","sourceRoot":"","sources":["../../src/resources/qbd/other-names.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AAEnC,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,MAAM,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC;IAShG;;;;;;;;;;OAUG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC;IAQ7B;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC;IAS7B;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,MAAM,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,qBAAqB,CAAC;CAQzG;AAED,MAAM,WAAW,SAAS;IACxB;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;;;;OAOG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,OAAO,EAAE,SAAS,CAAC,OAAO,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,YAAY,EAAE,KAAK,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;IAE3C;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;;OAIG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;;;;;OAOG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,gBAAgB,CAAC;IAE7B;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;;;OAKG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,yBAAiB,SAAS,CAAC;IACzB;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;WAEG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;;WAGG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;;WAGG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;KACtB;IAED,UAAiB,WAAW;QAC1B;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;;;;;;;WAQG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,IAAI,EACA,aAAa,GACb,gBAAgB,GAChB,cAAc,GACd,cAAc,GACd,YAAY,GACZ,eAAe,GACf,kBAAkB,GAClB,iBAAiB,CAAC;QAEtB;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IAEvB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,qBAAqB;IACpC;;;;;;;;;OASG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;;;;;;OAOG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,qBAAqB,CAAC,OAAO,CAAC;IAExC;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,OAAO;QACtB;;;;WAIG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;;;WAIG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;;;;WAKG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;;;WAIG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;;;WAIG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;;;WAIG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;;WAIG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;;;WAIG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,kBAAkB,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,qBAAqB;IACpC;;;;;OAKG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;;;;;;OAOG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,qBAAqB,CAAC,OAAO,CAAC;IAExC;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;;;;;OASG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,OAAO;QACtB;;;;WAIG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;;;WAIG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;;;;WAKG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;;;WAIG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;;;WAIG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;;;WAIG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;;WAIG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;;;WAIG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;;;;;;;;OASG;IACH,GAAG,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEpB;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;;;;;OASG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,KAAK,GAAG,UAAU,CAAC;IAEvC;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}