conductor-node 12.13.0 → 12.14.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.
Files changed (49) hide show
  1. package/CHANGELOG.md +20 -0
  2. package/core.js +1 -1
  3. package/core.js.map +1 -1
  4. package/core.mjs +1 -1
  5. package/core.mjs.map +1 -1
  6. package/index.d.mts +2 -0
  7. package/index.d.ts +2 -0
  8. package/index.d.ts.map +1 -1
  9. package/index.js.map +1 -1
  10. package/index.mjs.map +1 -1
  11. package/package.json +1 -1
  12. package/resources/qbd/build-assemblies.d.ts +674 -0
  13. package/resources/qbd/build-assemblies.d.ts.map +1 -0
  14. package/resources/qbd/build-assemblies.js +120 -0
  15. package/resources/qbd/build-assemblies.js.map +1 -0
  16. package/resources/qbd/build-assemblies.mjs +115 -0
  17. package/resources/qbd/build-assemblies.mjs.map +1 -0
  18. package/resources/qbd/index.d.ts +1 -0
  19. package/resources/qbd/index.d.ts.map +1 -1
  20. package/resources/qbd/index.js +5 -2
  21. package/resources/qbd/index.js.map +1 -1
  22. package/resources/qbd/index.mjs +1 -0
  23. package/resources/qbd/index.mjs.map +1 -1
  24. package/resources/qbd/inventory-adjustments.d.ts +5 -5
  25. package/resources/qbd/inventory-adjustments.d.ts.map +1 -1
  26. package/resources/qbd/item-sites.d.ts +1 -4
  27. package/resources/qbd/item-sites.d.ts.map +1 -1
  28. package/resources/qbd/item-sites.js.map +1 -1
  29. package/resources/qbd/item-sites.mjs.map +1 -1
  30. package/resources/qbd/price-levels.d.ts +15 -15
  31. package/resources/qbd/price-levels.d.ts.map +1 -1
  32. package/resources/qbd/qbd.d.ts +4 -0
  33. package/resources/qbd/qbd.d.ts.map +1 -1
  34. package/resources/qbd/qbd.js +5 -0
  35. package/resources/qbd/qbd.js.map +1 -1
  36. package/resources/qbd/qbd.mjs +5 -0
  37. package/resources/qbd/qbd.mjs.map +1 -1
  38. package/src/core.ts +1 -1
  39. package/src/index.ts +2 -0
  40. package/src/resources/qbd/build-assemblies.ts +842 -0
  41. package/src/resources/qbd/index.ts +11 -0
  42. package/src/resources/qbd/inventory-adjustments.ts +6 -6
  43. package/src/resources/qbd/item-sites.ts +1 -4
  44. package/src/resources/qbd/price-levels.ts +17 -17
  45. package/src/resources/qbd/qbd.ts +27 -0
  46. package/src/version.ts +1 -1
  47. package/version.d.ts +1 -1
  48. package/version.js +1 -1
  49. package/version.mjs +1 -1
@@ -0,0 +1,674 @@
1
+ import { APIResource } from "../../resource.js";
2
+ import * as Core from "../../core.js";
3
+ import { CursorPage, type CursorPageParams } from "../../pagination.js";
4
+ export declare class BuildAssemblies extends APIResource {
5
+ /**
6
+ * Creates a new build assembly.
7
+ *
8
+ * @example
9
+ * ```ts
10
+ * const buildAssembly =
11
+ * await conductor.qbd.buildAssemblies.create({
12
+ * inventoryAssemblyItemId: '80000001-1234567890',
13
+ * quantityToBuild: 7,
14
+ * transactionDate: '2021-10-01',
15
+ * conductorEndUserId: 'end_usr_1234567abcdefg',
16
+ * });
17
+ * ```
18
+ */
19
+ create(params: BuildAssemblyCreateParams, options?: Core.RequestOptions): Core.APIPromise<BuildAssembly>;
20
+ /**
21
+ * Retrieves a build assembly by ID.
22
+ *
23
+ * @example
24
+ * ```ts
25
+ * const buildAssembly =
26
+ * await conductor.qbd.buildAssemblies.retrieve(
27
+ * '123ABC-1234567890',
28
+ * { conductorEndUserId: 'end_usr_1234567abcdefg' },
29
+ * );
30
+ * ```
31
+ */
32
+ retrieve(id: string, params: BuildAssemblyRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<BuildAssembly>;
33
+ /**
34
+ * Updates an existing build assembly.
35
+ *
36
+ * @example
37
+ * ```ts
38
+ * const buildAssembly =
39
+ * await conductor.qbd.buildAssemblies.update(
40
+ * '123ABC-1234567890',
41
+ * {
42
+ * revisionNumber: '1721172183',
43
+ * conductorEndUserId: 'end_usr_1234567abcdefg',
44
+ * },
45
+ * );
46
+ * ```
47
+ */
48
+ update(id: string, params: BuildAssemblyUpdateParams, options?: Core.RequestOptions): Core.APIPromise<BuildAssembly>;
49
+ /**
50
+ * Returns a list of build assemblies. Use the `cursor` parameter to paginate
51
+ * through the results.
52
+ *
53
+ * @example
54
+ * ```ts
55
+ * // Automatically fetches more pages as needed.
56
+ * for await (const buildAssembly of conductor.qbd.buildAssemblies.list(
57
+ * { conductorEndUserId: 'end_usr_1234567abcdefg' },
58
+ * )) {
59
+ * // ...
60
+ * }
61
+ * ```
62
+ */
63
+ list(params: BuildAssemblyListParams, options?: Core.RequestOptions): Core.PagePromise<BuildAssembliesCursorPage, BuildAssembly>;
64
+ /**
65
+ * Permanently deletes a a build assembly. The deletion will fail if the build
66
+ * assembly is currently in use or has any linked transactions that are in use.
67
+ *
68
+ * @example
69
+ * ```ts
70
+ * const buildAssembly =
71
+ * await conductor.qbd.buildAssemblies.delete(
72
+ * '123ABC-1234567890',
73
+ * { conductorEndUserId: 'end_usr_1234567abcdefg' },
74
+ * );
75
+ * ```
76
+ */
77
+ delete(id: string, params: BuildAssemblyDeleteParams, options?: Core.RequestOptions): Core.APIPromise<BuildAssemblyDeleteResponse>;
78
+ }
79
+ export declare class BuildAssembliesCursorPage extends CursorPage<BuildAssembly> {
80
+ }
81
+ export interface BuildAssembly {
82
+ /**
83
+ * The unique identifier assigned by QuickBooks to this build assembly. This ID is
84
+ * unique across all transaction types.
85
+ */
86
+ id: string;
87
+ /**
88
+ * The date and time when this build assembly was created, in ISO 8601 format
89
+ * (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone
90
+ * in QuickBooks.
91
+ */
92
+ createdAt: string;
93
+ /**
94
+ * The custom fields for the build assembly object, added as user-defined data
95
+ * extensions, not included in the standard QuickBooks object.
96
+ */
97
+ customFields: Array<BuildAssembly.CustomField>;
98
+ /**
99
+ * The expiration date for the serial number or lot number of the item associated
100
+ * with this build assembly, in ISO 8601 format (YYYY-MM-DD). This is particularly
101
+ * relevant for perishable or time-sensitive inventory items. Note that this field
102
+ * is only supported on QuickBooks Desktop 2023 or later.
103
+ */
104
+ expirationDate: string | null;
105
+ /**
106
+ * A globally unique identifier (GUID) you, the developer, can provide for tracking
107
+ * this object in your external system. This field is immutable and can only be set
108
+ * during object creation.
109
+ */
110
+ externalId: string | null;
111
+ /**
112
+ * The inventory assembly item associated with this build assembly. An inventory
113
+ * assembly item is assembled or manufactured from other inventory items, and the
114
+ * items and/or assemblies that make up the assembly are called components.
115
+ */
116
+ inventoryAssemblyItem: BuildAssembly.InventoryAssemblyItem;
117
+ /**
118
+ * The site location where inventory for the item associated with this build
119
+ * assembly is stored.
120
+ */
121
+ inventorySite: BuildAssembly.InventorySite | null;
122
+ /**
123
+ * The specific location (e.g., bin or shelf) within the inventory site where the
124
+ * item associated with this build assembly is stored.
125
+ */
126
+ inventorySiteLocation: BuildAssembly.InventorySiteLocation | null;
127
+ /**
128
+ * Indicates whether this build assembly has not been completed.
129
+ */
130
+ isPending: boolean | null;
131
+ /**
132
+ * The component item lines in this build assembly.
133
+ */
134
+ lines: Array<BuildAssembly.Line>;
135
+ /**
136
+ * The lot number of the item associated with this build assembly. Used for
137
+ * tracking groups of inventory items that are purchased or manufactured together.
138
+ */
139
+ lotNumber: string | null;
140
+ /**
141
+ * A memo or note for this build assembly.
142
+ */
143
+ memo: string | null;
144
+ /**
145
+ * The type of object. This value is always `"qbd_build_assembly"`.
146
+ */
147
+ objectType: 'qbd_build_assembly';
148
+ /**
149
+ * The number of this build assembly that can be built from the parts on hand.
150
+ */
151
+ quantityCanBuild: number;
152
+ /**
153
+ * The number of units of this build assembly currently in inventory.
154
+ */
155
+ quantityOnHand: number;
156
+ /**
157
+ * The number of units of this build assembly that have been sold (as recorded in
158
+ * sales orders) but not yet fulfilled or delivered to customers.
159
+ */
160
+ quantityOnSalesOrder: number;
161
+ /**
162
+ * The number of build assembly to be built. The transaction will fail if the
163
+ * number specified here exceeds the number of on-hand components.
164
+ */
165
+ quantityToBuild: number;
166
+ /**
167
+ * The case-sensitive user-defined reference number for this build assembly, which
168
+ * can be used to identify the transaction in QuickBooks. This value is not
169
+ * required to be unique and can be arbitrarily changed by the QuickBooks user.
170
+ */
171
+ refNumber: string | null;
172
+ /**
173
+ * The current QuickBooks-assigned revision number of this build assembly object,
174
+ * which changes each time the object is modified. When updating this object, you
175
+ * must provide the most recent `revisionNumber` to ensure you're working with the
176
+ * latest data; otherwise, the update will return an error.
177
+ */
178
+ revisionNumber: string;
179
+ /**
180
+ * The serial number of the item associated with this build assembly. This is used
181
+ * for tracking individual units of serialized inventory items.
182
+ */
183
+ serialNumber: string | null;
184
+ /**
185
+ * The date of this build assembly, in ISO 8601 format (YYYY-MM-DD).
186
+ */
187
+ transactionDate: string;
188
+ /**
189
+ * The date and time when this build assembly was last updated, in ISO 8601 format
190
+ * (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone
191
+ * in QuickBooks.
192
+ */
193
+ updatedAt: string;
194
+ }
195
+ export declare namespace BuildAssembly {
196
+ interface CustomField {
197
+ /**
198
+ * The name of the custom field, unique for the specified `ownerId`. For public
199
+ * custom fields, this name is visible as a label in the QuickBooks UI.
200
+ */
201
+ name: string;
202
+ /**
203
+ * The identifier of the owner of the custom field, which QuickBooks internally
204
+ * calls a "data extension". For public custom fields visible in the UI, such as
205
+ * those added by the QuickBooks user, this is always "0". For private custom
206
+ * fields that are only visible to the application that created them, this is a
207
+ * valid GUID identifying the owning application. Internally, Conductor always
208
+ * fetches all public custom fields (those with an `ownerId` of "0") for all
209
+ * objects.
210
+ */
211
+ ownerId: string;
212
+ /**
213
+ * The data type of this custom field.
214
+ */
215
+ type: 'amount_type' | 'date_time_type' | 'integer_type' | 'percent_type' | 'price_type' | 'quantity_type' | 'string_1024_type' | 'string_255_type';
216
+ /**
217
+ * The value of this custom field. The maximum length depends on the field's data
218
+ * type.
219
+ */
220
+ value: string;
221
+ }
222
+ /**
223
+ * The inventory assembly item associated with this build assembly. An inventory
224
+ * assembly item is assembled or manufactured from other inventory items, and the
225
+ * items and/or assemblies that make up the assembly are called components.
226
+ */
227
+ interface InventoryAssemblyItem {
228
+ /**
229
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
230
+ * across all objects of the same type, but not across different QuickBooks object
231
+ * types.
232
+ */
233
+ id: string | null;
234
+ /**
235
+ * The fully-qualified unique name for this object, formed by combining the names
236
+ * of its parent objects with its own `name`, separated by colons. Not
237
+ * case-sensitive.
238
+ */
239
+ fullName: string | null;
240
+ }
241
+ /**
242
+ * The site location where inventory for the item associated with this build
243
+ * assembly is stored.
244
+ */
245
+ interface InventorySite {
246
+ /**
247
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
248
+ * across all objects of the same type, but not across different QuickBooks object
249
+ * types.
250
+ */
251
+ id: string | null;
252
+ /**
253
+ * The fully-qualified unique name for this object, formed by combining the names
254
+ * of its parent objects with its own `name`, separated by colons. Not
255
+ * case-sensitive.
256
+ */
257
+ fullName: string | null;
258
+ }
259
+ /**
260
+ * The specific location (e.g., bin or shelf) within the inventory site where the
261
+ * item associated with this build assembly is stored.
262
+ */
263
+ interface InventorySiteLocation {
264
+ /**
265
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
266
+ * across all objects of the same type, but not across different QuickBooks object
267
+ * types.
268
+ */
269
+ id: string | null;
270
+ /**
271
+ * The fully-qualified unique name for this object, formed by combining the names
272
+ * of its parent objects with its own `name`, separated by colons. Not
273
+ * case-sensitive.
274
+ */
275
+ fullName: string | null;
276
+ }
277
+ interface Line {
278
+ /**
279
+ * A description of this component item line.
280
+ */
281
+ description: string | null;
282
+ /**
283
+ * The expiration date for the serial number or lot number of the item associated
284
+ * with this component item line, in ISO 8601 format (YYYY-MM-DD). This is
285
+ * particularly relevant for perishable or time-sensitive inventory items. Note
286
+ * that this field is only supported on QuickBooks Desktop 2023 or later.
287
+ */
288
+ expirationDate: string | null;
289
+ /**
290
+ * The site location where inventory for the item associated with this component
291
+ * item line is stored.
292
+ */
293
+ inventorySite: Line.InventorySite | null;
294
+ /**
295
+ * The specific location (e.g., bin or shelf) within the inventory site where the
296
+ * item associated with this component item line is stored.
297
+ */
298
+ inventorySiteLocation: Line.InventorySiteLocation | null;
299
+ /**
300
+ * The item associated with this component item line. This can refer to any good or
301
+ * service that the business buys or sells, including item types such as a service
302
+ * item, inventory item, or special calculation item like a discount item or
303
+ * sales-tax item.
304
+ */
305
+ item: Line.Item;
306
+ /**
307
+ * The lot number of the item associated with this component item line. Used for
308
+ * tracking groups of inventory items that are purchased or manufactured together.
309
+ */
310
+ lotNumber: string | null;
311
+ /**
312
+ * The quantity of this component item line that is needed to build the assembly.
313
+ * For example, if the `itemId` references a bolt, the `quantityNeeded` field
314
+ * indicates how many of these bolts are used in the assembly.
315
+ */
316
+ quantityNeeded: number | null;
317
+ /**
318
+ * The number of units of this component item line currently in inventory.
319
+ */
320
+ quantityOnHand: number | null;
321
+ /**
322
+ * The serial number of the item associated with this component item line. This is
323
+ * used for tracking individual units of serialized inventory items.
324
+ */
325
+ serialNumber: string | null;
326
+ }
327
+ namespace Line {
328
+ /**
329
+ * The site location where inventory for the item associated with this component
330
+ * item line is stored.
331
+ */
332
+ interface InventorySite {
333
+ /**
334
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
335
+ * across all objects of the same type, but not across different QuickBooks object
336
+ * types.
337
+ */
338
+ id: string | null;
339
+ /**
340
+ * The fully-qualified unique name for this object, formed by combining the names
341
+ * of its parent objects with its own `name`, separated by colons. Not
342
+ * case-sensitive.
343
+ */
344
+ fullName: string | null;
345
+ }
346
+ /**
347
+ * The specific location (e.g., bin or shelf) within the inventory site where the
348
+ * item associated with this component item line is stored.
349
+ */
350
+ interface InventorySiteLocation {
351
+ /**
352
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
353
+ * across all objects of the same type, but not across different QuickBooks object
354
+ * types.
355
+ */
356
+ id: string | null;
357
+ /**
358
+ * The fully-qualified unique name for this object, formed by combining the names
359
+ * of its parent objects with its own `name`, separated by colons. Not
360
+ * case-sensitive.
361
+ */
362
+ fullName: string | null;
363
+ }
364
+ /**
365
+ * The item associated with this component item line. This can refer to any good or
366
+ * service that the business buys or sells, including item types such as a service
367
+ * item, inventory item, or special calculation item like a discount item or
368
+ * sales-tax item.
369
+ */
370
+ interface Item {
371
+ /**
372
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
373
+ * across all objects of the same type, but not across different QuickBooks object
374
+ * types.
375
+ */
376
+ id: string | null;
377
+ /**
378
+ * The fully-qualified unique name for this object, formed by combining the names
379
+ * of its parent objects with its own `name`, separated by colons. Not
380
+ * case-sensitive.
381
+ */
382
+ fullName: string | null;
383
+ }
384
+ }
385
+ }
386
+ export interface BuildAssemblyDeleteResponse {
387
+ /**
388
+ * The QuickBooks-assigned unique identifier of the deleted build assembly.
389
+ */
390
+ id: string;
391
+ /**
392
+ * Indicates whether the build assembly was deleted.
393
+ */
394
+ deleted: boolean;
395
+ /**
396
+ * The type of object. This value is always `"qbd_build_assembly"`.
397
+ */
398
+ objectType: 'qbd_build_assembly';
399
+ /**
400
+ * The case-sensitive user-defined reference number of the deleted build assembly.
401
+ */
402
+ refNumber: string | null;
403
+ }
404
+ export interface BuildAssemblyCreateParams {
405
+ /**
406
+ * Body param: The inventory assembly item associated with this build assembly. An
407
+ * inventory assembly item is assembled or manufactured from other inventory items,
408
+ * and the items and/or assemblies that make up the assembly are called components.
409
+ */
410
+ inventoryAssemblyItemId: string;
411
+ /**
412
+ * Body param: The number of build assembly to be built. The transaction will fail
413
+ * if the number specified here exceeds the number of on-hand components.
414
+ */
415
+ quantityToBuild: number;
416
+ /**
417
+ * Body param: The date of this build assembly, in ISO 8601 format (YYYY-MM-DD).
418
+ */
419
+ transactionDate: string;
420
+ /**
421
+ * Header param: The ID of the EndUser to receive this request (e.g.,
422
+ * `"Conductor-End-User-Id: {{END_USER_ID}}"`).
423
+ */
424
+ conductorEndUserId: string;
425
+ /**
426
+ * Body param: The expiration date for the serial number or lot number of the item
427
+ * associated with this build assembly, in ISO 8601 format (YYYY-MM-DD). This is
428
+ * particularly relevant for perishable or time-sensitive inventory items. Note
429
+ * that this field is only supported on QuickBooks Desktop 2023 or later.
430
+ */
431
+ expirationDate?: string;
432
+ /**
433
+ * Body param: A globally unique identifier (GUID) you, the developer, can provide
434
+ * for tracking this object in your external system. This field is immutable and
435
+ * can only be set during object creation.
436
+ *
437
+ * **IMPORTANT**: This field must be formatted as a valid GUID; otherwise,
438
+ * QuickBooks will return an error.
439
+ */
440
+ externalId?: string;
441
+ /**
442
+ * Body param: The site location where inventory for the item associated with this
443
+ * build assembly is stored.
444
+ */
445
+ inventorySiteId?: string;
446
+ /**
447
+ * Body param: The specific location (e.g., bin or shelf) within the inventory site
448
+ * where the item associated with this build assembly is stored.
449
+ */
450
+ inventorySiteLocationId?: string;
451
+ /**
452
+ * Body param: The lot number of the item associated with this build assembly. Used
453
+ * for tracking groups of inventory items that are purchased or manufactured
454
+ * together.
455
+ */
456
+ lotNumber?: string;
457
+ /**
458
+ * Body param: When `true`, the build assembly will be marked pending if there are
459
+ * insufficient quantities to complete the build assembly.
460
+ */
461
+ markPendingIfRequired?: boolean;
462
+ /**
463
+ * Body param: A memo or note for this build assembly.
464
+ */
465
+ memo?: string;
466
+ /**
467
+ * Body param: The case-sensitive user-defined reference number for this build
468
+ * assembly, which can be used to identify the transaction in QuickBooks. This
469
+ * value is not required to be unique and can be arbitrarily changed by the
470
+ * QuickBooks user. When left blank in this create request, this field will be left
471
+ * blank in QuickBooks (i.e., it does _not_ auto-increment).
472
+ */
473
+ refNumber?: string;
474
+ /**
475
+ * Body param: The serial number of the item associated with this build assembly.
476
+ * This is used for tracking individual units of serialized inventory items.
477
+ */
478
+ serialNumber?: string;
479
+ }
480
+ export interface BuildAssemblyRetrieveParams {
481
+ /**
482
+ * The ID of the EndUser to receive this request (e.g.,
483
+ * `"Conductor-End-User-Id: {{END_USER_ID}}"`).
484
+ */
485
+ conductorEndUserId: string;
486
+ }
487
+ export interface BuildAssemblyUpdateParams {
488
+ /**
489
+ * Body param: The current QuickBooks-assigned revision number of the build
490
+ * assembly object you are updating, which you can get by fetching the object
491
+ * first. Provide the most recent `revisionNumber` to ensure you're working with
492
+ * the latest data; otherwise, the update will return an error.
493
+ */
494
+ revisionNumber: string;
495
+ /**
496
+ * Header param: The ID of the EndUser to receive this request (e.g.,
497
+ * `"Conductor-End-User-Id: {{END_USER_ID}}"`).
498
+ */
499
+ conductorEndUserId: string;
500
+ /**
501
+ * Body param: The expiration date for the serial number or lot number of the item
502
+ * associated with this build assembly, in ISO 8601 format (YYYY-MM-DD). This is
503
+ * particularly relevant for perishable or time-sensitive inventory items. Note
504
+ * that this field is only supported on QuickBooks Desktop 2023 or later.
505
+ */
506
+ expirationDate?: string;
507
+ /**
508
+ * Body param: The site location where inventory for the item associated with this
509
+ * build assembly is stored.
510
+ */
511
+ inventorySiteId?: string;
512
+ /**
513
+ * Body param: The specific location (e.g., bin or shelf) within the inventory site
514
+ * where the item associated with this build assembly is stored.
515
+ */
516
+ inventorySiteLocationId?: string;
517
+ /**
518
+ * Body param: The lot number of the item associated with this build assembly. Used
519
+ * for tracking groups of inventory items that are purchased or manufactured
520
+ * together.
521
+ */
522
+ lotNumber?: string;
523
+ /**
524
+ * Body param: When `true`, the build assembly will be marked pending if there are
525
+ * insufficient quantities to complete the build assembly.
526
+ */
527
+ markPendingIfRequired?: boolean;
528
+ /**
529
+ * Body param: A memo or note for this build assembly.
530
+ */
531
+ memo?: string;
532
+ /**
533
+ * Body param: The number of build assembly to be built. The transaction will fail
534
+ * if the number specified here exceeds the number of on-hand components.
535
+ */
536
+ quantityToBuild?: number;
537
+ /**
538
+ * Body param: The case-sensitive user-defined reference number for this build
539
+ * assembly, which can be used to identify the transaction in QuickBooks. This
540
+ * value is not required to be unique and can be arbitrarily changed by the
541
+ * QuickBooks user.
542
+ */
543
+ refNumber?: string;
544
+ /**
545
+ * Body param: When `true`, changes this build assembly's status from pending to
546
+ * non-pending, which effectively performs the build transaction. The operation
547
+ * will fail if there are insufficient component quantities on hand to complete the
548
+ * build.
549
+ */
550
+ removePending?: boolean;
551
+ /**
552
+ * Body param: The serial number of the item associated with this build assembly.
553
+ * This is used for tracking individual units of serialized inventory items.
554
+ */
555
+ serialNumber?: string;
556
+ /**
557
+ * Body param: The date of this build assembly, in ISO 8601 format (YYYY-MM-DD).
558
+ */
559
+ transactionDate?: string;
560
+ }
561
+ export interface BuildAssemblyListParams extends CursorPageParams {
562
+ /**
563
+ * Header param: The ID of the EndUser to receive this request (e.g.,
564
+ * `"Conductor-End-User-Id: {{END_USER_ID}}"`).
565
+ */
566
+ conductorEndUserId: string;
567
+ /**
568
+ * Query param: Filter for specific build assemblies by their QuickBooks-assigned
569
+ * unique identifier(s).
570
+ *
571
+ * **IMPORTANT**: If you include this parameter, QuickBooks will ignore all other
572
+ * query parameters for this request.
573
+ *
574
+ * **NOTE**: If any of the values you specify in this parameter are not found, the
575
+ * request will return an error.
576
+ */
577
+ ids?: Array<string>;
578
+ /**
579
+ * Query param: Whether to include component line items in the response. Defaults
580
+ * to `true`.
581
+ */
582
+ includeComponentLineItems?: boolean;
583
+ /**
584
+ * Query param: Filter for build assemblies containing these items.
585
+ */
586
+ itemIds?: Array<string>;
587
+ /**
588
+ * Query param: Filter for build assemblies that are pending, not pending, or both.
589
+ */
590
+ pendingStatus?: 'all' | 'not_pending' | 'pending';
591
+ /**
592
+ * Query param: Filter for build assemblies whose `refNumber` contains this
593
+ * substring.
594
+ *
595
+ * **NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith`
596
+ * or `refNumberEndsWith`.
597
+ */
598
+ refNumberContains?: string;
599
+ /**
600
+ * Query param: Filter for build assemblies whose `refNumber` ends with this
601
+ * substring.
602
+ *
603
+ * **NOTE**: If you use this parameter, you cannot also use `refNumberContains` or
604
+ * `refNumberStartsWith`.
605
+ */
606
+ refNumberEndsWith?: string;
607
+ /**
608
+ * Query param: Filter for build assemblies whose `refNumber` is greater than or
609
+ * equal to this value. If omitted, the range will begin with the first number of
610
+ * the list. Uses a numerical comparison for values that contain only digits;
611
+ * otherwise, uses a lexicographical comparison.
612
+ */
613
+ refNumberFrom?: string;
614
+ /**
615
+ * Query param: Filter for specific build assemblies by their ref-number(s),
616
+ * case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can
617
+ * be arbitrarily changed by the QuickBooks user.
618
+ *
619
+ * **IMPORTANT**: If you include this parameter, QuickBooks will ignore all other
620
+ * query parameters for this request.
621
+ *
622
+ * **NOTE**: If any of the values you specify in this parameter are not found, the
623
+ * request will return an error.
624
+ */
625
+ refNumbers?: Array<string>;
626
+ /**
627
+ * Query param: Filter for build assemblies whose `refNumber` starts with this
628
+ * substring.
629
+ *
630
+ * **NOTE**: If you use this parameter, you cannot also use `refNumberContains` or
631
+ * `refNumberEndsWith`.
632
+ */
633
+ refNumberStartsWith?: string;
634
+ /**
635
+ * Query param: Filter for build assemblies whose `refNumber` is less than or equal
636
+ * to this value. If omitted, the range will end with the last number of the list.
637
+ * Uses a numerical comparison for values that contain only digits; otherwise, uses
638
+ * a lexicographical comparison.
639
+ */
640
+ refNumberTo?: string;
641
+ /**
642
+ * Query param: Filter for build assemblies whose `date` field is on or after this
643
+ * date, in ISO 8601 format (YYYY-MM-DD).
644
+ */
645
+ transactionDateFrom?: string;
646
+ /**
647
+ * Query param: Filter for build assemblies whose `date` field is on or before this
648
+ * date, in ISO 8601 format (YYYY-MM-DD).
649
+ */
650
+ transactionDateTo?: string;
651
+ /**
652
+ * Query param: Filter for build assemblies updated on or after this date and time,
653
+ * in ISO 8601 format (YYYY-MM-DDTHH:mm:ss). If you only provide a date
654
+ * (YYYY-MM-DD), the time is assumed to be 00:00:00 of that day.
655
+ */
656
+ updatedAfter?: string;
657
+ /**
658
+ * Query param: Filter for build assemblies updated on or before this date and
659
+ * time, in ISO 8601 format (YYYY-MM-DDTHH:mm:ss). If you only provide a date
660
+ * (YYYY-MM-DD), the time is assumed to be 23:59:59 of that day.
661
+ */
662
+ updatedBefore?: string;
663
+ }
664
+ export interface BuildAssemblyDeleteParams {
665
+ /**
666
+ * The ID of the EndUser to receive this request (e.g.,
667
+ * `"Conductor-End-User-Id: {{END_USER_ID}}"`).
668
+ */
669
+ conductorEndUserId: string;
670
+ }
671
+ export declare namespace BuildAssemblies {
672
+ export { type BuildAssembly as BuildAssembly, type BuildAssemblyDeleteResponse as BuildAssemblyDeleteResponse, BuildAssembliesCursorPage as BuildAssembliesCursorPage, type BuildAssemblyCreateParams as BuildAssemblyCreateParams, type BuildAssemblyRetrieveParams as BuildAssemblyRetrieveParams, type BuildAssemblyUpdateParams as BuildAssemblyUpdateParams, type BuildAssemblyListParams as BuildAssemblyListParams, type BuildAssemblyDeleteParams as BuildAssemblyDeleteParams, };
673
+ }
674
+ //# sourceMappingURL=build-assemblies.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"build-assemblies.d.ts","sourceRoot":"","sources":["../../src/resources/qbd/build-assemblies.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAErE,qBAAa,eAAgB,SAAQ,WAAW;IAC9C;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,MAAM,EAAE,yBAAyB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC;IASxG;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC;IAQjC;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,yBAAyB,EACjC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC;IASjC;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,yBAAyB,EAAE,aAAa,CAAC;IAS7D;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,yBAAyB,EACjC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,2BAA2B,CAAC;CAOhD;AAED,qBAAa,yBAA0B,SAAQ,UAAU,CAAC,aAAa,CAAC;CAAG;AAE3E,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,YAAY,EAAE,KAAK,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;IAE/C;;;;;OAKG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;;OAIG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;;OAIG;IACH,qBAAqB,EAAE,aAAa,CAAC,qBAAqB,CAAC;IAE3D;;;OAGG;IACH,aAAa,EAAE,aAAa,CAAC,aAAa,GAAG,IAAI,CAAC;IAElD;;;OAGG;IACH,qBAAqB,EAAE,aAAa,CAAC,qBAAqB,GAAG,IAAI,CAAC;IAElE;;OAEG;IACH,SAAS,EAAE,OAAO,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IAEjC;;;OAGG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,oBAAoB,CAAC;IAEjC;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;;;OAKG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,yBAAiB,aAAa,CAAC;IAC7B,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;IAED;;;;OAIG;IACH,UAAiB,qBAAqB;QACpC;;;;WAIG;QACH,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;QAElB;;;;WAIG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;KACzB;IAED;;;OAGG;IACH,UAAiB,aAAa;QAC5B;;;;WAIG;QACH,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;QAElB;;;;WAIG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;KACzB;IAED;;;OAGG;IACH,UAAiB,qBAAqB;QACpC;;;;WAIG;QACH,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;QAElB;;;;WAIG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;KACzB;IAED,UAAiB,IAAI;QACnB;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;;;;WAKG;QACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;;WAGG;QACH,aAAa,EAAE,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;QAEzC;;;WAGG;QACH,qBAAqB,EAAE,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC;QAEzD;;;;;WAKG;QACH,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC;QAEhB;;;WAGG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;;;WAIG;QACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;WAEG;QACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;;WAGG;QACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;KAC7B;IAED,UAAiB,IAAI,CAAC;QACpB;;;WAGG;QACH,UAAiB,aAAa;YAC5B;;;;eAIG;YACH,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;YAElB;;;;eAIG;YACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;SACzB;QAED;;;WAGG;QACH,UAAiB,qBAAqB;YACpC;;;;eAIG;YACH,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;YAElB;;;;eAIG;YACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;SACzB;QAED;;;;;WAKG;QACH,UAAiB,IAAI;YACnB;;;;eAIG;YACH,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;YAElB;;;;eAIG;YACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;SACzB;KACF;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,oBAAoB,CAAC;IAEjC;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,yBAAyB;IACxC;;;;OAIG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAEhC;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,2BAA2B;IAC1C;;;OAGG;IACH,kBAAkB,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,yBAAyB;IACxC;;;;;OAKG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,uBAAwB,SAAQ,gBAAgB;IAC/D;;;OAGG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;;;;;;;;OASG;IACH,GAAG,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEpB;;;OAGG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAEpC;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExB;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,GAAG,aAAa,GAAG,SAAS,CAAC;IAElD;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;;;;;;;OAUG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE3B;;;;;;OAMG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,kBAAkB,EAAE,MAAM,CAAC;CAC5B;AAID,MAAM,CAAC,OAAO,WAAW,eAAe,CAAC;IACvC,OAAO,EACL,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,yBAAyB,IAAI,yBAAyB,EACtD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}