@augno/sdk 0.14.0 → 0.15.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 (223) hide show
  1. package/CHANGELOG.md +3 -3
  2. package/package.json +1 -1
  3. package/resources/catalog/product-lines/product-lines.d.mts +53 -0
  4. package/resources/catalog/product-lines/product-lines.d.mts.map +1 -1
  5. package/resources/catalog/product-lines/product-lines.d.ts +53 -0
  6. package/resources/catalog/product-lines/product-lines.d.ts.map +1 -1
  7. package/resources/catalog/product-lines/product-lines.js.map +1 -1
  8. package/resources/catalog/product-lines/product-lines.mjs.map +1 -1
  9. package/resources/core/analytics.d.mts +252 -1
  10. package/resources/core/analytics.d.mts.map +1 -1
  11. package/resources/core/analytics.d.ts +252 -1
  12. package/resources/core/analytics.d.ts.map +1 -1
  13. package/resources/core/analytics.js +38 -0
  14. package/resources/core/analytics.js.map +1 -1
  15. package/resources/core/analytics.mjs +38 -0
  16. package/resources/core/analytics.mjs.map +1 -1
  17. package/resources/core/audit-events.d.mts +4 -4
  18. package/resources/core/audit-events.d.mts.map +1 -1
  19. package/resources/core/audit-events.d.ts +4 -4
  20. package/resources/core/audit-events.d.ts.map +1 -1
  21. package/resources/core/core.d.mts +4 -4
  22. package/resources/core/core.d.mts.map +1 -1
  23. package/resources/core/core.d.ts +4 -4
  24. package/resources/core/core.d.ts.map +1 -1
  25. package/resources/core/core.js.map +1 -1
  26. package/resources/core/core.mjs.map +1 -1
  27. package/resources/core/index.d.mts +1 -1
  28. package/resources/core/index.d.mts.map +1 -1
  29. package/resources/core/index.d.ts +1 -1
  30. package/resources/core/index.d.ts.map +1 -1
  31. package/resources/core/index.js.map +1 -1
  32. package/resources/core/index.mjs.map +1 -1
  33. package/resources/messaging/conversations/conversations.d.mts +3 -3
  34. package/resources/messaging/conversations/conversations.d.mts.map +1 -1
  35. package/resources/messaging/conversations/conversations.d.ts +3 -3
  36. package/resources/messaging/conversations/conversations.d.ts.map +1 -1
  37. package/resources/messaging/conversations/conversations.js.map +1 -1
  38. package/resources/messaging/conversations/conversations.mjs.map +1 -1
  39. package/resources/messaging/conversations/links.d.mts +2 -2
  40. package/resources/messaging/conversations/links.d.mts.map +1 -1
  41. package/resources/messaging/conversations/links.d.ts +2 -2
  42. package/resources/messaging/conversations/links.d.ts.map +1 -1
  43. package/resources/messaging/conversations/messages.d.mts +2 -2
  44. package/resources/messaging/conversations/messages.d.mts.map +1 -1
  45. package/resources/messaging/conversations/messages.d.ts +2 -2
  46. package/resources/messaging/conversations/messages.d.ts.map +1 -1
  47. package/resources/messaging/notifications/notifications.d.mts +2 -2
  48. package/resources/messaging/notifications/notifications.d.mts.map +1 -1
  49. package/resources/messaging/notifications/notifications.d.ts +2 -2
  50. package/resources/messaging/notifications/notifications.d.ts.map +1 -1
  51. package/resources/messaging/notifications/notifications.js.map +1 -1
  52. package/resources/messaging/notifications/notifications.mjs.map +1 -1
  53. package/resources/operations/carriers/service-levels.d.mts +37 -0
  54. package/resources/operations/carriers/service-levels.d.mts.map +1 -1
  55. package/resources/operations/carriers/service-levels.d.ts +37 -0
  56. package/resources/operations/carriers/service-levels.d.ts.map +1 -1
  57. package/resources/operations/carriers/service-levels.js +1 -0
  58. package/resources/operations/carriers/service-levels.js.map +1 -1
  59. package/resources/operations/carriers/service-levels.mjs +1 -0
  60. package/resources/operations/carriers/service-levels.mjs.map +1 -1
  61. package/resources/operations/fulfillment-recommendations/actions.d.mts +59 -0
  62. package/resources/operations/fulfillment-recommendations/actions.d.mts.map +1 -0
  63. package/resources/operations/fulfillment-recommendations/actions.d.ts +59 -0
  64. package/resources/operations/fulfillment-recommendations/actions.d.ts.map +1 -0
  65. package/resources/operations/fulfillment-recommendations/actions.js +40 -0
  66. package/resources/operations/fulfillment-recommendations/actions.js.map +1 -0
  67. package/resources/operations/fulfillment-recommendations/actions.mjs +36 -0
  68. package/resources/operations/fulfillment-recommendations/actions.mjs.map +1 -0
  69. package/resources/operations/fulfillment-recommendations/fulfillment-recommendations.d.mts +165 -0
  70. package/resources/operations/fulfillment-recommendations/fulfillment-recommendations.d.mts.map +1 -0
  71. package/resources/operations/fulfillment-recommendations/fulfillment-recommendations.d.ts +165 -0
  72. package/resources/operations/fulfillment-recommendations/fulfillment-recommendations.d.ts.map +1 -0
  73. package/resources/operations/fulfillment-recommendations/fulfillment-recommendations.js +52 -0
  74. package/resources/operations/fulfillment-recommendations/fulfillment-recommendations.js.map +1 -0
  75. package/resources/operations/fulfillment-recommendations/fulfillment-recommendations.mjs +47 -0
  76. package/resources/operations/fulfillment-recommendations/fulfillment-recommendations.mjs.map +1 -0
  77. package/resources/operations/fulfillment-recommendations/index.d.mts +3 -0
  78. package/resources/operations/fulfillment-recommendations/index.d.mts.map +1 -0
  79. package/resources/operations/fulfillment-recommendations/index.d.ts +3 -0
  80. package/resources/operations/fulfillment-recommendations/index.d.ts.map +1 -0
  81. package/resources/operations/fulfillment-recommendations/index.js +9 -0
  82. package/resources/operations/fulfillment-recommendations/index.js.map +1 -0
  83. package/resources/operations/fulfillment-recommendations/index.mjs +4 -0
  84. package/resources/operations/fulfillment-recommendations/index.mjs.map +1 -0
  85. package/resources/operations/fulfillment-recommendations.d.mts +2 -0
  86. package/resources/operations/fulfillment-recommendations.d.mts.map +1 -0
  87. package/resources/operations/fulfillment-recommendations.d.ts +2 -0
  88. package/resources/operations/fulfillment-recommendations.d.ts.map +1 -0
  89. package/resources/operations/fulfillment-recommendations.js +6 -0
  90. package/resources/operations/fulfillment-recommendations.js.map +1 -0
  91. package/resources/operations/fulfillment-recommendations.mjs +3 -0
  92. package/resources/operations/fulfillment-recommendations.mjs.map +1 -0
  93. package/resources/operations/index.d.mts +2 -1
  94. package/resources/operations/index.d.mts.map +1 -1
  95. package/resources/operations/index.d.ts +2 -1
  96. package/resources/operations/index.d.ts.map +1 -1
  97. package/resources/operations/index.js +11 -9
  98. package/resources/operations/index.js.map +1 -1
  99. package/resources/operations/index.mjs +1 -0
  100. package/resources/operations/index.mjs.map +1 -1
  101. package/resources/operations/operations.d.mts +6 -2
  102. package/resources/operations/operations.d.mts.map +1 -1
  103. package/resources/operations/operations.d.ts +6 -2
  104. package/resources/operations/operations.d.ts.map +1 -1
  105. package/resources/operations/operations.js +4 -0
  106. package/resources/operations/operations.js.map +1 -1
  107. package/resources/operations/operations.mjs +4 -0
  108. package/resources/operations/operations.mjs.map +1 -1
  109. package/resources/operations/production-schedule-settings/index.d.mts +1 -0
  110. package/resources/operations/production-schedule-settings/index.d.mts.map +1 -1
  111. package/resources/operations/production-schedule-settings/index.d.ts +1 -0
  112. package/resources/operations/production-schedule-settings/index.d.ts.map +1 -1
  113. package/resources/operations/production-schedule-settings/index.js +3 -1
  114. package/resources/operations/production-schedule-settings/index.js.map +1 -1
  115. package/resources/operations/production-schedule-settings/index.mjs +1 -0
  116. package/resources/operations/production-schedule-settings/index.mjs.map +1 -1
  117. package/resources/operations/production-schedule-settings/items.d.mts +228 -0
  118. package/resources/operations/production-schedule-settings/items.d.mts.map +1 -0
  119. package/resources/operations/production-schedule-settings/items.d.ts +228 -0
  120. package/resources/operations/production-schedule-settings/items.d.ts.map +1 -0
  121. package/resources/operations/production-schedule-settings/items.js +109 -0
  122. package/resources/operations/production-schedule-settings/items.js.map +1 -0
  123. package/resources/operations/production-schedule-settings/items.mjs +105 -0
  124. package/resources/operations/production-schedule-settings/items.mjs.map +1 -0
  125. package/resources/operations/production-schedule-settings/production-schedule-settings.d.mts +60 -0
  126. package/resources/operations/production-schedule-settings/production-schedule-settings.d.mts.map +1 -1
  127. package/resources/operations/production-schedule-settings/production-schedule-settings.d.ts +60 -0
  128. package/resources/operations/production-schedule-settings/production-schedule-settings.d.ts.map +1 -1
  129. package/resources/operations/production-schedule-settings/production-schedule-settings.js +6 -0
  130. package/resources/operations/production-schedule-settings/production-schedule-settings.js.map +1 -1
  131. package/resources/operations/production-schedule-settings/production-schedule-settings.mjs +6 -0
  132. package/resources/operations/production-schedule-settings/production-schedule-settings.mjs.map +1 -1
  133. package/resources/operations/production-schedules/actions.d.mts +117 -1
  134. package/resources/operations/production-schedules/actions.d.mts.map +1 -1
  135. package/resources/operations/production-schedules/actions.d.ts +117 -1
  136. package/resources/operations/production-schedules/actions.d.ts.map +1 -1
  137. package/resources/operations/production-schedules/actions.js +34 -0
  138. package/resources/operations/production-schedules/actions.js.map +1 -1
  139. package/resources/operations/production-schedules/actions.mjs +34 -0
  140. package/resources/operations/production-schedules/actions.mjs.map +1 -1
  141. package/resources/operations/production-schedules/index.d.mts +2 -2
  142. package/resources/operations/production-schedules/index.d.mts.map +1 -1
  143. package/resources/operations/production-schedules/index.d.ts +2 -2
  144. package/resources/operations/production-schedules/index.d.ts.map +1 -1
  145. package/resources/operations/production-schedules/index.js.map +1 -1
  146. package/resources/operations/production-schedules/index.mjs.map +1 -1
  147. package/resources/operations/production-schedules/production-schedules.d.mts +260 -3
  148. package/resources/operations/production-schedules/production-schedules.d.mts.map +1 -1
  149. package/resources/operations/production-schedules/production-schedules.d.ts +260 -3
  150. package/resources/operations/production-schedules/production-schedules.d.ts.map +1 -1
  151. package/resources/operations/production-schedules/production-schedules.js +29 -0
  152. package/resources/operations/production-schedules/production-schedules.js.map +1 -1
  153. package/resources/operations/production-schedules/production-schedules.mjs +29 -0
  154. package/resources/operations/production-schedules/production-schedules.mjs.map +1 -1
  155. package/resources/sales/account-groups.d.mts +27 -0
  156. package/resources/sales/account-groups.d.mts.map +1 -1
  157. package/resources/sales/account-groups.d.ts +27 -0
  158. package/resources/sales/account-groups.d.ts.map +1 -1
  159. package/resources/sales/customers/customers.d.mts +108 -1
  160. package/resources/sales/customers/customers.d.mts.map +1 -1
  161. package/resources/sales/customers/customers.d.ts +108 -1
  162. package/resources/sales/customers/customers.d.ts.map +1 -1
  163. package/resources/sales/customers/customers.js +27 -0
  164. package/resources/sales/customers/customers.js.map +1 -1
  165. package/resources/sales/customers/customers.mjs +27 -0
  166. package/resources/sales/customers/customers.mjs.map +1 -1
  167. package/resources/sales/customers/index.d.mts +1 -1
  168. package/resources/sales/customers/index.d.mts.map +1 -1
  169. package/resources/sales/customers/index.d.ts +1 -1
  170. package/resources/sales/customers/index.d.ts.map +1 -1
  171. package/resources/sales/customers/index.js.map +1 -1
  172. package/resources/sales/customers/index.mjs.map +1 -1
  173. package/resources/sales/index.d.mts +1 -1
  174. package/resources/sales/index.d.mts.map +1 -1
  175. package/resources/sales/index.d.ts +1 -1
  176. package/resources/sales/index.d.ts.map +1 -1
  177. package/resources/sales/index.js.map +1 -1
  178. package/resources/sales/index.mjs.map +1 -1
  179. package/resources/sales/sales-orders/sales-orders.d.mts +51 -0
  180. package/resources/sales/sales-orders/sales-orders.d.mts.map +1 -1
  181. package/resources/sales/sales-orders/sales-orders.d.ts +51 -0
  182. package/resources/sales/sales-orders/sales-orders.d.ts.map +1 -1
  183. package/resources/sales/sales-orders/sales-orders.js.map +1 -1
  184. package/resources/sales/sales-orders/sales-orders.mjs.map +1 -1
  185. package/resources/sales/sales.d.mts +2 -2
  186. package/resources/sales/sales.d.mts.map +1 -1
  187. package/resources/sales/sales.d.ts +2 -2
  188. package/resources/sales/sales.d.ts.map +1 -1
  189. package/resources/sales/sales.js.map +1 -1
  190. package/resources/sales/sales.mjs.map +1 -1
  191. package/src/resources/catalog/product-lines/product-lines.ts +58 -0
  192. package/src/resources/core/analytics.ts +300 -0
  193. package/src/resources/core/audit-events.ts +40 -0
  194. package/src/resources/core/core.ts +34 -0
  195. package/src/resources/core/index.ts +7 -0
  196. package/src/resources/messaging/conversations/conversations.ts +30 -0
  197. package/src/resources/messaging/conversations/links.ts +20 -0
  198. package/src/resources/messaging/conversations/messages.ts +20 -0
  199. package/src/resources/messaging/notifications/notifications.ts +20 -0
  200. package/src/resources/operations/carriers/service-levels.ts +41 -0
  201. package/src/resources/operations/fulfillment-recommendations/actions.ts +75 -0
  202. package/src/resources/operations/fulfillment-recommendations/fulfillment-recommendations.ts +206 -0
  203. package/src/resources/operations/fulfillment-recommendations/index.ts +8 -0
  204. package/src/resources/operations/fulfillment-recommendations.ts +3 -0
  205. package/src/resources/operations/index.ts +11 -0
  206. package/src/resources/operations/operations.ts +27 -0
  207. package/src/resources/operations/production-schedule-settings/index.ts +8 -0
  208. package/src/resources/operations/production-schedule-settings/items.ts +273 -0
  209. package/src/resources/operations/production-schedule-settings/production-schedule-settings.ts +82 -0
  210. package/src/resources/operations/production-schedules/actions.ts +144 -0
  211. package/src/resources/operations/production-schedules/index.ts +9 -0
  212. package/src/resources/operations/production-schedules/production-schedules.ts +310 -0
  213. package/src/resources/sales/account-groups.ts +32 -0
  214. package/src/resources/sales/customers/customers.ts +122 -0
  215. package/src/resources/sales/customers/index.ts +1 -0
  216. package/src/resources/sales/index.ts +1 -0
  217. package/src/resources/sales/sales-orders/sales-orders.ts +59 -0
  218. package/src/resources/sales/sales.ts +2 -0
  219. package/src/version.ts +1 -1
  220. package/version.d.mts +1 -1
  221. package/version.d.ts +1 -1
  222. package/version.js +1 -1
  223. package/version.mjs +1 -1
@@ -199,6 +199,16 @@ export interface CreateProductLineRequest {
199
199
  * the same way as physical amounts like weights or counts.
200
200
  */
201
201
  default_lot?: QuantityInput;
202
+
203
+ /**
204
+ * How products in this line are produced when they do not say for themselves.
205
+ *
206
+ * - `make_to_stock`: built to the forecast, holding a safety stock against its
207
+ * variability.
208
+ * - `make_to_order`: built only against orders already on the book, holding no
209
+ * buffer.
210
+ */
211
+ fulfillment_policy?: 'make_to_stock' | 'make_to_order';
202
212
  }
203
213
 
204
214
  /**
@@ -279,6 +289,18 @@ export interface ProductLine {
279
289
  */
280
290
  freight_policy: 'free_freight' | 'billed_freight';
281
291
 
292
+ /**
293
+ * How products in this line are produced when they do not say for themselves.
294
+ *
295
+ * - `make_to_stock`: built to the forecast, holding a safety stock against its
296
+ * variability.
297
+ * - `make_to_order`: built only against orders already on the book, holding no
298
+ * buffer.
299
+ *
300
+ * Null falls through to the account default.
301
+ */
302
+ fulfillment_policy: 'make_to_stock' | 'make_to_order' | null;
303
+
282
304
  /**
283
305
  * Display name of the product line.
284
306
  *
@@ -366,6 +388,18 @@ export interface UpdateProductLineRequest {
366
388
  */
367
389
  freight_policy?: 'free_freight' | 'billed_freight';
368
390
 
391
+ /**
392
+ * How products in this line are produced when they do not say for themselves.
393
+ *
394
+ * - `make_to_stock`: built to the forecast, holding a safety stock against its
395
+ * variability.
396
+ * - `make_to_order`: built only against orders already on the book, holding no
397
+ * buffer.
398
+ *
399
+ * Clearing it returns the line's products to the account default.
400
+ */
401
+ fulfillment_policy?: 'make_to_stock' | 'make_to_order' | null;
402
+
369
403
  /**
370
404
  * Display name of the product line.
371
405
  *
@@ -473,6 +507,17 @@ export interface ProductLineCreateParams {
473
507
  * the same way as physical amounts like weights or counts.
474
508
  */
475
509
  default_lot?: QuantityInput;
510
+
511
+ /**
512
+ * Body param: How products in this line are produced when they do not say for
513
+ * themselves.
514
+ *
515
+ * - `make_to_stock`: built to the forecast, holding a safety stock against its
516
+ * variability.
517
+ * - `make_to_order`: built only against orders already on the book, holding no
518
+ * buffer.
519
+ */
520
+ fulfillment_policy?: 'make_to_stock' | 'make_to_order';
476
521
  }
477
522
 
478
523
  export interface ProductLineUpdateParams {
@@ -508,6 +553,19 @@ export interface ProductLineUpdateParams {
508
553
  */
509
554
  freight_policy?: 'free_freight' | 'billed_freight';
510
555
 
556
+ /**
557
+ * Body param: How products in this line are produced when they do not say for
558
+ * themselves.
559
+ *
560
+ * - `make_to_stock`: built to the forecast, holding a safety stock against its
561
+ * variability.
562
+ * - `make_to_order`: built only against orders already on the book, holding no
563
+ * buffer.
564
+ *
565
+ * Clearing it returns the line's products to the account default.
566
+ */
567
+ fulfillment_policy?: 'make_to_stock' | 'make_to_order' | null;
568
+
511
569
  /**
512
570
  * Body param: Display name of the product line.
513
571
  *
@@ -101,6 +101,107 @@ export class Analytics extends APIResource {
101
101
  ): APIPromise<AnalyzeScheduleAttainmentResponse> {
102
102
  return this._client.put('/v1/core/analytics/schedule-attainment', { body, ...options });
103
103
  }
104
+
105
+ /**
106
+ * Returns how reliably promised delivery dates were met.
107
+ *
108
+ * Orders are counted in the period their promise came due, not the period they
109
+ * shipped — an order promised in March and shipped in May is March's miss. On time
110
+ * means the first shipment left on or before the promised date, because the
111
+ * promise is that the order starts moving by then; judging on the last shipment
112
+ * would fail an order the customer received on time in two boxes. On time in full
113
+ * adds that the whole ordered quantity was packed.
114
+ *
115
+ * The denominator is orders that were due, not orders that shipped, so an order
116
+ * past its date and still unshipped counts against the rate rather than being held
117
+ * back until it moves. Excluding open orders would let a plant with a growing late
118
+ * backlog report perfect delivery.
119
+ *
120
+ * Only orders carrying a ship-by commitment participate. An order with no
121
+ * commitment cannot be late, and counting it as on time would inflate the rate
122
+ * with orders nobody promised anything about — `uncommitted_order_count` says how
123
+ * many were excluded, so the gap is visible rather than silent.
124
+ *
125
+ * Every rate is null rather than zero when nothing was due, and average lateness
126
+ * is measured over late orders only.
127
+ *
128
+ * This endpoint requires the permission: `sales_orders:read`.
129
+ *
130
+ * @example
131
+ * ```ts
132
+ * const analyzeDeliveryPerformanceResponse =
133
+ * await client.core.analytics.updateDeliveryPerformance({
134
+ * ends_at: '2026-05-10T00:23:00Z',
135
+ * starts_at: '2026-05-10T00:00:00Z',
136
+ * granularity: 'week',
137
+ * });
138
+ * ```
139
+ */
140
+ updateDeliveryPerformance(
141
+ body: AnalyticsUpdateDeliveryPerformanceParams,
142
+ options?: RequestOptions,
143
+ ): APIPromise<AnalyzeDeliveryPerformanceResponse> {
144
+ return this._client.put('/v1/core/analytics/delivery-performance', { body, ...options });
145
+ }
146
+ }
147
+
148
+ /**
149
+ * AnalyzeDeliveryPerformanceRequest is the request to measure promises against
150
+ * shipments.
151
+ */
152
+ export interface AnalyzeDeliveryPerformanceRequest {
153
+ /**
154
+ * The end date for the analysis period.
155
+ */
156
+ ends_at: string;
157
+
158
+ /**
159
+ * The start date for the analysis period.
160
+ */
161
+ starts_at: string;
162
+
163
+ /**
164
+ * The period to break the results down by. Defaults to `week`.
165
+ */
166
+ granularity?: 'day' | 'week' | 'month';
167
+ }
168
+
169
+ /**
170
+ * How reliably promised delivery dates were met.
171
+ */
172
+ export interface AnalyzeDeliveryPerformanceResponse {
173
+ /**
174
+ * A single page of resources, together with the metadata needed to page through
175
+ * the rest of the result set.
176
+ */
177
+ backlog: ListDeliveryBacklogBucket | null;
178
+
179
+ /**
180
+ * Resource type identifier.
181
+ */
182
+ object: 'analyze_delivery_performance_response';
183
+
184
+ /**
185
+ * Delivery reliability for one period, or for a whole window.
186
+ */
187
+ overall: DeliveryPerformance | null;
188
+
189
+ /**
190
+ * A single page of resources, together with the metadata needed to page through
191
+ * the rest of the result set.
192
+ */
193
+ periods: ListDeliveryPerformance | null;
194
+
195
+ /**
196
+ * Issued orders in the window carrying no ship-by date, excluded from every rate
197
+ * above.
198
+ *
199
+ * Reported so the exclusion is visible: a delivery score computed over half the
200
+ * order book, silently, is worse than one that says which half. A non-zero count
201
+ * here means orders placed before commitments were tracked still need a ship-by
202
+ * date.
203
+ */
204
+ uncommitted_order_count: number;
104
205
  }
105
206
 
106
207
  /**
@@ -354,6 +455,127 @@ export interface AttainmentBucket {
354
455
  week_starts_at: string | null;
355
456
  }
356
457
 
458
+ /**
459
+ * One age band of orders past their promise and still unshipped.
460
+ */
461
+ export interface DeliveryBacklogBucket {
462
+ /**
463
+ * Name of the band.
464
+ */
465
+ label: string;
466
+
467
+ /**
468
+ * Upper bound in days late; `0` means unbounded.
469
+ */
470
+ max_days_late: number;
471
+
472
+ /**
473
+ * Lower bound of the band in days late.
474
+ */
475
+ min_days_late: number;
476
+
477
+ /**
478
+ * Resource type identifier.
479
+ */
480
+ object: 'delivery_backlog_bucket';
481
+
482
+ /**
483
+ * Orders in the band.
484
+ */
485
+ order_count: number;
486
+
487
+ /**
488
+ * Quantity still owed across them, which is what remains unpacked rather than what
489
+ * was ordered.
490
+ */
491
+ units: number;
492
+ }
493
+
494
+ /**
495
+ * Delivery reliability for one period, or for a whole window.
496
+ */
497
+ export interface DeliveryPerformance {
498
+ /**
499
+ * Average lead time these orders were promised.
500
+ *
501
+ * The gap between this and `average_lead_time_days` is what a lead time is
502
+ * renegotiated on.
503
+ */
504
+ average_committed_lead_time_days: number | null;
505
+
506
+ /**
507
+ * Average days late, over late orders only.
508
+ *
509
+ * Averaging over every order would dilute a real problem into a number that looks
510
+ * fine.
511
+ */
512
+ average_days_late: number | null;
513
+
514
+ /**
515
+ * Average days from issue to first shipment, over orders that have shipped.
516
+ */
517
+ average_lead_time_days: number | null;
518
+
519
+ /**
520
+ * Orders whose promised ship date fell in this period.
521
+ *
522
+ * This is the denominator for both rates below — orders that were due, not orders
523
+ * that shipped. Measuring against shipments only would let unshipped late orders
524
+ * disappear from the score.
525
+ */
526
+ committed_order_count: number;
527
+
528
+ /**
529
+ * How many shipped late, plus those already past their date and still unshipped.
530
+ */
531
+ late_order_count: number;
532
+
533
+ /**
534
+ * How many due in this period have not shipped at all.
535
+ *
536
+ * These count against on-time: a promise not yet met is not a promise kept.
537
+ */
538
+ not_yet_shipped_count: number;
539
+
540
+ /**
541
+ * Resource type identifier.
542
+ */
543
+ object: 'delivery_performance';
544
+
545
+ /**
546
+ * How many shipped on time and complete.
547
+ */
548
+ on_time_in_full_count: number;
549
+
550
+ /**
551
+ * Share of due orders that shipped on time and complete, as a percentage.
552
+ */
553
+ on_time_in_full_pct: number | null;
554
+
555
+ /**
556
+ * How many shipped on or before the promised date.
557
+ */
558
+ on_time_order_count: number;
559
+
560
+ /**
561
+ * Share of due orders that shipped on time, as a percentage.
562
+ *
563
+ * Null rather than zero when nothing was due, so a quiet week does not render as
564
+ * total failure.
565
+ */
566
+ on_time_pct: number | null;
567
+
568
+ /**
569
+ * First day of the period; absent on the overall figure.
570
+ */
571
+ period_start: string | null;
572
+
573
+ /**
574
+ * How many of them have shipped at all.
575
+ */
576
+ shipped_order_count: number;
577
+ }
578
+
357
579
  /**
358
580
  * How well a published commitment survived the week it covered.
359
581
  */
@@ -436,6 +658,60 @@ export interface ListAttainmentBucket {
436
658
  page_info: APIKeysAPI.PageInfo;
437
659
  }
438
660
 
661
+ /**
662
+ * A single page of resources, together with the metadata needed to page through
663
+ * the rest of the result set.
664
+ */
665
+ export interface ListDeliveryBacklogBucket {
666
+ /**
667
+ * Resources in this page.
668
+ */
669
+ data: Array<DeliveryBacklogBucket>;
670
+
671
+ /**
672
+ * Resource type identifier.
673
+ */
674
+ object: 'list';
675
+
676
+ /**
677
+ * PageInfo describes where the current page sits within a paginated result set and
678
+ * how to move to the adjacent pages.
679
+ *
680
+ * Page a list by following the URLs below rather than assembling cursors yourself.
681
+ * For a top-level list endpoint the URL repeats the original request's query
682
+ * string with only the cursor swapped, so following it preserves the same filters,
683
+ * search term, and page size.
684
+ */
685
+ page_info: APIKeysAPI.PageInfo;
686
+ }
687
+
688
+ /**
689
+ * A single page of resources, together with the metadata needed to page through
690
+ * the rest of the result set.
691
+ */
692
+ export interface ListDeliveryPerformance {
693
+ /**
694
+ * Resources in this page.
695
+ */
696
+ data: Array<DeliveryPerformance>;
697
+
698
+ /**
699
+ * Resource type identifier.
700
+ */
701
+ object: 'list';
702
+
703
+ /**
704
+ * PageInfo describes where the current page sits within a paginated result set and
705
+ * how to move to the adjacent pages.
706
+ *
707
+ * Page a list by following the URLs below rather than assembling cursors yourself.
708
+ * For a top-level list endpoint the URL repeats the original request's query
709
+ * string with only the cursor swapped, so following it preserves the same filters,
710
+ * search term, and page size.
711
+ */
712
+ page_info: APIKeysAPI.PageInfo;
713
+ }
714
+
439
715
  /**
440
716
  * A single page of resources, together with the metadata needed to page through
441
717
  * the rest of the result set.
@@ -871,8 +1147,27 @@ export interface AnalyticsUpdateScheduleAttainmentParams {
871
1147
  machine_ids?: Array<string>;
872
1148
  }
873
1149
 
1150
+ export interface AnalyticsUpdateDeliveryPerformanceParams {
1151
+ /**
1152
+ * The end date for the analysis period.
1153
+ */
1154
+ ends_at: string;
1155
+
1156
+ /**
1157
+ * The start date for the analysis period.
1158
+ */
1159
+ starts_at: string;
1160
+
1161
+ /**
1162
+ * The period to break the results down by. Defaults to `week`.
1163
+ */
1164
+ granularity?: 'day' | 'week' | 'month';
1165
+ }
1166
+
874
1167
  export declare namespace Analytics {
875
1168
  export {
1169
+ type AnalyzeDeliveryPerformanceRequest as AnalyzeDeliveryPerformanceRequest,
1170
+ type AnalyzeDeliveryPerformanceResponse as AnalyzeDeliveryPerformanceResponse,
876
1171
  type AnalyzeOeeRequest as AnalyzeOeeRequest,
877
1172
  type AnalyzeOeeResponse as AnalyzeOeeResponse,
878
1173
  type AnalyzeOeeTrendRequest as AnalyzeOeeTrendRequest,
@@ -880,8 +1175,12 @@ export declare namespace Analytics {
880
1175
  type AnalyzeScheduleAttainmentRequest as AnalyzeScheduleAttainmentRequest,
881
1176
  type AnalyzeScheduleAttainmentResponse as AnalyzeScheduleAttainmentResponse,
882
1177
  type AttainmentBucket as AttainmentBucket,
1178
+ type DeliveryBacklogBucket as DeliveryBacklogBucket,
1179
+ type DeliveryPerformance as DeliveryPerformance,
883
1180
  type FrozenAdherence as FrozenAdherence,
884
1181
  type ListAttainmentBucket as ListAttainmentBucket,
1182
+ type ListDeliveryBacklogBucket as ListDeliveryBacklogBucket,
1183
+ type ListDeliveryPerformance as ListDeliveryPerformance,
885
1184
  type ListFrozenAdherence as ListFrozenAdherence,
886
1185
  type ListOeeDepartment as ListOeeDepartment,
887
1186
  type ListOeeDowntimeReason as ListOeeDowntimeReason,
@@ -893,5 +1192,6 @@ export declare namespace Analytics {
893
1192
  type AnalyticsUpdateOeeParams as AnalyticsUpdateOeeParams,
894
1193
  type AnalyticsUpdateOeeTrendParams as AnalyticsUpdateOeeTrendParams,
895
1194
  type AnalyticsUpdateScheduleAttainmentParams as AnalyticsUpdateScheduleAttainmentParams,
1195
+ type AnalyticsUpdateDeliveryPerformanceParams as AnalyticsUpdateDeliveryPerformanceParams,
896
1196
  };
897
1197
  }
@@ -289,7 +289,16 @@ export interface AuditEvent {
289
289
  | 'production_schedule_derived_line'
290
290
  | 'production_schedule_settings'
291
291
  | 'production_schedule_resource_setting'
292
+ | 'production_schedule_item_setting'
293
+ | 'fulfillment_recommendation'
294
+ | 'analyze_delivery_performance_response'
295
+ | 'delivery_performance'
296
+ | 'delivery_backlog_bucket'
297
+ | 'schedule_order_coverage'
298
+ | 'schedule_order_coverage_line'
299
+ | 'promise_date_quote'
292
300
  | 'schedule_deviation_type'
301
+ | 'schedule_at_risk_order'
293
302
  | 'production_schedule_finished_policy'
294
303
  | 'production_schedule_week_release'
295
304
  | 'production_schedule_week_release_preview'
@@ -362,6 +371,7 @@ export interface AuditEvent {
362
371
  | 'customer_contact_info'
363
372
  | 'customer_freight_preferences'
364
373
  | 'customer_defaults'
374
+ | 'customer_lead_time'
365
375
  | 'customer_notification_preferences'
366
376
  | 'order_notification_recipient'
367
377
  | 'order_discount'
@@ -673,7 +683,16 @@ export interface ListObjectType {
673
683
  | 'production_schedule_derived_line'
674
684
  | 'production_schedule_settings'
675
685
  | 'production_schedule_resource_setting'
686
+ | 'production_schedule_item_setting'
687
+ | 'fulfillment_recommendation'
688
+ | 'analyze_delivery_performance_response'
689
+ | 'delivery_performance'
690
+ | 'delivery_backlog_bucket'
691
+ | 'schedule_order_coverage'
692
+ | 'schedule_order_coverage_line'
693
+ | 'promise_date_quote'
676
694
  | 'schedule_deviation_type'
695
+ | 'schedule_at_risk_order'
677
696
  | 'production_schedule_finished_policy'
678
697
  | 'production_schedule_week_release'
679
698
  | 'production_schedule_week_release_preview'
@@ -746,6 +765,7 @@ export interface ListObjectType {
746
765
  | 'customer_contact_info'
747
766
  | 'customer_freight_preferences'
748
767
  | 'customer_defaults'
768
+ | 'customer_lead_time'
749
769
  | 'customer_notification_preferences'
750
770
  | 'order_notification_recipient'
751
771
  | 'order_discount'
@@ -1045,7 +1065,16 @@ export interface AuditEventListParams {
1045
1065
  | 'production_schedule_derived_line'
1046
1066
  | 'production_schedule_settings'
1047
1067
  | 'production_schedule_resource_setting'
1068
+ | 'production_schedule_item_setting'
1069
+ | 'fulfillment_recommendation'
1070
+ | 'analyze_delivery_performance_response'
1071
+ | 'delivery_performance'
1072
+ | 'delivery_backlog_bucket'
1073
+ | 'schedule_order_coverage'
1074
+ | 'schedule_order_coverage_line'
1075
+ | 'promise_date_quote'
1048
1076
  | 'schedule_deviation_type'
1077
+ | 'schedule_at_risk_order'
1049
1078
  | 'production_schedule_finished_policy'
1050
1079
  | 'production_schedule_week_release'
1051
1080
  | 'production_schedule_week_release_preview'
@@ -1118,6 +1147,7 @@ export interface AuditEventListParams {
1118
1147
  | 'customer_contact_info'
1119
1148
  | 'customer_freight_preferences'
1120
1149
  | 'customer_defaults'
1150
+ | 'customer_lead_time'
1121
1151
  | 'customer_notification_preferences'
1122
1152
  | 'order_notification_recipient'
1123
1153
  | 'order_discount'
@@ -1340,7 +1370,16 @@ export interface AuditEventListParams {
1340
1370
  | 'production_schedule_derived_line'
1341
1371
  | 'production_schedule_settings'
1342
1372
  | 'production_schedule_resource_setting'
1373
+ | 'production_schedule_item_setting'
1374
+ | 'fulfillment_recommendation'
1375
+ | 'analyze_delivery_performance_response'
1376
+ | 'delivery_performance'
1377
+ | 'delivery_backlog_bucket'
1378
+ | 'schedule_order_coverage'
1379
+ | 'schedule_order_coverage_line'
1380
+ | 'promise_date_quote'
1343
1381
  | 'schedule_deviation_type'
1382
+ | 'schedule_at_risk_order'
1344
1383
  | 'production_schedule_finished_policy'
1345
1384
  | 'production_schedule_week_release'
1346
1385
  | 'production_schedule_week_release_preview'
@@ -1413,6 +1452,7 @@ export interface AuditEventListParams {
1413
1452
  | 'customer_contact_info'
1414
1453
  | 'customer_freight_preferences'
1415
1454
  | 'customer_defaults'
1455
+ | 'customer_lead_time'
1416
1456
  | 'customer_notification_preferences'
1417
1457
  | 'order_notification_recipient'
1418
1458
  | 'order_discount'
@@ -4,9 +4,12 @@ import { APIResource } from '../../core/resource';
4
4
  import * as AnalyticsAPI from './analytics';
5
5
  import {
6
6
  Analytics,
7
+ AnalyticsUpdateDeliveryPerformanceParams,
7
8
  AnalyticsUpdateOeeParams,
8
9
  AnalyticsUpdateOeeTrendParams,
9
10
  AnalyticsUpdateScheduleAttainmentParams,
11
+ AnalyzeDeliveryPerformanceRequest,
12
+ AnalyzeDeliveryPerformanceResponse,
10
13
  AnalyzeOeeRequest,
11
14
  AnalyzeOeeResponse,
12
15
  AnalyzeOeeTrendRequest,
@@ -14,8 +17,12 @@ import {
14
17
  AnalyzeScheduleAttainmentRequest,
15
18
  AnalyzeScheduleAttainmentResponse,
16
19
  AttainmentBucket,
20
+ DeliveryBacklogBucket,
21
+ DeliveryPerformance,
17
22
  FrozenAdherence,
18
23
  ListAttainmentBucket,
24
+ ListDeliveryBacklogBucket,
25
+ ListDeliveryPerformance,
19
26
  ListFrozenAdherence,
20
27
  ListOeeDepartment,
21
28
  ListOeeDowntimeReason,
@@ -258,7 +265,16 @@ export interface Entity {
258
265
  | 'production_schedule_derived_line'
259
266
  | 'production_schedule_settings'
260
267
  | 'production_schedule_resource_setting'
268
+ | 'production_schedule_item_setting'
269
+ | 'fulfillment_recommendation'
270
+ | 'analyze_delivery_performance_response'
271
+ | 'delivery_performance'
272
+ | 'delivery_backlog_bucket'
273
+ | 'schedule_order_coverage'
274
+ | 'schedule_order_coverage_line'
275
+ | 'promise_date_quote'
261
276
  | 'schedule_deviation_type'
277
+ | 'schedule_at_risk_order'
262
278
  | 'production_schedule_finished_policy'
263
279
  | 'production_schedule_week_release'
264
280
  | 'production_schedule_week_release_preview'
@@ -331,6 +347,7 @@ export interface Entity {
331
347
  | 'customer_contact_info'
332
348
  | 'customer_freight_preferences'
333
349
  | 'customer_defaults'
350
+ | 'customer_lead_time'
334
351
  | 'customer_notification_preferences'
335
352
  | 'order_notification_recipient'
336
353
  | 'order_discount'
@@ -608,7 +625,16 @@ export interface CoreRetrieveSearchParams {
608
625
  | 'production_schedule_derived_line'
609
626
  | 'production_schedule_settings'
610
627
  | 'production_schedule_resource_setting'
628
+ | 'production_schedule_item_setting'
629
+ | 'fulfillment_recommendation'
630
+ | 'analyze_delivery_performance_response'
631
+ | 'delivery_performance'
632
+ | 'delivery_backlog_bucket'
633
+ | 'schedule_order_coverage'
634
+ | 'schedule_order_coverage_line'
635
+ | 'promise_date_quote'
611
636
  | 'schedule_deviation_type'
637
+ | 'schedule_at_risk_order'
612
638
  | 'production_schedule_finished_policy'
613
639
  | 'production_schedule_week_release'
614
640
  | 'production_schedule_week_release_preview'
@@ -681,6 +707,7 @@ export interface CoreRetrieveSearchParams {
681
707
  | 'customer_contact_info'
682
708
  | 'customer_freight_preferences'
683
709
  | 'customer_defaults'
710
+ | 'customer_lead_time'
684
711
  | 'customer_notification_preferences'
685
712
  | 'order_notification_recipient'
686
713
  | 'order_discount'
@@ -852,6 +879,8 @@ export declare namespace Core {
852
879
 
853
880
  export {
854
881
  Analytics as Analytics,
882
+ type AnalyzeDeliveryPerformanceRequest as AnalyzeDeliveryPerformanceRequest,
883
+ type AnalyzeDeliveryPerformanceResponse as AnalyzeDeliveryPerformanceResponse,
855
884
  type AnalyzeOeeRequest as AnalyzeOeeRequest,
856
885
  type AnalyzeOeeResponse as AnalyzeOeeResponse,
857
886
  type AnalyzeOeeTrendRequest as AnalyzeOeeTrendRequest,
@@ -859,8 +888,12 @@ export declare namespace Core {
859
888
  type AnalyzeScheduleAttainmentRequest as AnalyzeScheduleAttainmentRequest,
860
889
  type AnalyzeScheduleAttainmentResponse as AnalyzeScheduleAttainmentResponse,
861
890
  type AttainmentBucket as AttainmentBucket,
891
+ type DeliveryBacklogBucket as DeliveryBacklogBucket,
892
+ type DeliveryPerformance as DeliveryPerformance,
862
893
  type FrozenAdherence as FrozenAdherence,
863
894
  type ListAttainmentBucket as ListAttainmentBucket,
895
+ type ListDeliveryBacklogBucket as ListDeliveryBacklogBucket,
896
+ type ListDeliveryPerformance as ListDeliveryPerformance,
864
897
  type ListFrozenAdherence as ListFrozenAdherence,
865
898
  type ListOeeDepartment as ListOeeDepartment,
866
899
  type ListOeeDowntimeReason as ListOeeDowntimeReason,
@@ -872,5 +905,6 @@ export declare namespace Core {
872
905
  type AnalyticsUpdateOeeParams as AnalyticsUpdateOeeParams,
873
906
  type AnalyticsUpdateOeeTrendParams as AnalyticsUpdateOeeTrendParams,
874
907
  type AnalyticsUpdateScheduleAttainmentParams as AnalyticsUpdateScheduleAttainmentParams,
908
+ type AnalyticsUpdateDeliveryPerformanceParams as AnalyticsUpdateDeliveryPerformanceParams,
875
909
  };
876
910
  }
@@ -8,6 +8,8 @@ export {
8
8
  } from './addresses/index';
9
9
  export {
10
10
  Analytics,
11
+ type AnalyzeDeliveryPerformanceRequest,
12
+ type AnalyzeDeliveryPerformanceResponse,
11
13
  type AnalyzeOeeRequest,
12
14
  type AnalyzeOeeResponse,
13
15
  type AnalyzeOeeTrendRequest,
@@ -15,8 +17,12 @@ export {
15
17
  type AnalyzeScheduleAttainmentRequest,
16
18
  type AnalyzeScheduleAttainmentResponse,
17
19
  type AttainmentBucket,
20
+ type DeliveryBacklogBucket,
21
+ type DeliveryPerformance,
18
22
  type FrozenAdherence,
19
23
  type ListAttainmentBucket,
24
+ type ListDeliveryBacklogBucket,
25
+ type ListDeliveryPerformance,
20
26
  type ListFrozenAdherence,
21
27
  type ListOeeDepartment,
22
28
  type ListOeeDowntimeReason,
@@ -28,6 +34,7 @@ export {
28
34
  type AnalyticsUpdateOeeParams,
29
35
  type AnalyticsUpdateOeeTrendParams,
30
36
  type AnalyticsUpdateScheduleAttainmentParams,
37
+ type AnalyticsUpdateDeliveryPerformanceParams,
31
38
  } from './analytics';
32
39
  export {
33
40
  AuditEvents,