@augno/sdk 0.18.2 → 0.19.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 (193) hide show
  1. package/CHANGELOG.md +2 -2
  2. package/package.json +1 -1
  3. package/resources/catalog/catalog.d.mts +6 -6
  4. package/resources/catalog/catalog.d.mts.map +1 -1
  5. package/resources/catalog/catalog.d.ts +6 -6
  6. package/resources/catalog/catalog.d.ts.map +1 -1
  7. package/resources/catalog/catalog.js.map +1 -1
  8. package/resources/catalog/catalog.mjs.map +1 -1
  9. package/resources/catalog/index.d.mts +3 -3
  10. package/resources/catalog/index.d.mts.map +1 -1
  11. package/resources/catalog/index.d.ts +3 -3
  12. package/resources/catalog/index.d.ts.map +1 -1
  13. package/resources/catalog/index.js.map +1 -1
  14. package/resources/catalog/index.mjs.map +1 -1
  15. package/resources/catalog/items/actions.d.mts +249 -0
  16. package/resources/catalog/items/actions.d.mts.map +1 -0
  17. package/resources/catalog/items/actions.d.ts +249 -0
  18. package/resources/catalog/items/actions.d.ts.map +1 -0
  19. package/resources/catalog/items/actions.js +46 -0
  20. package/resources/catalog/items/actions.js.map +1 -0
  21. package/resources/catalog/items/actions.mjs +42 -0
  22. package/resources/catalog/items/actions.mjs.map +1 -0
  23. package/resources/catalog/items/index.d.mts +3 -1
  24. package/resources/catalog/items/index.d.mts.map +1 -1
  25. package/resources/catalog/items/index.d.ts +3 -1
  26. package/resources/catalog/items/index.d.ts.map +1 -1
  27. package/resources/catalog/items/index.js +5 -1
  28. package/resources/catalog/items/index.js.map +1 -1
  29. package/resources/catalog/items/index.mjs +2 -0
  30. package/resources/catalog/items/index.mjs.map +1 -1
  31. package/resources/catalog/items/inventory.d.mts +247 -0
  32. package/resources/catalog/items/inventory.d.mts.map +1 -0
  33. package/resources/catalog/items/inventory.d.ts +247 -0
  34. package/resources/catalog/items/inventory.d.ts.map +1 -0
  35. package/resources/catalog/items/inventory.js +75 -0
  36. package/resources/catalog/items/inventory.js.map +1 -0
  37. package/resources/catalog/items/inventory.mjs +71 -0
  38. package/resources/catalog/items/inventory.mjs.map +1 -0
  39. package/resources/catalog/items/items.d.mts +9 -104
  40. package/resources/catalog/items/items.d.mts.map +1 -1
  41. package/resources/catalog/items/items.d.ts +9 -104
  42. package/resources/catalog/items/items.d.ts.map +1 -1
  43. package/resources/catalog/items/items.js +8 -21
  44. package/resources/catalog/items/items.js.map +1 -1
  45. package/resources/catalog/items/items.mjs +8 -21
  46. package/resources/catalog/items/items.mjs.map +1 -1
  47. package/resources/catalog/materials/index.d.mts +1 -1
  48. package/resources/catalog/materials/index.d.mts.map +1 -1
  49. package/resources/catalog/materials/index.d.ts +1 -1
  50. package/resources/catalog/materials/index.d.ts.map +1 -1
  51. package/resources/catalog/materials/index.js.map +1 -1
  52. package/resources/catalog/materials/index.mjs.map +1 -1
  53. package/resources/catalog/materials/materials.d.mts +36 -3
  54. package/resources/catalog/materials/materials.d.mts.map +1 -1
  55. package/resources/catalog/materials/materials.d.ts +36 -3
  56. package/resources/catalog/materials/materials.d.ts.map +1 -1
  57. package/resources/catalog/materials/materials.js.map +1 -1
  58. package/resources/catalog/materials/materials.mjs.map +1 -1
  59. package/resources/catalog/product-lines/index.d.mts +1 -1
  60. package/resources/catalog/product-lines/index.d.mts.map +1 -1
  61. package/resources/catalog/product-lines/index.d.ts +1 -1
  62. package/resources/catalog/product-lines/index.d.ts.map +1 -1
  63. package/resources/catalog/product-lines/index.js.map +1 -1
  64. package/resources/catalog/product-lines/index.mjs.map +1 -1
  65. package/resources/catalog/product-lines/product-lines.d.mts +8 -23
  66. package/resources/catalog/product-lines/product-lines.d.mts.map +1 -1
  67. package/resources/catalog/product-lines/product-lines.d.ts +8 -23
  68. package/resources/catalog/product-lines/product-lines.d.ts.map +1 -1
  69. package/resources/catalog/product-lines/product-lines.js.map +1 -1
  70. package/resources/catalog/product-lines/product-lines.mjs.map +1 -1
  71. package/resources/core/audit-events.d.mts +4 -4
  72. package/resources/core/audit-events.d.mts.map +1 -1
  73. package/resources/core/audit-events.d.ts +4 -4
  74. package/resources/core/audit-events.d.ts.map +1 -1
  75. package/resources/core/core.d.mts +2 -2
  76. package/resources/core/core.d.mts.map +1 -1
  77. package/resources/core/core.d.ts +2 -2
  78. package/resources/core/core.d.ts.map +1 -1
  79. package/resources/core/core.js.map +1 -1
  80. package/resources/core/core.mjs.map +1 -1
  81. package/resources/core/jobs.d.mts +2 -2
  82. package/resources/core/jobs.d.mts.map +1 -1
  83. package/resources/core/jobs.d.ts +2 -2
  84. package/resources/core/jobs.d.ts.map +1 -1
  85. package/resources/messaging/blocks.d.mts +4 -3
  86. package/resources/messaging/blocks.d.mts.map +1 -1
  87. package/resources/messaging/blocks.d.ts +4 -3
  88. package/resources/messaging/blocks.d.ts.map +1 -1
  89. package/resources/messaging/blocks.js.map +1 -1
  90. package/resources/messaging/blocks.mjs.map +1 -1
  91. package/resources/messaging/conversations/conversations.d.mts +3 -3
  92. package/resources/messaging/conversations/conversations.d.mts.map +1 -1
  93. package/resources/messaging/conversations/conversations.d.ts +3 -3
  94. package/resources/messaging/conversations/conversations.d.ts.map +1 -1
  95. package/resources/messaging/conversations/conversations.js.map +1 -1
  96. package/resources/messaging/conversations/conversations.mjs.map +1 -1
  97. package/resources/messaging/conversations/links.d.mts +2 -2
  98. package/resources/messaging/conversations/links.d.mts.map +1 -1
  99. package/resources/messaging/conversations/links.d.ts +2 -2
  100. package/resources/messaging/conversations/links.d.ts.map +1 -1
  101. package/resources/messaging/conversations/messages.d.mts +2 -2
  102. package/resources/messaging/conversations/messages.d.mts.map +1 -1
  103. package/resources/messaging/conversations/messages.d.ts +2 -2
  104. package/resources/messaging/conversations/messages.d.ts.map +1 -1
  105. package/resources/messaging/notifications/notifications.d.mts +2 -2
  106. package/resources/messaging/notifications/notifications.d.mts.map +1 -1
  107. package/resources/messaging/notifications/notifications.d.ts +2 -2
  108. package/resources/messaging/notifications/notifications.d.ts.map +1 -1
  109. package/resources/messaging/notifications/notifications.js.map +1 -1
  110. package/resources/messaging/notifications/notifications.mjs.map +1 -1
  111. package/resources/operations/machine-downtime-events.d.mts +5 -5
  112. package/resources/operations/machine-downtime-events.d.mts.map +1 -1
  113. package/resources/operations/machine-downtime-events.d.ts +5 -5
  114. package/resources/operations/machine-downtime-events.d.ts.map +1 -1
  115. package/resources/operations/production-schedules/actions.d.mts +1 -95
  116. package/resources/operations/production-schedules/actions.d.mts.map +1 -1
  117. package/resources/operations/production-schedules/actions.d.ts +1 -95
  118. package/resources/operations/production-schedules/actions.d.ts.map +1 -1
  119. package/resources/operations/production-schedules/actions.js +0 -34
  120. package/resources/operations/production-schedules/actions.js.map +1 -1
  121. package/resources/operations/production-schedules/actions.mjs +0 -34
  122. package/resources/operations/production-schedules/actions.mjs.map +1 -1
  123. package/resources/operations/production-schedules/index.d.mts +1 -1
  124. package/resources/operations/production-schedules/index.d.mts.map +1 -1
  125. package/resources/operations/production-schedules/index.d.ts +1 -1
  126. package/resources/operations/production-schedules/index.d.ts.map +1 -1
  127. package/resources/operations/production-schedules/index.js.map +1 -1
  128. package/resources/operations/production-schedules/index.mjs.map +1 -1
  129. package/resources/operations/production-schedules/production-schedules.d.mts +2 -2
  130. package/resources/operations/production-schedules/production-schedules.d.mts.map +1 -1
  131. package/resources/operations/production-schedules/production-schedules.d.ts +2 -2
  132. package/resources/operations/production-schedules/production-schedules.d.ts.map +1 -1
  133. package/resources/operations/production-schedules/production-schedules.js.map +1 -1
  134. package/resources/operations/production-schedules/production-schedules.mjs.map +1 -1
  135. package/resources/operations/shipping-terms.d.mts +9 -9
  136. package/resources/operations/shipping-terms.d.mts.map +1 -1
  137. package/resources/operations/shipping-terms.d.ts +9 -9
  138. package/resources/operations/shipping-terms.d.ts.map +1 -1
  139. package/resources/sales/account-prices/account-prices.d.mts +3 -3
  140. package/resources/sales/account-prices/account-prices.d.mts.map +1 -1
  141. package/resources/sales/account-prices/account-prices.d.ts +3 -3
  142. package/resources/sales/account-prices/account-prices.d.ts.map +1 -1
  143. package/resources/sales/account-users/sales-targets.d.mts +2 -2
  144. package/resources/sales/account-users/sales-targets.d.mts.map +1 -1
  145. package/resources/sales/account-users/sales-targets.d.ts +2 -2
  146. package/resources/sales/account-users/sales-targets.d.ts.map +1 -1
  147. package/resources/sales/customers/customers.d.mts +5 -5
  148. package/resources/sales/customers/customers.d.mts.map +1 -1
  149. package/resources/sales/customers/customers.d.ts +5 -5
  150. package/resources/sales/customers/customers.d.ts.map +1 -1
  151. package/resources/sales/sales-orders/lines/lines.d.mts +5 -5
  152. package/resources/sales/sales-orders/lines/lines.d.mts.map +1 -1
  153. package/resources/sales/sales-orders/lines/lines.d.ts +5 -5
  154. package/resources/sales/sales-orders/lines/lines.d.ts.map +1 -1
  155. package/resources/sales/sales-orders/sales-orders.d.mts +8 -4
  156. package/resources/sales/sales-orders/sales-orders.d.mts.map +1 -1
  157. package/resources/sales/sales-orders/sales-orders.d.ts +8 -4
  158. package/resources/sales/sales-orders/sales-orders.d.ts.map +1 -1
  159. package/resources/sales/sales-orders/sales-orders.js.map +1 -1
  160. package/resources/sales/sales-orders/sales-orders.mjs.map +1 -1
  161. package/src/resources/catalog/catalog.ts +2 -8
  162. package/src/resources/catalog/index.ts +1 -4
  163. package/src/resources/catalog/items/actions.ts +296 -0
  164. package/src/resources/catalog/items/index.ts +23 -3
  165. package/src/resources/catalog/items/inventory.ts +294 -0
  166. package/src/resources/catalog/items/items.ts +54 -124
  167. package/src/resources/catalog/materials/index.ts +1 -0
  168. package/src/resources/catalog/materials/materials.ts +41 -2
  169. package/src/resources/catalog/product-lines/index.ts +0 -1
  170. package/src/resources/catalog/product-lines/product-lines.ts +7 -25
  171. package/src/resources/core/audit-events.ts +26 -14
  172. package/src/resources/core/core.ts +13 -7
  173. package/src/resources/core/jobs.ts +7 -4
  174. package/src/resources/messaging/blocks.ts +4 -3
  175. package/src/resources/messaging/conversations/conversations.ts +21 -12
  176. package/src/resources/messaging/conversations/links.ts +14 -8
  177. package/src/resources/messaging/conversations/messages.ts +14 -8
  178. package/src/resources/messaging/notifications/notifications.ts +14 -8
  179. package/src/resources/operations/machine-downtime-events.ts +5 -5
  180. package/src/resources/operations/production-schedules/actions.ts +0 -118
  181. package/src/resources/operations/production-schedules/index.ts +0 -3
  182. package/src/resources/operations/production-schedules/production-schedules.ts +0 -6
  183. package/src/resources/operations/shipping-terms.ts +9 -9
  184. package/src/resources/sales/account-prices/account-prices.ts +3 -3
  185. package/src/resources/sales/account-users/sales-targets.ts +2 -2
  186. package/src/resources/sales/customers/customers.ts +5 -5
  187. package/src/resources/sales/sales-orders/lines/lines.ts +5 -5
  188. package/src/resources/sales/sales-orders/sales-orders.ts +9 -4
  189. package/src/version.ts +1 -1
  190. package/version.d.mts +1 -1
  191. package/version.d.ts +1 -1
  192. package/version.js +1 -1
  193. package/version.mjs +1 -1
@@ -3,8 +3,33 @@
3
3
  import { APIResource } from '../../../core/resource';
4
4
  import * as CoreAPI from '../../core/core';
5
5
  import * as APIKeysAPI from '../../auth/api-keys/api-keys';
6
+ import * as ActionsAPI from './actions';
7
+ import {
8
+ ActionBulkReconcileParams,
9
+ Actions,
10
+ BulkReconcileItemInput,
11
+ BulkReconcileItemsRequest,
12
+ BulkReconcileItemsResponse,
13
+ ListReconcileErrorResult,
14
+ ListReconciledItemResult,
15
+ ListSkippedItemResult,
16
+ ReconcileErrorResult,
17
+ ReconciledItemResult,
18
+ SkippedItemResult,
19
+ } from './actions';
6
20
  import * as AttributesAPI from './attributes';
7
21
  import { AttributeDeleteParams, AttributeUpdateParams, Attributes } from './attributes';
22
+ import * as InventoryAPI from './inventory';
23
+ import {
24
+ ComputedQuantity,
25
+ Inventory,
26
+ InventoryListParams,
27
+ InventoryUpdateParams,
28
+ InventoryUpdateResponse,
29
+ ItemInventory,
30
+ QuantityInput,
31
+ UpdateItemInventoryRequest,
32
+ } from './inventory';
8
33
  import * as PropertiesAPI from '../properties/properties';
9
34
  import * as UnitGroupsAPI from '../unit-groups/unit-groups';
10
35
  import * as UnitsAPI from '../units/units';
@@ -16,7 +41,9 @@ import { path } from '../../../internal/utils/path';
16
41
  * List and manage inventory items.
17
42
  */
18
43
  export class Items extends APIResource {
44
+ inventory: InventoryAPI.Inventory = new InventoryAPI.Inventory(this._client);
19
45
  attributes: AttributesAPI.Attributes = new AttributesAPI.Attributes(this._client);
46
+ actions: ActionsAPI.Actions = new ActionsAPI.Actions(this._client);
20
47
 
21
48
  /**
22
49
  * Returns a paginated list of items, newest first.
@@ -57,32 +84,6 @@ export class Items extends APIResource {
57
84
  return this._client.get(path`/v1/catalog/items/${id}`, { query, ...options });
58
85
  }
59
86
 
60
- /**
61
- * Returns the stock position for an item: what is on hand, what is reserved
62
- * against existing orders, what is free to promise, and what is short.
63
- *
64
- * Stock your account either owns or holds counts toward the on-hand figure, so
65
- * customer-supplied material sitting in your facility is included. All four
66
- * quantities are reported in the base unit of the item's category.
67
- *
68
- * This endpoint requires the permission: `items:read`.
69
- *
70
- * @example
71
- * ```ts
72
- * const itemInventory =
73
- * await client.catalog.items.retrieveInventory(
74
- * 'it_pej07ckhvu62',
75
- * );
76
- * ```
77
- */
78
- retrieveInventory(
79
- id: string,
80
- query: ItemRetrieveInventoryParams | null | undefined = {},
81
- options?: RequestOptions,
82
- ): APIPromise<ItemInventory> {
83
- return this._client.get(path`/v1/catalog/items/${id}/inventory`, { query, ...options });
84
- }
85
-
86
87
  /**
87
88
  * Returns the lot this item is made in — how many, counted in what.
88
89
  *
@@ -300,56 +301,6 @@ export interface ItemCategory {
300
301
  updated_at: string;
301
302
  }
302
303
 
303
- /**
304
- * The stock position for an item: what is in stock, what is already committed, and
305
- * what is still free to sell.
306
- *
307
- * All four quantities are reported in the same unit — the base unit of the item's
308
- * category.
309
- */
310
- export interface ItemInventory {
311
- /**
312
- * A measured amount: a numeric value together with the unit it is expressed in.
313
- *
314
- * Quantities are shared building blocks rather than standalone records — other
315
- * resources point at them to report stock levels, ordered and packed amounts,
316
- * money, weights, and durations.
317
- */
318
- available_to_promise: Quantity | null;
319
-
320
- /**
321
- * Resource type identifier.
322
- */
323
- object: 'item_inventory';
324
-
325
- /**
326
- * A measured amount: a numeric value together with the unit it is expressed in.
327
- *
328
- * Quantities are shared building blocks rather than standalone records — other
329
- * resources point at them to report stock levels, ordered and packed amounts,
330
- * money, weights, and durations.
331
- */
332
- on_hand: Quantity | null;
333
-
334
- /**
335
- * A measured amount: a numeric value together with the unit it is expressed in.
336
- *
337
- * Quantities are shared building blocks rather than standalone records — other
338
- * resources point at them to report stock levels, ordered and packed amounts,
339
- * money, weights, and durations.
340
- */
341
- reserved: Quantity | null;
342
-
343
- /**
344
- * A measured amount: a numeric value together with the unit it is expressed in.
345
- *
346
- * Quantities are shared building blocks rather than standalone records — other
347
- * resources point at them to report stock levels, ordered and packed amounts,
348
- * money, weights, and durations.
349
- */
350
- short: Quantity | null;
351
- }
352
-
353
304
  /**
354
305
  * The lot an item is made in — how many, counted in what.
355
306
  *
@@ -427,43 +378,6 @@ export interface ListItem {
427
378
  page_info: APIKeysAPI.PageInfo;
428
379
  }
429
380
 
430
- /**
431
- * A measured amount: a numeric value together with the unit it is expressed in.
432
- *
433
- * Quantities are shared building blocks rather than standalone records — other
434
- * resources point at them to report stock levels, ordered and packed amounts,
435
- * money, weights, and durations.
436
- */
437
- export interface Quantity {
438
- /**
439
- * Quantity ID.
440
- */
441
- id: string;
442
-
443
- /**
444
- * Formatted value with unit abbreviation (e.g. "$1,234.56" or "100 kg").
445
- */
446
- display_value: string;
447
-
448
- /**
449
- * Resource type identifier.
450
- */
451
- object: 'quantity';
452
-
453
- /**
454
- * Unit of measurement used for conversions and product quantities.
455
- */
456
- unit: UnitsAPI.Unit | null;
457
-
458
- /**
459
- * Raw decimal value of the quantity, as a string to preserve precision.
460
- *
461
- * This is the unformatted machine value; see `display_value` for the
462
- * human-readable rendering with unit and thousands separators.
463
- */
464
- value: string;
465
- }
466
-
467
381
  /**
468
382
  * Value expressed as a ratio of two units, such as a price per kilogram or a
469
383
  * throughput per hour.
@@ -627,14 +541,6 @@ export interface ItemRetrieveParams {
627
541
  >;
628
542
  }
629
543
 
630
- export interface ItemRetrieveInventoryParams {
631
- /**
632
- * Sub-objects to expand in the response. When omitted, sub-objects are returned as
633
- * `null`.
634
- */
635
- include?: Array<'on_hand' | 'reserved' | 'available_to_promise' | 'short'>;
636
- }
637
-
638
544
  export interface ItemRetrieveLotDefaultParams {
639
545
  /**
640
546
  * Sub-objects to expand in the response. When omitted, sub-objects are returned as
@@ -667,27 +573,51 @@ export interface ItemChangeCategoryParams {
667
573
  >;
668
574
  }
669
575
 
576
+ Items.Inventory = Inventory;
670
577
  Items.Attributes = Attributes;
578
+ Items.Actions = Actions;
671
579
 
672
580
  export declare namespace Items {
673
581
  export {
674
582
  type Item as Item,
675
583
  type ItemCategory as ItemCategory,
676
- type ItemInventory as ItemInventory,
677
584
  type ItemLotDefault as ItemLotDefault,
678
585
  type ListItem as ListItem,
679
- type Quantity as Quantity,
680
586
  type Rate as Rate,
681
587
  type ItemListParams as ItemListParams,
682
588
  type ItemRetrieveParams as ItemRetrieveParams,
683
- type ItemRetrieveInventoryParams as ItemRetrieveInventoryParams,
684
589
  type ItemRetrieveLotDefaultParams as ItemRetrieveLotDefaultParams,
685
590
  type ItemChangeCategoryParams as ItemChangeCategoryParams,
686
591
  };
687
592
 
593
+ export {
594
+ Inventory as Inventory,
595
+ type ComputedQuantity as ComputedQuantity,
596
+ type ItemInventory as ItemInventory,
597
+ type QuantityInput as QuantityInput,
598
+ type UpdateItemInventoryRequest as UpdateItemInventoryRequest,
599
+ type InventoryUpdateResponse as InventoryUpdateResponse,
600
+ type InventoryListParams as InventoryListParams,
601
+ type InventoryUpdateParams as InventoryUpdateParams,
602
+ };
603
+
688
604
  export {
689
605
  Attributes as Attributes,
690
606
  type AttributeUpdateParams as AttributeUpdateParams,
691
607
  type AttributeDeleteParams as AttributeDeleteParams,
692
608
  };
609
+
610
+ export {
611
+ Actions as Actions,
612
+ type BulkReconcileItemInput as BulkReconcileItemInput,
613
+ type BulkReconcileItemsRequest as BulkReconcileItemsRequest,
614
+ type BulkReconcileItemsResponse as BulkReconcileItemsResponse,
615
+ type ListReconcileErrorResult as ListReconcileErrorResult,
616
+ type ListReconciledItemResult as ListReconciledItemResult,
617
+ type ListSkippedItemResult as ListSkippedItemResult,
618
+ type ReconcileErrorResult as ReconcileErrorResult,
619
+ type ReconciledItemResult as ReconciledItemResult,
620
+ type SkippedItemResult as SkippedItemResult,
621
+ type ActionBulkReconcileParams as ActionBulkReconcileParams,
622
+ };
693
623
  }
@@ -12,6 +12,7 @@ export {
12
12
  type CreateMaterialRequest,
13
13
  type ListMaterial,
14
14
  type Material,
15
+ type Quantity,
15
16
  type QuantityInputRequest,
16
17
  type RateInput,
17
18
  type UpdateMaterialRequest,
@@ -11,6 +11,7 @@ import {
11
11
  UpsertMaterialInput,
12
12
  UpsertMaterialProperty,
13
13
  } from './actions';
14
+ import * as UnitsAPI from '../units/units';
14
15
  import { APIPromise } from '../../../core/api-promise';
15
16
  import { RequestOptions } from '../../../internal/request-options';
16
17
  import { path } from '../../../internal/utils/path';
@@ -301,7 +302,7 @@ export interface Material {
301
302
  * resources point at them to report stock levels, ordered and packed amounts,
302
303
  * money, weights, and durations.
303
304
  */
304
- lead_time: ItemsAPI.Quantity | null;
305
+ lead_time: Quantity | null;
305
306
 
306
307
  /**
307
308
  * Resource type identifier.
@@ -315,7 +316,7 @@ export interface Material {
315
316
  * resources point at them to report stock levels, ordered and packed amounts,
316
317
  * money, weights, and durations.
317
318
  */
318
- order_point: ItemsAPI.Quantity | null;
319
+ order_point: Quantity | null;
319
320
 
320
321
  /**
321
322
  * Last updated timestamp.
@@ -323,6 +324,43 @@ export interface Material {
323
324
  updated_at: string;
324
325
  }
325
326
 
327
+ /**
328
+ * A measured amount: a numeric value together with the unit it is expressed in.
329
+ *
330
+ * Quantities are shared building blocks rather than standalone records — other
331
+ * resources point at them to report stock levels, ordered and packed amounts,
332
+ * money, weights, and durations.
333
+ */
334
+ export interface Quantity {
335
+ /**
336
+ * Quantity ID.
337
+ */
338
+ id: string;
339
+
340
+ /**
341
+ * Formatted value with unit abbreviation (e.g. "$1,234.56" or "100 kg").
342
+ */
343
+ display_value: string;
344
+
345
+ /**
346
+ * Resource type identifier.
347
+ */
348
+ object: 'quantity';
349
+
350
+ /**
351
+ * Unit of measurement used for conversions and product quantities.
352
+ */
353
+ unit: UnitsAPI.Unit | null;
354
+
355
+ /**
356
+ * Raw decimal value of the quantity, as a string to preserve precision.
357
+ *
358
+ * This is the unformatted machine value; see `display_value` for the
359
+ * human-readable rendering with unit and thousands separators.
360
+ */
361
+ value: string;
362
+ }
363
+
326
364
  /**
327
365
  * A quantity, given as a decimal value and the unit it is measured in.
328
366
  */
@@ -620,6 +658,7 @@ export declare namespace Materials {
620
658
  type CreateMaterialRequest as CreateMaterialRequest,
621
659
  type ListMaterial as ListMaterial,
622
660
  type Material as Material,
661
+ type Quantity as Quantity,
623
662
  type QuantityInputRequest as QuantityInputRequest,
624
663
  type RateInput as RateInput,
625
664
  type UpdateMaterialRequest as UpdateMaterialRequest,
@@ -11,7 +11,6 @@ export {
11
11
  type CreateProductLineRequest,
12
12
  type ListProductLine,
13
13
  type ProductLine,
14
- type QuantityInput,
15
14
  type UpdateProductLineRequest,
16
15
  type ProductLineDeleteResponse,
17
16
  type ProductLineListParams,
@@ -2,7 +2,8 @@
2
2
 
3
3
  import { APIResource } from '../../../core/resource';
4
4
  import * as APIKeysAPI from '../../auth/api-keys/api-keys';
5
- import * as ItemsAPI from '../items/items';
5
+ import * as InventoryAPI from '../items/inventory';
6
+ import * as MaterialsAPI from '../materials/materials';
6
7
  import * as ActionsAPI from './actions';
7
8
  import {
8
9
  ActionBulkUpsertParams,
@@ -198,7 +199,7 @@ export interface CreateProductLineRequest {
198
199
  * The unit may be a currency, so money amounts such as a credit limit are written
199
200
  * the same way as physical amounts like weights or counts.
200
201
  */
201
- default_lot?: QuantityInput;
202
+ default_lot?: InventoryAPI.QuantityInput;
202
203
 
203
204
  /**
204
205
  * How products in this line are produced when they do not say for themselves.
@@ -273,7 +274,7 @@ export interface ProductLine {
273
274
  * resources point at them to report stock levels, ordered and packed amounts,
274
275
  * money, weights, and durations.
275
276
  */
276
- default_lot: ItemsAPI.Quantity | null;
277
+ default_lot: MaterialsAPI.Quantity | null;
277
278
 
278
279
  /**
279
280
  * Free-form description of the product line.
@@ -340,24 +341,6 @@ export interface ProductLine {
340
341
  updated_at: string;
341
342
  }
342
343
 
343
- /**
344
- * An amount together with the unit it is expressed in.
345
- *
346
- * The unit may be a currency, so money amounts such as a credit limit are written
347
- * the same way as physical amounts like weights or counts.
348
- */
349
- export interface QuantityInput {
350
- /**
351
- * ID of the unit of measure for the value.
352
- */
353
- unit_id: string;
354
-
355
- /**
356
- * Decimal value, as a string to preserve precision.
357
- */
358
- value: string;
359
- }
360
-
361
344
  /**
362
345
  * Request to partially update a product line.
363
346
  */
@@ -377,7 +360,7 @@ export interface UpdateProductLineRequest {
377
360
  * The unit may be a currency, so money amounts such as a credit limit are written
378
361
  * the same way as physical amounts like weights or counts.
379
362
  */
380
- default_lot?: QuantityInput | null;
363
+ default_lot?: InventoryAPI.QuantityInput | null;
381
364
 
382
365
  /**
383
366
  * Default freight policy for products in this product line.
@@ -506,7 +489,7 @@ export interface ProductLineCreateParams {
506
489
  * The unit may be a currency, so money amounts such as a credit limit are written
507
490
  * the same way as physical amounts like weights or counts.
508
491
  */
509
- default_lot?: QuantityInput;
492
+ default_lot?: InventoryAPI.QuantityInput;
510
493
 
511
494
  /**
512
495
  * Body param: How products in this line are produced when they do not say for
@@ -542,7 +525,7 @@ export interface ProductLineUpdateParams {
542
525
  * The unit may be a currency, so money amounts such as a credit limit are written
543
526
  * the same way as physical amounts like weights or counts.
544
527
  */
545
- default_lot?: QuantityInput | null;
528
+ default_lot?: InventoryAPI.QuantityInput | null;
546
529
 
547
530
  /**
548
531
  * Body param: Default freight policy for products in this product line.
@@ -592,7 +575,6 @@ export declare namespace ProductLines {
592
575
  type CreateProductLineRequest as CreateProductLineRequest,
593
576
  type ListProductLine as ListProductLine,
594
577
  type ProductLine as ProductLine,
595
- type QuantityInput as QuantityInput,
596
578
  type UpdateProductLineRequest as UpdateProductLineRequest,
597
579
  type ProductLineDeleteResponse as ProductLineDeleteResponse,
598
580
  type ProductLineListParams as ProductLineListParams,
@@ -298,7 +298,6 @@ export interface AuditEvent {
298
298
  | 'delivery_breakdown'
299
299
  | 'schedule_order_coverage'
300
300
  | 'schedule_order_coverage_line'
301
- | 'promise_date_quote'
302
301
  | 'schedule_deviation_type'
303
302
  | 'schedule_at_risk_order'
304
303
  | 'production_schedule_finished_policy'
@@ -441,8 +440,6 @@ export interface AuditEvent {
441
440
  | 'batch_lot'
442
441
  | 'check_duplicate_result'
443
442
  | 'item_trend_point'
444
- | 'pack_pick_response'
445
- | 'pick_shipments_response'
446
443
  | 'tenancy_pending_registration'
447
444
  | 'invoice_allocation_entry'
448
445
  | 'allocation_customer'
@@ -481,7 +478,13 @@ export interface AuditEvent {
481
478
  | 'computed_quantity'
482
479
  | 'analyze_realized_margins_response'
483
480
  | 'realized_margin_finding'
484
- | 'realized_margin_summary';
481
+ | 'realized_margin_summary'
482
+ | 'shipment_related'
483
+ | 'invoice_related'
484
+ | 'pick_related'
485
+ | 'pick_shipments_response'
486
+ | 'pick_totals'
487
+ | 'pick_stage_total';
485
488
 
486
489
  /**
487
490
  * Originating client IP address.
@@ -707,7 +710,6 @@ export interface ListObjectType {
707
710
  | 'delivery_breakdown'
708
711
  | 'schedule_order_coverage'
709
712
  | 'schedule_order_coverage_line'
710
- | 'promise_date_quote'
711
713
  | 'schedule_deviation_type'
712
714
  | 'schedule_at_risk_order'
713
715
  | 'production_schedule_finished_policy'
@@ -850,8 +852,6 @@ export interface ListObjectType {
850
852
  | 'batch_lot'
851
853
  | 'check_duplicate_result'
852
854
  | 'item_trend_point'
853
- | 'pack_pick_response'
854
- | 'pick_shipments_response'
855
855
  | 'tenancy_pending_registration'
856
856
  | 'invoice_allocation_entry'
857
857
  | 'allocation_customer'
@@ -891,6 +891,12 @@ export interface ListObjectType {
891
891
  | 'analyze_realized_margins_response'
892
892
  | 'realized_margin_finding'
893
893
  | 'realized_margin_summary'
894
+ | 'shipment_related'
895
+ | 'invoice_related'
896
+ | 'pick_related'
897
+ | 'pick_shipments_response'
898
+ | 'pick_totals'
899
+ | 'pick_stage_total'
894
900
  >;
895
901
 
896
902
  /**
@@ -1104,7 +1110,6 @@ export interface AuditEventListParams {
1104
1110
  | 'delivery_breakdown'
1105
1111
  | 'schedule_order_coverage'
1106
1112
  | 'schedule_order_coverage_line'
1107
- | 'promise_date_quote'
1108
1113
  | 'schedule_deviation_type'
1109
1114
  | 'schedule_at_risk_order'
1110
1115
  | 'production_schedule_finished_policy'
@@ -1247,8 +1252,6 @@ export interface AuditEventListParams {
1247
1252
  | 'batch_lot'
1248
1253
  | 'check_duplicate_result'
1249
1254
  | 'item_trend_point'
1250
- | 'pack_pick_response'
1251
- | 'pick_shipments_response'
1252
1255
  | 'tenancy_pending_registration'
1253
1256
  | 'invoice_allocation_entry'
1254
1257
  | 'allocation_customer'
@@ -1288,6 +1291,12 @@ export interface AuditEventListParams {
1288
1291
  | 'analyze_realized_margins_response'
1289
1292
  | 'realized_margin_finding'
1290
1293
  | 'realized_margin_summary'
1294
+ | 'shipment_related'
1295
+ | 'invoice_related'
1296
+ | 'pick_related'
1297
+ | 'pick_shipments_response'
1298
+ | 'pick_totals'
1299
+ | 'pick_stage_total'
1291
1300
  >;
1292
1301
 
1293
1302
  /**
@@ -1424,7 +1433,6 @@ export interface AuditEventListParams {
1424
1433
  | 'delivery_breakdown'
1425
1434
  | 'schedule_order_coverage'
1426
1435
  | 'schedule_order_coverage_line'
1427
- | 'promise_date_quote'
1428
1436
  | 'schedule_deviation_type'
1429
1437
  | 'schedule_at_risk_order'
1430
1438
  | 'production_schedule_finished_policy'
@@ -1567,8 +1575,6 @@ export interface AuditEventListParams {
1567
1575
  | 'batch_lot'
1568
1576
  | 'check_duplicate_result'
1569
1577
  | 'item_trend_point'
1570
- | 'pack_pick_response'
1571
- | 'pick_shipments_response'
1572
1578
  | 'tenancy_pending_registration'
1573
1579
  | 'invoice_allocation_entry'
1574
1580
  | 'allocation_customer'
@@ -1607,7 +1613,13 @@ export interface AuditEventListParams {
1607
1613
  | 'computed_quantity'
1608
1614
  | 'analyze_realized_margins_response'
1609
1615
  | 'realized_margin_finding'
1610
- | 'realized_margin_summary';
1616
+ | 'realized_margin_summary'
1617
+ | 'shipment_related'
1618
+ | 'invoice_related'
1619
+ | 'pick_related'
1620
+ | 'pick_shipments_response'
1621
+ | 'pick_totals'
1622
+ | 'pick_stage_total';
1611
1623
 
1612
1624
  /**
1613
1625
  * Restricts results to audit events on or after this timestamp.
@@ -291,7 +291,6 @@ export interface Entity {
291
291
  | 'delivery_breakdown'
292
292
  | 'schedule_order_coverage'
293
293
  | 'schedule_order_coverage_line'
294
- | 'promise_date_quote'
295
294
  | 'schedule_deviation_type'
296
295
  | 'schedule_at_risk_order'
297
296
  | 'production_schedule_finished_policy'
@@ -434,8 +433,6 @@ export interface Entity {
434
433
  | 'batch_lot'
435
434
  | 'check_duplicate_result'
436
435
  | 'item_trend_point'
437
- | 'pack_pick_response'
438
- | 'pick_shipments_response'
439
436
  | 'tenancy_pending_registration'
440
437
  | 'invoice_allocation_entry'
441
438
  | 'allocation_customer'
@@ -474,7 +471,13 @@ export interface Entity {
474
471
  | 'computed_quantity'
475
472
  | 'analyze_realized_margins_response'
476
473
  | 'realized_margin_finding'
477
- | 'realized_margin_summary';
474
+ | 'realized_margin_summary'
475
+ | 'shipment_related'
476
+ | 'invoice_related'
477
+ | 'pick_related'
478
+ | 'pick_shipments_response'
479
+ | 'pick_totals'
480
+ | 'pick_stage_total';
478
481
  }
479
482
 
480
483
  /**
@@ -666,7 +669,6 @@ export interface CoreRetrieveSearchParams {
666
669
  | 'delivery_breakdown'
667
670
  | 'schedule_order_coverage'
668
671
  | 'schedule_order_coverage_line'
669
- | 'promise_date_quote'
670
672
  | 'schedule_deviation_type'
671
673
  | 'schedule_at_risk_order'
672
674
  | 'production_schedule_finished_policy'
@@ -809,8 +811,6 @@ export interface CoreRetrieveSearchParams {
809
811
  | 'batch_lot'
810
812
  | 'check_duplicate_result'
811
813
  | 'item_trend_point'
812
- | 'pack_pick_response'
813
- | 'pick_shipments_response'
814
814
  | 'tenancy_pending_registration'
815
815
  | 'invoice_allocation_entry'
816
816
  | 'allocation_customer'
@@ -850,6 +850,12 @@ export interface CoreRetrieveSearchParams {
850
850
  | 'analyze_realized_margins_response'
851
851
  | 'realized_margin_finding'
852
852
  | 'realized_margin_summary'
853
+ | 'shipment_related'
854
+ | 'invoice_related'
855
+ | 'pick_related'
856
+ | 'pick_shipments_response'
857
+ | 'pick_totals'
858
+ | 'pick_stage_total'
853
859
  >;
854
860
  }
855
861
 
@@ -240,7 +240,6 @@ export interface Job {
240
240
  | 'delivery_breakdown'
241
241
  | 'schedule_order_coverage'
242
242
  | 'schedule_order_coverage_line'
243
- | 'promise_date_quote'
244
243
  | 'schedule_deviation_type'
245
244
  | 'schedule_at_risk_order'
246
245
  | 'production_schedule_finished_policy'
@@ -383,8 +382,6 @@ export interface Job {
383
382
  | 'batch_lot'
384
383
  | 'check_duplicate_result'
385
384
  | 'item_trend_point'
386
- | 'pack_pick_response'
387
- | 'pick_shipments_response'
388
385
  | 'tenancy_pending_registration'
389
386
  | 'invoice_allocation_entry'
390
387
  | 'allocation_customer'
@@ -424,6 +421,12 @@ export interface Job {
424
421
  | 'analyze_realized_margins_response'
425
422
  | 'realized_margin_finding'
426
423
  | 'realized_margin_summary'
424
+ | 'shipment_related'
425
+ | 'invoice_related'
426
+ | 'pick_related'
427
+ | 'pick_shipments_response'
428
+ | 'pick_totals'
429
+ | 'pick_stage_total'
427
430
  | null;
428
431
 
429
432
  /**
@@ -448,7 +451,7 @@ export interface Job {
448
451
  /**
449
452
  * The kind of work the job carries out.
450
453
  */
451
- type: 'bulk_create' | 'bulk_upsert' | 'export';
454
+ type: 'bulk_create' | 'bulk_upsert' | 'export' | 'pack_pick';
452
455
 
453
456
  /**
454
457
  * When the job was last updated.
@@ -3,6 +3,7 @@
3
3
  import { APIResource } from '../../core/resource';
4
4
  import * as APIKeysAPI from '../auth/api-keys/api-keys';
5
5
  import * as ItemsAPI from '../catalog/items/items';
6
+ import * as MaterialsAPI from '../catalog/materials/materials';
6
7
  import { APIPromise } from '../../core/api-promise';
7
8
  import { RequestOptions } from '../../internal/request-options';
8
9
  import { path } from '../../internal/utils/path';
@@ -207,7 +208,7 @@ export interface Consumption {
207
208
  * resources point at them to report stock levels, ordered and packed amounts,
208
209
  * money, weights, and durations.
209
210
  */
210
- quantity: ItemsAPI.Quantity | null;
211
+ quantity: MaterialsAPI.Quantity | null;
211
212
 
212
213
  /**
213
214
  * Last updated timestamp.
@@ -221,7 +222,7 @@ export interface Consumption {
221
222
  * resources point at them to report stock levels, ordered and packed amounts,
222
223
  * money, weights, and durations.
223
224
  */
224
- waste_quantity: ItemsAPI.Quantity | null;
225
+ waste_quantity: MaterialsAPI.Quantity | null;
225
226
  }
226
227
 
227
228
  /**
@@ -615,7 +616,7 @@ export interface ProductionOutput {
615
616
  * resources point at them to report stock levels, ordered and packed amounts,
616
617
  * money, weights, and durations.
617
618
  */
618
- quantity: ItemsAPI.Quantity | null;
619
+ quantity: MaterialsAPI.Quantity | null;
619
620
 
620
621
  /**
621
622
  * Last updated timestamp.