@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.
- package/CHANGELOG.md +3 -3
- package/package.json +1 -1
- package/resources/catalog/product-lines/product-lines.d.mts +53 -0
- package/resources/catalog/product-lines/product-lines.d.mts.map +1 -1
- package/resources/catalog/product-lines/product-lines.d.ts +53 -0
- package/resources/catalog/product-lines/product-lines.d.ts.map +1 -1
- package/resources/catalog/product-lines/product-lines.js.map +1 -1
- package/resources/catalog/product-lines/product-lines.mjs.map +1 -1
- package/resources/core/analytics.d.mts +252 -1
- package/resources/core/analytics.d.mts.map +1 -1
- package/resources/core/analytics.d.ts +252 -1
- package/resources/core/analytics.d.ts.map +1 -1
- package/resources/core/analytics.js +38 -0
- package/resources/core/analytics.js.map +1 -1
- package/resources/core/analytics.mjs +38 -0
- package/resources/core/analytics.mjs.map +1 -1
- package/resources/core/audit-events.d.mts +4 -4
- package/resources/core/audit-events.d.mts.map +1 -1
- package/resources/core/audit-events.d.ts +4 -4
- package/resources/core/audit-events.d.ts.map +1 -1
- package/resources/core/core.d.mts +4 -4
- package/resources/core/core.d.mts.map +1 -1
- package/resources/core/core.d.ts +4 -4
- package/resources/core/core.d.ts.map +1 -1
- package/resources/core/core.js.map +1 -1
- package/resources/core/core.mjs.map +1 -1
- package/resources/core/index.d.mts +1 -1
- package/resources/core/index.d.mts.map +1 -1
- package/resources/core/index.d.ts +1 -1
- package/resources/core/index.d.ts.map +1 -1
- package/resources/core/index.js.map +1 -1
- package/resources/core/index.mjs.map +1 -1
- package/resources/messaging/conversations/conversations.d.mts +3 -3
- package/resources/messaging/conversations/conversations.d.mts.map +1 -1
- package/resources/messaging/conversations/conversations.d.ts +3 -3
- package/resources/messaging/conversations/conversations.d.ts.map +1 -1
- package/resources/messaging/conversations/conversations.js.map +1 -1
- package/resources/messaging/conversations/conversations.mjs.map +1 -1
- package/resources/messaging/conversations/links.d.mts +2 -2
- package/resources/messaging/conversations/links.d.mts.map +1 -1
- package/resources/messaging/conversations/links.d.ts +2 -2
- package/resources/messaging/conversations/links.d.ts.map +1 -1
- package/resources/messaging/conversations/messages.d.mts +2 -2
- package/resources/messaging/conversations/messages.d.mts.map +1 -1
- package/resources/messaging/conversations/messages.d.ts +2 -2
- package/resources/messaging/conversations/messages.d.ts.map +1 -1
- package/resources/messaging/notifications/notifications.d.mts +2 -2
- package/resources/messaging/notifications/notifications.d.mts.map +1 -1
- package/resources/messaging/notifications/notifications.d.ts +2 -2
- package/resources/messaging/notifications/notifications.d.ts.map +1 -1
- package/resources/messaging/notifications/notifications.js.map +1 -1
- package/resources/messaging/notifications/notifications.mjs.map +1 -1
- package/resources/operations/carriers/service-levels.d.mts +37 -0
- package/resources/operations/carriers/service-levels.d.mts.map +1 -1
- package/resources/operations/carriers/service-levels.d.ts +37 -0
- package/resources/operations/carriers/service-levels.d.ts.map +1 -1
- package/resources/operations/carriers/service-levels.js +1 -0
- package/resources/operations/carriers/service-levels.js.map +1 -1
- package/resources/operations/carriers/service-levels.mjs +1 -0
- package/resources/operations/carriers/service-levels.mjs.map +1 -1
- package/resources/operations/fulfillment-recommendations/actions.d.mts +59 -0
- package/resources/operations/fulfillment-recommendations/actions.d.mts.map +1 -0
- package/resources/operations/fulfillment-recommendations/actions.d.ts +59 -0
- package/resources/operations/fulfillment-recommendations/actions.d.ts.map +1 -0
- package/resources/operations/fulfillment-recommendations/actions.js +40 -0
- package/resources/operations/fulfillment-recommendations/actions.js.map +1 -0
- package/resources/operations/fulfillment-recommendations/actions.mjs +36 -0
- package/resources/operations/fulfillment-recommendations/actions.mjs.map +1 -0
- package/resources/operations/fulfillment-recommendations/fulfillment-recommendations.d.mts +165 -0
- package/resources/operations/fulfillment-recommendations/fulfillment-recommendations.d.mts.map +1 -0
- package/resources/operations/fulfillment-recommendations/fulfillment-recommendations.d.ts +165 -0
- package/resources/operations/fulfillment-recommendations/fulfillment-recommendations.d.ts.map +1 -0
- package/resources/operations/fulfillment-recommendations/fulfillment-recommendations.js +52 -0
- package/resources/operations/fulfillment-recommendations/fulfillment-recommendations.js.map +1 -0
- package/resources/operations/fulfillment-recommendations/fulfillment-recommendations.mjs +47 -0
- package/resources/operations/fulfillment-recommendations/fulfillment-recommendations.mjs.map +1 -0
- package/resources/operations/fulfillment-recommendations/index.d.mts +3 -0
- package/resources/operations/fulfillment-recommendations/index.d.mts.map +1 -0
- package/resources/operations/fulfillment-recommendations/index.d.ts +3 -0
- package/resources/operations/fulfillment-recommendations/index.d.ts.map +1 -0
- package/resources/operations/fulfillment-recommendations/index.js +9 -0
- package/resources/operations/fulfillment-recommendations/index.js.map +1 -0
- package/resources/operations/fulfillment-recommendations/index.mjs +4 -0
- package/resources/operations/fulfillment-recommendations/index.mjs.map +1 -0
- package/resources/operations/fulfillment-recommendations.d.mts +2 -0
- package/resources/operations/fulfillment-recommendations.d.mts.map +1 -0
- package/resources/operations/fulfillment-recommendations.d.ts +2 -0
- package/resources/operations/fulfillment-recommendations.d.ts.map +1 -0
- package/resources/operations/fulfillment-recommendations.js +6 -0
- package/resources/operations/fulfillment-recommendations.js.map +1 -0
- package/resources/operations/fulfillment-recommendations.mjs +3 -0
- package/resources/operations/fulfillment-recommendations.mjs.map +1 -0
- package/resources/operations/index.d.mts +2 -1
- package/resources/operations/index.d.mts.map +1 -1
- package/resources/operations/index.d.ts +2 -1
- package/resources/operations/index.d.ts.map +1 -1
- package/resources/operations/index.js +11 -9
- package/resources/operations/index.js.map +1 -1
- package/resources/operations/index.mjs +1 -0
- package/resources/operations/index.mjs.map +1 -1
- package/resources/operations/operations.d.mts +6 -2
- package/resources/operations/operations.d.mts.map +1 -1
- package/resources/operations/operations.d.ts +6 -2
- package/resources/operations/operations.d.ts.map +1 -1
- package/resources/operations/operations.js +4 -0
- package/resources/operations/operations.js.map +1 -1
- package/resources/operations/operations.mjs +4 -0
- package/resources/operations/operations.mjs.map +1 -1
- package/resources/operations/production-schedule-settings/index.d.mts +1 -0
- package/resources/operations/production-schedule-settings/index.d.mts.map +1 -1
- package/resources/operations/production-schedule-settings/index.d.ts +1 -0
- package/resources/operations/production-schedule-settings/index.d.ts.map +1 -1
- package/resources/operations/production-schedule-settings/index.js +3 -1
- package/resources/operations/production-schedule-settings/index.js.map +1 -1
- package/resources/operations/production-schedule-settings/index.mjs +1 -0
- package/resources/operations/production-schedule-settings/index.mjs.map +1 -1
- package/resources/operations/production-schedule-settings/items.d.mts +228 -0
- package/resources/operations/production-schedule-settings/items.d.mts.map +1 -0
- package/resources/operations/production-schedule-settings/items.d.ts +228 -0
- package/resources/operations/production-schedule-settings/items.d.ts.map +1 -0
- package/resources/operations/production-schedule-settings/items.js +109 -0
- package/resources/operations/production-schedule-settings/items.js.map +1 -0
- package/resources/operations/production-schedule-settings/items.mjs +105 -0
- package/resources/operations/production-schedule-settings/items.mjs.map +1 -0
- package/resources/operations/production-schedule-settings/production-schedule-settings.d.mts +60 -0
- package/resources/operations/production-schedule-settings/production-schedule-settings.d.mts.map +1 -1
- package/resources/operations/production-schedule-settings/production-schedule-settings.d.ts +60 -0
- package/resources/operations/production-schedule-settings/production-schedule-settings.d.ts.map +1 -1
- package/resources/operations/production-schedule-settings/production-schedule-settings.js +6 -0
- package/resources/operations/production-schedule-settings/production-schedule-settings.js.map +1 -1
- package/resources/operations/production-schedule-settings/production-schedule-settings.mjs +6 -0
- package/resources/operations/production-schedule-settings/production-schedule-settings.mjs.map +1 -1
- package/resources/operations/production-schedules/actions.d.mts +117 -1
- package/resources/operations/production-schedules/actions.d.mts.map +1 -1
- package/resources/operations/production-schedules/actions.d.ts +117 -1
- package/resources/operations/production-schedules/actions.d.ts.map +1 -1
- package/resources/operations/production-schedules/actions.js +34 -0
- package/resources/operations/production-schedules/actions.js.map +1 -1
- package/resources/operations/production-schedules/actions.mjs +34 -0
- package/resources/operations/production-schedules/actions.mjs.map +1 -1
- package/resources/operations/production-schedules/index.d.mts +2 -2
- package/resources/operations/production-schedules/index.d.mts.map +1 -1
- package/resources/operations/production-schedules/index.d.ts +2 -2
- package/resources/operations/production-schedules/index.d.ts.map +1 -1
- package/resources/operations/production-schedules/index.js.map +1 -1
- package/resources/operations/production-schedules/index.mjs.map +1 -1
- package/resources/operations/production-schedules/production-schedules.d.mts +260 -3
- package/resources/operations/production-schedules/production-schedules.d.mts.map +1 -1
- package/resources/operations/production-schedules/production-schedules.d.ts +260 -3
- package/resources/operations/production-schedules/production-schedules.d.ts.map +1 -1
- package/resources/operations/production-schedules/production-schedules.js +29 -0
- package/resources/operations/production-schedules/production-schedules.js.map +1 -1
- package/resources/operations/production-schedules/production-schedules.mjs +29 -0
- package/resources/operations/production-schedules/production-schedules.mjs.map +1 -1
- package/resources/sales/account-groups.d.mts +27 -0
- package/resources/sales/account-groups.d.mts.map +1 -1
- package/resources/sales/account-groups.d.ts +27 -0
- package/resources/sales/account-groups.d.ts.map +1 -1
- package/resources/sales/customers/customers.d.mts +108 -1
- package/resources/sales/customers/customers.d.mts.map +1 -1
- package/resources/sales/customers/customers.d.ts +108 -1
- package/resources/sales/customers/customers.d.ts.map +1 -1
- package/resources/sales/customers/customers.js +27 -0
- package/resources/sales/customers/customers.js.map +1 -1
- package/resources/sales/customers/customers.mjs +27 -0
- package/resources/sales/customers/customers.mjs.map +1 -1
- package/resources/sales/customers/index.d.mts +1 -1
- package/resources/sales/customers/index.d.mts.map +1 -1
- package/resources/sales/customers/index.d.ts +1 -1
- package/resources/sales/customers/index.d.ts.map +1 -1
- package/resources/sales/customers/index.js.map +1 -1
- package/resources/sales/customers/index.mjs.map +1 -1
- package/resources/sales/index.d.mts +1 -1
- package/resources/sales/index.d.mts.map +1 -1
- package/resources/sales/index.d.ts +1 -1
- package/resources/sales/index.d.ts.map +1 -1
- package/resources/sales/index.js.map +1 -1
- package/resources/sales/index.mjs.map +1 -1
- package/resources/sales/sales-orders/sales-orders.d.mts +51 -0
- package/resources/sales/sales-orders/sales-orders.d.mts.map +1 -1
- package/resources/sales/sales-orders/sales-orders.d.ts +51 -0
- package/resources/sales/sales-orders/sales-orders.d.ts.map +1 -1
- package/resources/sales/sales-orders/sales-orders.js.map +1 -1
- package/resources/sales/sales-orders/sales-orders.mjs.map +1 -1
- package/resources/sales/sales.d.mts +2 -2
- package/resources/sales/sales.d.mts.map +1 -1
- package/resources/sales/sales.d.ts +2 -2
- package/resources/sales/sales.d.ts.map +1 -1
- package/resources/sales/sales.js.map +1 -1
- package/resources/sales/sales.mjs.map +1 -1
- package/src/resources/catalog/product-lines/product-lines.ts +58 -0
- package/src/resources/core/analytics.ts +300 -0
- package/src/resources/core/audit-events.ts +40 -0
- package/src/resources/core/core.ts +34 -0
- package/src/resources/core/index.ts +7 -0
- package/src/resources/messaging/conversations/conversations.ts +30 -0
- package/src/resources/messaging/conversations/links.ts +20 -0
- package/src/resources/messaging/conversations/messages.ts +20 -0
- package/src/resources/messaging/notifications/notifications.ts +20 -0
- package/src/resources/operations/carriers/service-levels.ts +41 -0
- package/src/resources/operations/fulfillment-recommendations/actions.ts +75 -0
- package/src/resources/operations/fulfillment-recommendations/fulfillment-recommendations.ts +206 -0
- package/src/resources/operations/fulfillment-recommendations/index.ts +8 -0
- package/src/resources/operations/fulfillment-recommendations.ts +3 -0
- package/src/resources/operations/index.ts +11 -0
- package/src/resources/operations/operations.ts +27 -0
- package/src/resources/operations/production-schedule-settings/index.ts +8 -0
- package/src/resources/operations/production-schedule-settings/items.ts +273 -0
- package/src/resources/operations/production-schedule-settings/production-schedule-settings.ts +82 -0
- package/src/resources/operations/production-schedules/actions.ts +144 -0
- package/src/resources/operations/production-schedules/index.ts +9 -0
- package/src/resources/operations/production-schedules/production-schedules.ts +310 -0
- package/src/resources/sales/account-groups.ts +32 -0
- package/src/resources/sales/customers/customers.ts +122 -0
- package/src/resources/sales/customers/index.ts +1 -0
- package/src/resources/sales/index.ts +1 -0
- package/src/resources/sales/sales-orders/sales-orders.ts +59 -0
- package/src/resources/sales/sales.ts +2 -0
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -84,6 +84,93 @@ export declare class Analytics extends APIResource {
|
|
|
84
84
|
* ```
|
|
85
85
|
*/
|
|
86
86
|
updateScheduleAttainment(body: AnalyticsUpdateScheduleAttainmentParams, options?: RequestOptions): APIPromise<AnalyzeScheduleAttainmentResponse>;
|
|
87
|
+
/**
|
|
88
|
+
* Returns how reliably promised delivery dates were met.
|
|
89
|
+
*
|
|
90
|
+
* Orders are counted in the period their promise came due, not the period they
|
|
91
|
+
* shipped — an order promised in March and shipped in May is March's miss. On time
|
|
92
|
+
* means the first shipment left on or before the promised date, because the
|
|
93
|
+
* promise is that the order starts moving by then; judging on the last shipment
|
|
94
|
+
* would fail an order the customer received on time in two boxes. On time in full
|
|
95
|
+
* adds that the whole ordered quantity was packed.
|
|
96
|
+
*
|
|
97
|
+
* The denominator is orders that were due, not orders that shipped, so an order
|
|
98
|
+
* past its date and still unshipped counts against the rate rather than being held
|
|
99
|
+
* back until it moves. Excluding open orders would let a plant with a growing late
|
|
100
|
+
* backlog report perfect delivery.
|
|
101
|
+
*
|
|
102
|
+
* Only orders carrying a ship-by commitment participate. An order with no
|
|
103
|
+
* commitment cannot be late, and counting it as on time would inflate the rate
|
|
104
|
+
* with orders nobody promised anything about — `uncommitted_order_count` says how
|
|
105
|
+
* many were excluded, so the gap is visible rather than silent.
|
|
106
|
+
*
|
|
107
|
+
* Every rate is null rather than zero when nothing was due, and average lateness
|
|
108
|
+
* is measured over late orders only.
|
|
109
|
+
*
|
|
110
|
+
* This endpoint requires the permission: `sales_orders:read`.
|
|
111
|
+
*
|
|
112
|
+
* @example
|
|
113
|
+
* ```ts
|
|
114
|
+
* const analyzeDeliveryPerformanceResponse =
|
|
115
|
+
* await client.core.analytics.updateDeliveryPerformance({
|
|
116
|
+
* ends_at: '2026-05-10T00:23:00Z',
|
|
117
|
+
* starts_at: '2026-05-10T00:00:00Z',
|
|
118
|
+
* granularity: 'week',
|
|
119
|
+
* });
|
|
120
|
+
* ```
|
|
121
|
+
*/
|
|
122
|
+
updateDeliveryPerformance(body: AnalyticsUpdateDeliveryPerformanceParams, options?: RequestOptions): APIPromise<AnalyzeDeliveryPerformanceResponse>;
|
|
123
|
+
}
|
|
124
|
+
/**
|
|
125
|
+
* AnalyzeDeliveryPerformanceRequest is the request to measure promises against
|
|
126
|
+
* shipments.
|
|
127
|
+
*/
|
|
128
|
+
export interface AnalyzeDeliveryPerformanceRequest {
|
|
129
|
+
/**
|
|
130
|
+
* The end date for the analysis period.
|
|
131
|
+
*/
|
|
132
|
+
ends_at: string;
|
|
133
|
+
/**
|
|
134
|
+
* The start date for the analysis period.
|
|
135
|
+
*/
|
|
136
|
+
starts_at: string;
|
|
137
|
+
/**
|
|
138
|
+
* The period to break the results down by. Defaults to `week`.
|
|
139
|
+
*/
|
|
140
|
+
granularity?: 'day' | 'week' | 'month';
|
|
141
|
+
}
|
|
142
|
+
/**
|
|
143
|
+
* How reliably promised delivery dates were met.
|
|
144
|
+
*/
|
|
145
|
+
export interface AnalyzeDeliveryPerformanceResponse {
|
|
146
|
+
/**
|
|
147
|
+
* A single page of resources, together with the metadata needed to page through
|
|
148
|
+
* the rest of the result set.
|
|
149
|
+
*/
|
|
150
|
+
backlog: ListDeliveryBacklogBucket | null;
|
|
151
|
+
/**
|
|
152
|
+
* Resource type identifier.
|
|
153
|
+
*/
|
|
154
|
+
object: 'analyze_delivery_performance_response';
|
|
155
|
+
/**
|
|
156
|
+
* Delivery reliability for one period, or for a whole window.
|
|
157
|
+
*/
|
|
158
|
+
overall: DeliveryPerformance | null;
|
|
159
|
+
/**
|
|
160
|
+
* A single page of resources, together with the metadata needed to page through
|
|
161
|
+
* the rest of the result set.
|
|
162
|
+
*/
|
|
163
|
+
periods: ListDeliveryPerformance | null;
|
|
164
|
+
/**
|
|
165
|
+
* Issued orders in the window carrying no ship-by date, excluded from every rate
|
|
166
|
+
* above.
|
|
167
|
+
*
|
|
168
|
+
* Reported so the exclusion is visible: a delivery score computed over half the
|
|
169
|
+
* order book, silently, is worse than one that says which half. A non-zero count
|
|
170
|
+
* here means orders placed before commitments were tracked still need a ship-by
|
|
171
|
+
* date.
|
|
172
|
+
*/
|
|
173
|
+
uncommitted_order_count: number;
|
|
87
174
|
}
|
|
88
175
|
/**
|
|
89
176
|
* AnalyzeOeeRequest is the request to analyze Overall Equipment Effectiveness
|
|
@@ -298,6 +385,108 @@ export interface AttainmentBucket {
|
|
|
298
385
|
*/
|
|
299
386
|
week_starts_at: string | null;
|
|
300
387
|
}
|
|
388
|
+
/**
|
|
389
|
+
* One age band of orders past their promise and still unshipped.
|
|
390
|
+
*/
|
|
391
|
+
export interface DeliveryBacklogBucket {
|
|
392
|
+
/**
|
|
393
|
+
* Name of the band.
|
|
394
|
+
*/
|
|
395
|
+
label: string;
|
|
396
|
+
/**
|
|
397
|
+
* Upper bound in days late; `0` means unbounded.
|
|
398
|
+
*/
|
|
399
|
+
max_days_late: number;
|
|
400
|
+
/**
|
|
401
|
+
* Lower bound of the band in days late.
|
|
402
|
+
*/
|
|
403
|
+
min_days_late: number;
|
|
404
|
+
/**
|
|
405
|
+
* Resource type identifier.
|
|
406
|
+
*/
|
|
407
|
+
object: 'delivery_backlog_bucket';
|
|
408
|
+
/**
|
|
409
|
+
* Orders in the band.
|
|
410
|
+
*/
|
|
411
|
+
order_count: number;
|
|
412
|
+
/**
|
|
413
|
+
* Quantity still owed across them, which is what remains unpacked rather than what
|
|
414
|
+
* was ordered.
|
|
415
|
+
*/
|
|
416
|
+
units: number;
|
|
417
|
+
}
|
|
418
|
+
/**
|
|
419
|
+
* Delivery reliability for one period, or for a whole window.
|
|
420
|
+
*/
|
|
421
|
+
export interface DeliveryPerformance {
|
|
422
|
+
/**
|
|
423
|
+
* Average lead time these orders were promised.
|
|
424
|
+
*
|
|
425
|
+
* The gap between this and `average_lead_time_days` is what a lead time is
|
|
426
|
+
* renegotiated on.
|
|
427
|
+
*/
|
|
428
|
+
average_committed_lead_time_days: number | null;
|
|
429
|
+
/**
|
|
430
|
+
* Average days late, over late orders only.
|
|
431
|
+
*
|
|
432
|
+
* Averaging over every order would dilute a real problem into a number that looks
|
|
433
|
+
* fine.
|
|
434
|
+
*/
|
|
435
|
+
average_days_late: number | null;
|
|
436
|
+
/**
|
|
437
|
+
* Average days from issue to first shipment, over orders that have shipped.
|
|
438
|
+
*/
|
|
439
|
+
average_lead_time_days: number | null;
|
|
440
|
+
/**
|
|
441
|
+
* Orders whose promised ship date fell in this period.
|
|
442
|
+
*
|
|
443
|
+
* This is the denominator for both rates below — orders that were due, not orders
|
|
444
|
+
* that shipped. Measuring against shipments only would let unshipped late orders
|
|
445
|
+
* disappear from the score.
|
|
446
|
+
*/
|
|
447
|
+
committed_order_count: number;
|
|
448
|
+
/**
|
|
449
|
+
* How many shipped late, plus those already past their date and still unshipped.
|
|
450
|
+
*/
|
|
451
|
+
late_order_count: number;
|
|
452
|
+
/**
|
|
453
|
+
* How many due in this period have not shipped at all.
|
|
454
|
+
*
|
|
455
|
+
* These count against on-time: a promise not yet met is not a promise kept.
|
|
456
|
+
*/
|
|
457
|
+
not_yet_shipped_count: number;
|
|
458
|
+
/**
|
|
459
|
+
* Resource type identifier.
|
|
460
|
+
*/
|
|
461
|
+
object: 'delivery_performance';
|
|
462
|
+
/**
|
|
463
|
+
* How many shipped on time and complete.
|
|
464
|
+
*/
|
|
465
|
+
on_time_in_full_count: number;
|
|
466
|
+
/**
|
|
467
|
+
* Share of due orders that shipped on time and complete, as a percentage.
|
|
468
|
+
*/
|
|
469
|
+
on_time_in_full_pct: number | null;
|
|
470
|
+
/**
|
|
471
|
+
* How many shipped on or before the promised date.
|
|
472
|
+
*/
|
|
473
|
+
on_time_order_count: number;
|
|
474
|
+
/**
|
|
475
|
+
* Share of due orders that shipped on time, as a percentage.
|
|
476
|
+
*
|
|
477
|
+
* Null rather than zero when nothing was due, so a quiet week does not render as
|
|
478
|
+
* total failure.
|
|
479
|
+
*/
|
|
480
|
+
on_time_pct: number | null;
|
|
481
|
+
/**
|
|
482
|
+
* First day of the period; absent on the overall figure.
|
|
483
|
+
*/
|
|
484
|
+
period_start: string | null;
|
|
485
|
+
/**
|
|
486
|
+
* How many of them have shipped at all.
|
|
487
|
+
*/
|
|
488
|
+
shipped_order_count: number;
|
|
489
|
+
}
|
|
301
490
|
/**
|
|
302
491
|
* How well a published commitment survived the week it covered.
|
|
303
492
|
*/
|
|
@@ -367,6 +556,54 @@ export interface ListAttainmentBucket {
|
|
|
367
556
|
*/
|
|
368
557
|
page_info: APIKeysAPI.PageInfo;
|
|
369
558
|
}
|
|
559
|
+
/**
|
|
560
|
+
* A single page of resources, together with the metadata needed to page through
|
|
561
|
+
* the rest of the result set.
|
|
562
|
+
*/
|
|
563
|
+
export interface ListDeliveryBacklogBucket {
|
|
564
|
+
/**
|
|
565
|
+
* Resources in this page.
|
|
566
|
+
*/
|
|
567
|
+
data: Array<DeliveryBacklogBucket>;
|
|
568
|
+
/**
|
|
569
|
+
* Resource type identifier.
|
|
570
|
+
*/
|
|
571
|
+
object: 'list';
|
|
572
|
+
/**
|
|
573
|
+
* PageInfo describes where the current page sits within a paginated result set and
|
|
574
|
+
* how to move to the adjacent pages.
|
|
575
|
+
*
|
|
576
|
+
* Page a list by following the URLs below rather than assembling cursors yourself.
|
|
577
|
+
* For a top-level list endpoint the URL repeats the original request's query
|
|
578
|
+
* string with only the cursor swapped, so following it preserves the same filters,
|
|
579
|
+
* search term, and page size.
|
|
580
|
+
*/
|
|
581
|
+
page_info: APIKeysAPI.PageInfo;
|
|
582
|
+
}
|
|
583
|
+
/**
|
|
584
|
+
* A single page of resources, together with the metadata needed to page through
|
|
585
|
+
* the rest of the result set.
|
|
586
|
+
*/
|
|
587
|
+
export interface ListDeliveryPerformance {
|
|
588
|
+
/**
|
|
589
|
+
* Resources in this page.
|
|
590
|
+
*/
|
|
591
|
+
data: Array<DeliveryPerformance>;
|
|
592
|
+
/**
|
|
593
|
+
* Resource type identifier.
|
|
594
|
+
*/
|
|
595
|
+
object: 'list';
|
|
596
|
+
/**
|
|
597
|
+
* PageInfo describes where the current page sits within a paginated result set and
|
|
598
|
+
* how to move to the adjacent pages.
|
|
599
|
+
*
|
|
600
|
+
* Page a list by following the URLs below rather than assembling cursors yourself.
|
|
601
|
+
* For a top-level list endpoint the URL repeats the original request's query
|
|
602
|
+
* string with only the cursor swapped, so following it preserves the same filters,
|
|
603
|
+
* search term, and page size.
|
|
604
|
+
*/
|
|
605
|
+
page_info: APIKeysAPI.PageInfo;
|
|
606
|
+
}
|
|
370
607
|
/**
|
|
371
608
|
* A single page of resources, together with the metadata needed to page through
|
|
372
609
|
* the rest of the result set.
|
|
@@ -727,7 +964,21 @@ export interface AnalyticsUpdateScheduleAttainmentParams {
|
|
|
727
964
|
*/
|
|
728
965
|
machine_ids?: Array<string>;
|
|
729
966
|
}
|
|
967
|
+
export interface AnalyticsUpdateDeliveryPerformanceParams {
|
|
968
|
+
/**
|
|
969
|
+
* The end date for the analysis period.
|
|
970
|
+
*/
|
|
971
|
+
ends_at: string;
|
|
972
|
+
/**
|
|
973
|
+
* The start date for the analysis period.
|
|
974
|
+
*/
|
|
975
|
+
starts_at: string;
|
|
976
|
+
/**
|
|
977
|
+
* The period to break the results down by. Defaults to `week`.
|
|
978
|
+
*/
|
|
979
|
+
granularity?: 'day' | 'week' | 'month';
|
|
980
|
+
}
|
|
730
981
|
export declare namespace Analytics {
|
|
731
|
-
export { type AnalyzeOeeRequest as AnalyzeOeeRequest, type AnalyzeOeeResponse as AnalyzeOeeResponse, type AnalyzeOeeTrendRequest as AnalyzeOeeTrendRequest, type AnalyzeOeeTrendResponse as AnalyzeOeeTrendResponse, type AnalyzeScheduleAttainmentRequest as AnalyzeScheduleAttainmentRequest, type AnalyzeScheduleAttainmentResponse as AnalyzeScheduleAttainmentResponse, type AttainmentBucket as AttainmentBucket, type FrozenAdherence as FrozenAdherence, type ListAttainmentBucket as ListAttainmentBucket, type ListFrozenAdherence as ListFrozenAdherence, type ListOeeDepartment as ListOeeDepartment, type ListOeeDowntimeReason as ListOeeDowntimeReason, type ListOeeTrendPeriod as ListOeeTrendPeriod, type OeeDepartment as OeeDepartment, type OeeDepartmentPlannedTime as OeeDepartmentPlannedTime, type OeeDowntimeReason as OeeDowntimeReason, type OeeTrendPeriod as OeeTrendPeriod, type AnalyticsUpdateOeeParams as AnalyticsUpdateOeeParams, type AnalyticsUpdateOeeTrendParams as AnalyticsUpdateOeeTrendParams, type AnalyticsUpdateScheduleAttainmentParams as AnalyticsUpdateScheduleAttainmentParams, };
|
|
982
|
+
export { type AnalyzeDeliveryPerformanceRequest as AnalyzeDeliveryPerformanceRequest, type AnalyzeDeliveryPerformanceResponse as AnalyzeDeliveryPerformanceResponse, type AnalyzeOeeRequest as AnalyzeOeeRequest, type AnalyzeOeeResponse as AnalyzeOeeResponse, type AnalyzeOeeTrendRequest as AnalyzeOeeTrendRequest, type AnalyzeOeeTrendResponse as AnalyzeOeeTrendResponse, type AnalyzeScheduleAttainmentRequest as AnalyzeScheduleAttainmentRequest, type AnalyzeScheduleAttainmentResponse as AnalyzeScheduleAttainmentResponse, type AttainmentBucket as AttainmentBucket, type DeliveryBacklogBucket as DeliveryBacklogBucket, type DeliveryPerformance as DeliveryPerformance, type FrozenAdherence as FrozenAdherence, type ListAttainmentBucket as ListAttainmentBucket, type ListDeliveryBacklogBucket as ListDeliveryBacklogBucket, type ListDeliveryPerformance as ListDeliveryPerformance, type ListFrozenAdherence as ListFrozenAdherence, type ListOeeDepartment as ListOeeDepartment, type ListOeeDowntimeReason as ListOeeDowntimeReason, type ListOeeTrendPeriod as ListOeeTrendPeriod, type OeeDepartment as OeeDepartment, type OeeDepartmentPlannedTime as OeeDepartmentPlannedTime, type OeeDowntimeReason as OeeDowntimeReason, type OeeTrendPeriod as OeeTrendPeriod, type AnalyticsUpdateOeeParams as AnalyticsUpdateOeeParams, type AnalyticsUpdateOeeTrendParams as AnalyticsUpdateOeeTrendParams, type AnalyticsUpdateScheduleAttainmentParams as AnalyticsUpdateScheduleAttainmentParams, type AnalyticsUpdateDeliveryPerformanceParams as AnalyticsUpdateDeliveryPerformanceParams, };
|
|
732
983
|
}
|
|
733
984
|
//# sourceMappingURL=analytics.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"analytics.d.ts","sourceRoot":"","sources":["../../src/resources/core/analytics.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,OAAO;OACZ,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB;;GAEG;AACH,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,SAAS,CAAC,IAAI,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAInG;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,cAAc,CACZ,IAAI,EAAE,6BAA6B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;IAItC;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,wBAAwB,CACtB,IAAI,EAAE,uCAAuC,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;
|
|
1
|
+
{"version":3,"file":"analytics.d.ts","sourceRoot":"","sources":["../../src/resources/core/analytics.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,OAAO;OACZ,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB;;GAEG;AACH,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,SAAS,CAAC,IAAI,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAInG;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,cAAc,CACZ,IAAI,EAAE,6BAA6B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;IAItC;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,wBAAwB,CACtB,IAAI,EAAE,uCAAuC,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;IAIhD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,yBAAyB,CACvB,IAAI,EAAE,wCAAwC,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,kCAAkC,CAAC;CAGlD;AAED;;;GAGG;AACH,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,kCAAkC;IACjD;;;OAGG;IACH,OAAO,EAAE,yBAAyB,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,MAAM,EAAE,uCAAuC,CAAC;IAEhD;;OAEG;IACH,OAAO,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAEpC;;;OAGG;IACH,OAAO,EAAE,uBAAuB,GAAG,IAAI,CAAC;IAExC;;;;;;;;OAQG;IACH,uBAAuB,EAAE,MAAM,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;;OAGG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,wBAAwB,CAAC,CAAC;CAChD;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,WAAW,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,MAAM,EAAE,sBAAsB,CAAC;CAChC;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,MAAM,EAAE,4BAA4B,CAAC;IAErC;;;OAGG;IACH,OAAO,EAAE,kBAAkB,GAAG,IAAI,CAAC;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,YAAY,GAAG,MAAM,CAAC;IAEtD;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC7B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,iCAAiC;IAChD;;;OAGG;IACH,kBAAkB,EAAE,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;IAE9C;;;OAGG;IACH,eAAe,EAAE,UAAU,GAAG,aAAa,CAAC;IAE5C;;;OAGG;IACH,OAAO,EAAE,oBAAoB,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,gBAAgB,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAE7C;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,SAAS,GAAG,YAAY,GAAG,MAAM,CAAC;IAErD;;OAEG;IACH,MAAM,EAAE,sCAAsC,CAAC;IAE/C;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;;;;OAOG;IACH,MAAM,EAAE,gBAAgB,CAAC;CAC1B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,MAAM,EAAE,yBAAyB,CAAC;IAElC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;;;OAKG;IACH,gCAAgC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhD;;;;;OAKG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,sBAAsB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC;;;;;;OAMG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;;;OAIG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,MAAM,EAAE,sBAAsB,CAAC;IAE/B;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;;;;OAKG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;IAE9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;;OAQG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;IAEnC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;;OAQG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;IAEjC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;;OAQG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;IAE7B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;;OAQG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;;OAQG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAE/B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;;OAQG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IAE5B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;;OAQG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,SAAS,EAAE,KAAK,CAAC,4BAA4B,CAAC,CAAC;IAE/C;;OAEG;IACH,yBAAyB,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,kBAAkB,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAEjD;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,kBAAkB,EAAE,UAAU,GAAG,WAAW,CAAC;IAE7C;;;OAGG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,wBAAwB,EAAE,MAAM,CAAC;IAEjC;;;OAGG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,cAAc,GAAG,aAAa,GAAG,SAAS,GAAG,eAAe,CAAC;IAEzE;;OAEG;IACH,MAAM,EACF,WAAW,GACX,YAAY,GACZ,mBAAmB,GACnB,aAAa,GACb,qBAAqB,GACrB,YAAY,GACZ,cAAc,GACd,aAAa,CAAC;CACnB;AAED;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,yBAAyB,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,kBAAkB,EAAE,UAAU,GAAG,WAAW,CAAC;IAE7C;;;OAGG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAEhC;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;;OAGG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,wBAAwB,CAAC,CAAC;CAChD;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAChC;AAED,MAAM,WAAW,uCAAuC;IACtD;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,YAAY,GAAG,MAAM,CAAC;IAEtD;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC7B;AAED,MAAM,WAAW,wCAAwC;IACvD;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,CAAC;CACxC;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,wCAAwC,IAAI,wCAAwC,GAC1F,CAAC;CACH"}
|
|
@@ -90,6 +90,44 @@ class Analytics extends resource_1.APIResource {
|
|
|
90
90
|
updateScheduleAttainment(body, options) {
|
|
91
91
|
return this._client.put('/v1/core/analytics/schedule-attainment', { body, ...options });
|
|
92
92
|
}
|
|
93
|
+
/**
|
|
94
|
+
* Returns how reliably promised delivery dates were met.
|
|
95
|
+
*
|
|
96
|
+
* Orders are counted in the period their promise came due, not the period they
|
|
97
|
+
* shipped — an order promised in March and shipped in May is March's miss. On time
|
|
98
|
+
* means the first shipment left on or before the promised date, because the
|
|
99
|
+
* promise is that the order starts moving by then; judging on the last shipment
|
|
100
|
+
* would fail an order the customer received on time in two boxes. On time in full
|
|
101
|
+
* adds that the whole ordered quantity was packed.
|
|
102
|
+
*
|
|
103
|
+
* The denominator is orders that were due, not orders that shipped, so an order
|
|
104
|
+
* past its date and still unshipped counts against the rate rather than being held
|
|
105
|
+
* back until it moves. Excluding open orders would let a plant with a growing late
|
|
106
|
+
* backlog report perfect delivery.
|
|
107
|
+
*
|
|
108
|
+
* Only orders carrying a ship-by commitment participate. An order with no
|
|
109
|
+
* commitment cannot be late, and counting it as on time would inflate the rate
|
|
110
|
+
* with orders nobody promised anything about — `uncommitted_order_count` says how
|
|
111
|
+
* many were excluded, so the gap is visible rather than silent.
|
|
112
|
+
*
|
|
113
|
+
* Every rate is null rather than zero when nothing was due, and average lateness
|
|
114
|
+
* is measured over late orders only.
|
|
115
|
+
*
|
|
116
|
+
* This endpoint requires the permission: `sales_orders:read`.
|
|
117
|
+
*
|
|
118
|
+
* @example
|
|
119
|
+
* ```ts
|
|
120
|
+
* const analyzeDeliveryPerformanceResponse =
|
|
121
|
+
* await client.core.analytics.updateDeliveryPerformance({
|
|
122
|
+
* ends_at: '2026-05-10T00:23:00Z',
|
|
123
|
+
* starts_at: '2026-05-10T00:00:00Z',
|
|
124
|
+
* granularity: 'week',
|
|
125
|
+
* });
|
|
126
|
+
* ```
|
|
127
|
+
*/
|
|
128
|
+
updateDeliveryPerformance(body, options) {
|
|
129
|
+
return this._client.put('/v1/core/analytics/delivery-performance', { body, ...options });
|
|
130
|
+
}
|
|
93
131
|
}
|
|
94
132
|
exports.Analytics = Analytics;
|
|
95
133
|
//# sourceMappingURL=analytics.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"analytics.js","sourceRoot":"","sources":["../../src/resources/core/analytics.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAMlD;;GAEG;AACH,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,SAAS,CAAC,IAA8B,EAAE,OAAwB;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,cAAc,CACZ,IAAmC,EACnC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,8BAA8B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,wBAAwB,CACtB,IAA6C,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,wCAAwC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;CACF;
|
|
1
|
+
{"version":3,"file":"analytics.js","sourceRoot":"","sources":["../../src/resources/core/analytics.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAMlD;;GAEG;AACH,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,SAAS,CAAC,IAA8B,EAAE,OAAwB;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,cAAc,CACZ,IAAmC,EACnC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,8BAA8B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,wBAAwB,CACtB,IAA6C,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,wCAAwC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,yBAAyB,CACvB,IAA8C,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,yCAAyC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;CACF;AAtID,8BAsIC"}
|
|
@@ -87,5 +87,43 @@ export class Analytics extends APIResource {
|
|
|
87
87
|
updateScheduleAttainment(body, options) {
|
|
88
88
|
return this._client.put('/v1/core/analytics/schedule-attainment', { body, ...options });
|
|
89
89
|
}
|
|
90
|
+
/**
|
|
91
|
+
* Returns how reliably promised delivery dates were met.
|
|
92
|
+
*
|
|
93
|
+
* Orders are counted in the period their promise came due, not the period they
|
|
94
|
+
* shipped — an order promised in March and shipped in May is March's miss. On time
|
|
95
|
+
* means the first shipment left on or before the promised date, because the
|
|
96
|
+
* promise is that the order starts moving by then; judging on the last shipment
|
|
97
|
+
* would fail an order the customer received on time in two boxes. On time in full
|
|
98
|
+
* adds that the whole ordered quantity was packed.
|
|
99
|
+
*
|
|
100
|
+
* The denominator is orders that were due, not orders that shipped, so an order
|
|
101
|
+
* past its date and still unshipped counts against the rate rather than being held
|
|
102
|
+
* back until it moves. Excluding open orders would let a plant with a growing late
|
|
103
|
+
* backlog report perfect delivery.
|
|
104
|
+
*
|
|
105
|
+
* Only orders carrying a ship-by commitment participate. An order with no
|
|
106
|
+
* commitment cannot be late, and counting it as on time would inflate the rate
|
|
107
|
+
* with orders nobody promised anything about — `uncommitted_order_count` says how
|
|
108
|
+
* many were excluded, so the gap is visible rather than silent.
|
|
109
|
+
*
|
|
110
|
+
* Every rate is null rather than zero when nothing was due, and average lateness
|
|
111
|
+
* is measured over late orders only.
|
|
112
|
+
*
|
|
113
|
+
* This endpoint requires the permission: `sales_orders:read`.
|
|
114
|
+
*
|
|
115
|
+
* @example
|
|
116
|
+
* ```ts
|
|
117
|
+
* const analyzeDeliveryPerformanceResponse =
|
|
118
|
+
* await client.core.analytics.updateDeliveryPerformance({
|
|
119
|
+
* ends_at: '2026-05-10T00:23:00Z',
|
|
120
|
+
* starts_at: '2026-05-10T00:00:00Z',
|
|
121
|
+
* granularity: 'week',
|
|
122
|
+
* });
|
|
123
|
+
* ```
|
|
124
|
+
*/
|
|
125
|
+
updateDeliveryPerformance(body, options) {
|
|
126
|
+
return this._client.put('/v1/core/analytics/delivery-performance', { body, ...options });
|
|
127
|
+
}
|
|
90
128
|
}
|
|
91
129
|
//# sourceMappingURL=analytics.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"analytics.mjs","sourceRoot":"","sources":["../../src/resources/core/analytics.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAMtB;;GAEG;AACH,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,SAAS,CAAC,IAA8B,EAAE,OAAwB;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,cAAc,CACZ,IAAmC,EACnC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,8BAA8B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,wBAAwB,CACtB,IAA6C,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,wCAAwC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;CACF"}
|
|
1
|
+
{"version":3,"file":"analytics.mjs","sourceRoot":"","sources":["../../src/resources/core/analytics.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAMtB;;GAEG;AACH,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,SAAS,CAAC,IAA8B,EAAE,OAAwB;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,cAAc,CACZ,IAAmC,EACnC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,8BAA8B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,wBAAwB,CACtB,IAA6C,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,wCAAwC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,yBAAyB,CACvB,IAA8C,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,yCAAyC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;CACF"}
|
|
@@ -147,7 +147,7 @@ export interface AuditEvent {
|
|
|
147
147
|
/**
|
|
148
148
|
* Resource type of the audited entity.
|
|
149
149
|
*/
|
|
150
|
-
resource_type: 'account' | 'actor' | 'entity' | 'record' | 'freight' | 'sales_order_totals' | 'sales_order_stage_total' | 'sales_order_related' | 'order_contact' | 'user' | 'address' | 'api_key' | 'created_api_key' | 'refresh_token' | 'list' | 'sandbox' | 'registration_session' | 'pricing_plan' | 'account_plan' | 'plan_change' | 'enterprise_inquiry' | 'request_log' | 'audit_event' | 'audit_field_change' | 'role' | 'unit' | 'account_affiliation' | 'agent_definition' | 'available_tool' | 'agent_definition_tool' | 'agent_account_status' | 'agent_run' | 'agent_action' | 'agent_run_step' | 'agent_token_usage' | 'agent_memory' | 'notification' | 'notification_unread_count' | 'notification_send_result' | 'notification_unread_summary' | 'announcement' | 'conversation' | 'support_case' | 'conversation_participant' | 'read_cursor' | 'chat_message' | 'notification_unread_summary_account' | 'messaging_block' | 'notification_preference' | 'message_attachment' | 'attachment_upload_target' | 'scheduled_message' | 'messaging_contact' | 'message_report' | 'tool_group' | 'model' | 'payment_term' | 'shipping_term' | 'quantity' | 'account_group' | 'support_route' | 'support_availability' | 'account_status' | 'geolocation' | 'account_user' | 'department' | 'account_integration' | 'account_price' | 'product_line' | 'item_category' | 'attribute' | 'rate' | 'account_group_product_line_access' | 'sales_target' | 'adjustment_type' | 'account_branding' | 'account_portal' | 'account_logo_url' | 'account_favicon_url' | 'public_account' | 'property' | 'carrier' | 'service_level' | 'item' | 'item_lot_default' | 'item_inventory' | 'product' | 'batch' | 'batch_flow_node' | 'scanning_consumption' | 'open_batch_summary' | 'scanning_production_step_info' | 'scanning_station' | 'production_step' | 'production_run' | 'machine' | 'machine_status' | 'machine_downtime_event' | 'demand_override' | 'demand_override_type' | 'machine_downtime_reason' | 'production_schedule_preview' | 'production_schedule_regenerate_preview' | 'production_schedule' | 'production_schedule_line' | 'production_schedule_deviation' | 'production_schedule_derived_line' | 'production_schedule_settings' | 'production_schedule_resource_setting' | 'schedule_deviation_type' | 'production_schedule_finished_policy' | 'production_schedule_week_release' | 'production_schedule_week_release_preview' | 'production_schedule_item_policy' | 'child_account' | 'unit_group' | 'unit_group_unit' | 'consumption' | 'customer_product_line_access' | 'customer' | 'frequently_ordered_product' | 'priority' | 'delivery' | 'delivery_line' | 'sales_order' | 'location' | 'location_type' | 'lot' | 'email_log' | 'email_domain' | 'email_inbox' | 'portal_domain' | 'dns_record' | 'inventory_change_log' | 'invoice' | 'invoice_summary' | 'invoice_line' | 'invoice_allocation' | 'invoice_for_payment' | 'shipment' | 'shipment_summary' | 'shipment_line' | 'shipping_case' | 'shipping_case_label_url' | 'settlement' | 'settlement_summary' | 'role_permission' | 'registration_flow' | 'registration_flow_option' | 'transaction' | 'transaction_summary' | 'transaction_method' | 'transaction_type' | 'transaction_allocation' | 'usage_item' | 'account_usage_response' | 'subscription_info' | 'billing_portal_session_response' | 'switch_plan_response' | 'ensure_billing_customer_response' | 'spending_cap_response' | 'agent_spend_info' | 'webhook_response' | 'address_suggestion' | 'address_components' | 'address_details_result' | 'validated_address' | 'plan_limit' | 'plan_change_proration' | 'plan_change_line_item' | 'setup_billing_response' | 'confirm_payment_response' | 'oauth_response' | 'oauth_status_response' | 'stripe_publishable_key' | 'stripe_status' | 'healthcheck' | 'agent_definition_config' | 'trigger_config' | 'customer_contact_info' | 'customer_freight_preferences' | 'customer_defaults' | 'customer_notification_preferences' | 'order_notification_recipient' | 'order_discount' | 'sales_order_line' | 'sales_order_type' | 'sales_order_status' | 'material' | 'supplier_material' | 'part' | 'permission_group' | 'permission' | 'pick' | 'pick_line' | 'product_type' | 'production' | 'production_flow' | 'map' | 'purchase_order' | 'purchase_order_line' | 'supplier' | 'supplier_summary' | 'receivable_entry' | 'receiving_order' | 'receiving_order_line' | 'email_contact' | 'allocation_entry' | 'open_credit_entry' | 'volume_discount' | 'volume_discount_tier' | 'analyze_deliveries_response' | 'analyze_manufacturing_response' | 'analyze_manufacturing_batch_response' | 'analyze_quarterly_orders_response' | 'analyze_new_customers_response' | 'analyze_demand_forecast_response' | 'analyze_oee_response' | 'analyze_oee_trend_response' | 'analyze_schedule_attainment_response' | 'catalog_product_line' | 'catalog_category' | 'catalog_product' | 'catalog_property' | 'catalog_attribute' | 'dc_location' | 'edi_run' | 'inventory_item' | 'analyze_weeks_of_sales_response' | 'bulk_reconcile_items_response' | 'sys_property' | 'sys_property_type' | 'sys_property_value' | 'territory' | 'tenancy' | 'checkout_session' | 'estimate_rate_result' | 'rate_shop_option' | 'rate_shop_result' | 'owner' | 'created_by' | 'message' | 'account_photo_upload_result' | 'user_photo_upload_result' | 'user_photo_url' | 'batch_lot' | 'check_duplicate_result' | 'item_trend_point' | 'pack_pick_response' | 'pick_shipments_response' | 'tenancy_pending_registration' | 'invoice_allocation_entry' | 'allocation_customer' | 'checkout_sales_order' | 'sales_order_price_quote' | 'sales_order_freight_quote' | 'sales_order_price_quote_line' | 'sales_order_quote_rate' | 'hubspot_sync_job' | 'hubspot_sync_report' | 'hubspot_company_review' | 'hubspot_company_candidate' | 'hubspot_sync_record' | 'contact_match' | 'reply_draft' | 'conversation_link' | 'messaging_group' | 'messaging_group_member' | 'portal_profile' | 'portal_registration_session' | 'portal_registration_session_data' | 'pack_list' | 'pack_list_party' | 'pack_list_line_item' | 'pack_list_back_order' | 'pack_list_case' | 'job';
|
|
150
|
+
resource_type: 'account' | 'actor' | 'entity' | 'record' | 'freight' | 'sales_order_totals' | 'sales_order_stage_total' | 'sales_order_related' | 'order_contact' | 'user' | 'address' | 'api_key' | 'created_api_key' | 'refresh_token' | 'list' | 'sandbox' | 'registration_session' | 'pricing_plan' | 'account_plan' | 'plan_change' | 'enterprise_inquiry' | 'request_log' | 'audit_event' | 'audit_field_change' | 'role' | 'unit' | 'account_affiliation' | 'agent_definition' | 'available_tool' | 'agent_definition_tool' | 'agent_account_status' | 'agent_run' | 'agent_action' | 'agent_run_step' | 'agent_token_usage' | 'agent_memory' | 'notification' | 'notification_unread_count' | 'notification_send_result' | 'notification_unread_summary' | 'announcement' | 'conversation' | 'support_case' | 'conversation_participant' | 'read_cursor' | 'chat_message' | 'notification_unread_summary_account' | 'messaging_block' | 'notification_preference' | 'message_attachment' | 'attachment_upload_target' | 'scheduled_message' | 'messaging_contact' | 'message_report' | 'tool_group' | 'model' | 'payment_term' | 'shipping_term' | 'quantity' | 'account_group' | 'support_route' | 'support_availability' | 'account_status' | 'geolocation' | 'account_user' | 'department' | 'account_integration' | 'account_price' | 'product_line' | 'item_category' | 'attribute' | 'rate' | 'account_group_product_line_access' | 'sales_target' | 'adjustment_type' | 'account_branding' | 'account_portal' | 'account_logo_url' | 'account_favicon_url' | 'public_account' | 'property' | 'carrier' | 'service_level' | 'item' | 'item_lot_default' | 'item_inventory' | 'product' | 'batch' | 'batch_flow_node' | 'scanning_consumption' | 'open_batch_summary' | 'scanning_production_step_info' | 'scanning_station' | 'production_step' | 'production_run' | 'machine' | 'machine_status' | 'machine_downtime_event' | 'demand_override' | 'demand_override_type' | 'machine_downtime_reason' | 'production_schedule_preview' | 'production_schedule_regenerate_preview' | 'production_schedule' | 'production_schedule_line' | 'production_schedule_deviation' | 'production_schedule_derived_line' | 'production_schedule_settings' | 'production_schedule_resource_setting' | 'production_schedule_item_setting' | 'fulfillment_recommendation' | 'analyze_delivery_performance_response' | 'delivery_performance' | 'delivery_backlog_bucket' | 'schedule_order_coverage' | 'schedule_order_coverage_line' | 'promise_date_quote' | 'schedule_deviation_type' | 'schedule_at_risk_order' | 'production_schedule_finished_policy' | 'production_schedule_week_release' | 'production_schedule_week_release_preview' | 'production_schedule_item_policy' | 'child_account' | 'unit_group' | 'unit_group_unit' | 'consumption' | 'customer_product_line_access' | 'customer' | 'frequently_ordered_product' | 'priority' | 'delivery' | 'delivery_line' | 'sales_order' | 'location' | 'location_type' | 'lot' | 'email_log' | 'email_domain' | 'email_inbox' | 'portal_domain' | 'dns_record' | 'inventory_change_log' | 'invoice' | 'invoice_summary' | 'invoice_line' | 'invoice_allocation' | 'invoice_for_payment' | 'shipment' | 'shipment_summary' | 'shipment_line' | 'shipping_case' | 'shipping_case_label_url' | 'settlement' | 'settlement_summary' | 'role_permission' | 'registration_flow' | 'registration_flow_option' | 'transaction' | 'transaction_summary' | 'transaction_method' | 'transaction_type' | 'transaction_allocation' | 'usage_item' | 'account_usage_response' | 'subscription_info' | 'billing_portal_session_response' | 'switch_plan_response' | 'ensure_billing_customer_response' | 'spending_cap_response' | 'agent_spend_info' | 'webhook_response' | 'address_suggestion' | 'address_components' | 'address_details_result' | 'validated_address' | 'plan_limit' | 'plan_change_proration' | 'plan_change_line_item' | 'setup_billing_response' | 'confirm_payment_response' | 'oauth_response' | 'oauth_status_response' | 'stripe_publishable_key' | 'stripe_status' | 'healthcheck' | 'agent_definition_config' | 'trigger_config' | 'customer_contact_info' | 'customer_freight_preferences' | 'customer_defaults' | 'customer_lead_time' | 'customer_notification_preferences' | 'order_notification_recipient' | 'order_discount' | 'sales_order_line' | 'sales_order_type' | 'sales_order_status' | 'material' | 'supplier_material' | 'part' | 'permission_group' | 'permission' | 'pick' | 'pick_line' | 'product_type' | 'production' | 'production_flow' | 'map' | 'purchase_order' | 'purchase_order_line' | 'supplier' | 'supplier_summary' | 'receivable_entry' | 'receiving_order' | 'receiving_order_line' | 'email_contact' | 'allocation_entry' | 'open_credit_entry' | 'volume_discount' | 'volume_discount_tier' | 'analyze_deliveries_response' | 'analyze_manufacturing_response' | 'analyze_manufacturing_batch_response' | 'analyze_quarterly_orders_response' | 'analyze_new_customers_response' | 'analyze_demand_forecast_response' | 'analyze_oee_response' | 'analyze_oee_trend_response' | 'analyze_schedule_attainment_response' | 'catalog_product_line' | 'catalog_category' | 'catalog_product' | 'catalog_property' | 'catalog_attribute' | 'dc_location' | 'edi_run' | 'inventory_item' | 'analyze_weeks_of_sales_response' | 'bulk_reconcile_items_response' | 'sys_property' | 'sys_property_type' | 'sys_property_value' | 'territory' | 'tenancy' | 'checkout_session' | 'estimate_rate_result' | 'rate_shop_option' | 'rate_shop_result' | 'owner' | 'created_by' | 'message' | 'account_photo_upload_result' | 'user_photo_upload_result' | 'user_photo_url' | 'batch_lot' | 'check_duplicate_result' | 'item_trend_point' | 'pack_pick_response' | 'pick_shipments_response' | 'tenancy_pending_registration' | 'invoice_allocation_entry' | 'allocation_customer' | 'checkout_sales_order' | 'sales_order_price_quote' | 'sales_order_freight_quote' | 'sales_order_price_quote_line' | 'sales_order_quote_rate' | 'hubspot_sync_job' | 'hubspot_sync_report' | 'hubspot_company_review' | 'hubspot_company_candidate' | 'hubspot_sync_record' | 'contact_match' | 'reply_draft' | 'conversation_link' | 'messaging_group' | 'messaging_group_member' | 'portal_profile' | 'portal_registration_session' | 'portal_registration_session_data' | 'pack_list' | 'pack_list_party' | 'pack_list_line_item' | 'pack_list_back_order' | 'pack_list_case' | 'job';
|
|
151
151
|
/**
|
|
152
152
|
* Originating client IP address.
|
|
153
153
|
*/
|
|
@@ -242,7 +242,7 @@ export interface ListObjectType {
|
|
|
242
242
|
/**
|
|
243
243
|
* Resources in this page.
|
|
244
244
|
*/
|
|
245
|
-
data: Array<'account' | 'actor' | 'entity' | 'record' | 'freight' | 'sales_order_totals' | 'sales_order_stage_total' | 'sales_order_related' | 'order_contact' | 'user' | 'address' | 'api_key' | 'created_api_key' | 'refresh_token' | 'list' | 'sandbox' | 'registration_session' | 'pricing_plan' | 'account_plan' | 'plan_change' | 'enterprise_inquiry' | 'request_log' | 'audit_event' | 'audit_field_change' | 'role' | 'unit' | 'account_affiliation' | 'agent_definition' | 'available_tool' | 'agent_definition_tool' | 'agent_account_status' | 'agent_run' | 'agent_action' | 'agent_run_step' | 'agent_token_usage' | 'agent_memory' | 'notification' | 'notification_unread_count' | 'notification_send_result' | 'notification_unread_summary' | 'announcement' | 'conversation' | 'support_case' | 'conversation_participant' | 'read_cursor' | 'chat_message' | 'notification_unread_summary_account' | 'messaging_block' | 'notification_preference' | 'message_attachment' | 'attachment_upload_target' | 'scheduled_message' | 'messaging_contact' | 'message_report' | 'tool_group' | 'model' | 'payment_term' | 'shipping_term' | 'quantity' | 'account_group' | 'support_route' | 'support_availability' | 'account_status' | 'geolocation' | 'account_user' | 'department' | 'account_integration' | 'account_price' | 'product_line' | 'item_category' | 'attribute' | 'rate' | 'account_group_product_line_access' | 'sales_target' | 'adjustment_type' | 'account_branding' | 'account_portal' | 'account_logo_url' | 'account_favicon_url' | 'public_account' | 'property' | 'carrier' | 'service_level' | 'item' | 'item_lot_default' | 'item_inventory' | 'product' | 'batch' | 'batch_flow_node' | 'scanning_consumption' | 'open_batch_summary' | 'scanning_production_step_info' | 'scanning_station' | 'production_step' | 'production_run' | 'machine' | 'machine_status' | 'machine_downtime_event' | 'demand_override' | 'demand_override_type' | 'machine_downtime_reason' | 'production_schedule_preview' | 'production_schedule_regenerate_preview' | 'production_schedule' | 'production_schedule_line' | 'production_schedule_deviation' | 'production_schedule_derived_line' | 'production_schedule_settings' | 'production_schedule_resource_setting' | 'schedule_deviation_type' | 'production_schedule_finished_policy' | 'production_schedule_week_release' | 'production_schedule_week_release_preview' | 'production_schedule_item_policy' | 'child_account' | 'unit_group' | 'unit_group_unit' | 'consumption' | 'customer_product_line_access' | 'customer' | 'frequently_ordered_product' | 'priority' | 'delivery' | 'delivery_line' | 'sales_order' | 'location' | 'location_type' | 'lot' | 'email_log' | 'email_domain' | 'email_inbox' | 'portal_domain' | 'dns_record' | 'inventory_change_log' | 'invoice' | 'invoice_summary' | 'invoice_line' | 'invoice_allocation' | 'invoice_for_payment' | 'shipment' | 'shipment_summary' | 'shipment_line' | 'shipping_case' | 'shipping_case_label_url' | 'settlement' | 'settlement_summary' | 'role_permission' | 'registration_flow' | 'registration_flow_option' | 'transaction' | 'transaction_summary' | 'transaction_method' | 'transaction_type' | 'transaction_allocation' | 'usage_item' | 'account_usage_response' | 'subscription_info' | 'billing_portal_session_response' | 'switch_plan_response' | 'ensure_billing_customer_response' | 'spending_cap_response' | 'agent_spend_info' | 'webhook_response' | 'address_suggestion' | 'address_components' | 'address_details_result' | 'validated_address' | 'plan_limit' | 'plan_change_proration' | 'plan_change_line_item' | 'setup_billing_response' | 'confirm_payment_response' | 'oauth_response' | 'oauth_status_response' | 'stripe_publishable_key' | 'stripe_status' | 'healthcheck' | 'agent_definition_config' | 'trigger_config' | 'customer_contact_info' | 'customer_freight_preferences' | 'customer_defaults' | 'customer_notification_preferences' | 'order_notification_recipient' | 'order_discount' | 'sales_order_line' | 'sales_order_type' | 'sales_order_status' | 'material' | 'supplier_material' | 'part' | 'permission_group' | 'permission' | 'pick' | 'pick_line' | 'product_type' | 'production' | 'production_flow' | 'map' | 'purchase_order' | 'purchase_order_line' | 'supplier' | 'supplier_summary' | 'receivable_entry' | 'receiving_order' | 'receiving_order_line' | 'email_contact' | 'allocation_entry' | 'open_credit_entry' | 'volume_discount' | 'volume_discount_tier' | 'analyze_deliveries_response' | 'analyze_manufacturing_response' | 'analyze_manufacturing_batch_response' | 'analyze_quarterly_orders_response' | 'analyze_new_customers_response' | 'analyze_demand_forecast_response' | 'analyze_oee_response' | 'analyze_oee_trend_response' | 'analyze_schedule_attainment_response' | 'catalog_product_line' | 'catalog_category' | 'catalog_product' | 'catalog_property' | 'catalog_attribute' | 'dc_location' | 'edi_run' | 'inventory_item' | 'analyze_weeks_of_sales_response' | 'bulk_reconcile_items_response' | 'sys_property' | 'sys_property_type' | 'sys_property_value' | 'territory' | 'tenancy' | 'checkout_session' | 'estimate_rate_result' | 'rate_shop_option' | 'rate_shop_result' | 'owner' | 'created_by' | 'message' | 'account_photo_upload_result' | 'user_photo_upload_result' | 'user_photo_url' | 'batch_lot' | 'check_duplicate_result' | 'item_trend_point' | 'pack_pick_response' | 'pick_shipments_response' | 'tenancy_pending_registration' | 'invoice_allocation_entry' | 'allocation_customer' | 'checkout_sales_order' | 'sales_order_price_quote' | 'sales_order_freight_quote' | 'sales_order_price_quote_line' | 'sales_order_quote_rate' | 'hubspot_sync_job' | 'hubspot_sync_report' | 'hubspot_company_review' | 'hubspot_company_candidate' | 'hubspot_sync_record' | 'contact_match' | 'reply_draft' | 'conversation_link' | 'messaging_group' | 'messaging_group_member' | 'portal_profile' | 'portal_registration_session' | 'portal_registration_session_data' | 'pack_list' | 'pack_list_party' | 'pack_list_line_item' | 'pack_list_back_order' | 'pack_list_case' | 'job'>;
|
|
245
|
+
data: Array<'account' | 'actor' | 'entity' | 'record' | 'freight' | 'sales_order_totals' | 'sales_order_stage_total' | 'sales_order_related' | 'order_contact' | 'user' | 'address' | 'api_key' | 'created_api_key' | 'refresh_token' | 'list' | 'sandbox' | 'registration_session' | 'pricing_plan' | 'account_plan' | 'plan_change' | 'enterprise_inquiry' | 'request_log' | 'audit_event' | 'audit_field_change' | 'role' | 'unit' | 'account_affiliation' | 'agent_definition' | 'available_tool' | 'agent_definition_tool' | 'agent_account_status' | 'agent_run' | 'agent_action' | 'agent_run_step' | 'agent_token_usage' | 'agent_memory' | 'notification' | 'notification_unread_count' | 'notification_send_result' | 'notification_unread_summary' | 'announcement' | 'conversation' | 'support_case' | 'conversation_participant' | 'read_cursor' | 'chat_message' | 'notification_unread_summary_account' | 'messaging_block' | 'notification_preference' | 'message_attachment' | 'attachment_upload_target' | 'scheduled_message' | 'messaging_contact' | 'message_report' | 'tool_group' | 'model' | 'payment_term' | 'shipping_term' | 'quantity' | 'account_group' | 'support_route' | 'support_availability' | 'account_status' | 'geolocation' | 'account_user' | 'department' | 'account_integration' | 'account_price' | 'product_line' | 'item_category' | 'attribute' | 'rate' | 'account_group_product_line_access' | 'sales_target' | 'adjustment_type' | 'account_branding' | 'account_portal' | 'account_logo_url' | 'account_favicon_url' | 'public_account' | 'property' | 'carrier' | 'service_level' | 'item' | 'item_lot_default' | 'item_inventory' | 'product' | 'batch' | 'batch_flow_node' | 'scanning_consumption' | 'open_batch_summary' | 'scanning_production_step_info' | 'scanning_station' | 'production_step' | 'production_run' | 'machine' | 'machine_status' | 'machine_downtime_event' | 'demand_override' | 'demand_override_type' | 'machine_downtime_reason' | 'production_schedule_preview' | 'production_schedule_regenerate_preview' | 'production_schedule' | 'production_schedule_line' | 'production_schedule_deviation' | 'production_schedule_derived_line' | 'production_schedule_settings' | 'production_schedule_resource_setting' | 'production_schedule_item_setting' | 'fulfillment_recommendation' | 'analyze_delivery_performance_response' | 'delivery_performance' | 'delivery_backlog_bucket' | 'schedule_order_coverage' | 'schedule_order_coverage_line' | 'promise_date_quote' | 'schedule_deviation_type' | 'schedule_at_risk_order' | 'production_schedule_finished_policy' | 'production_schedule_week_release' | 'production_schedule_week_release_preview' | 'production_schedule_item_policy' | 'child_account' | 'unit_group' | 'unit_group_unit' | 'consumption' | 'customer_product_line_access' | 'customer' | 'frequently_ordered_product' | 'priority' | 'delivery' | 'delivery_line' | 'sales_order' | 'location' | 'location_type' | 'lot' | 'email_log' | 'email_domain' | 'email_inbox' | 'portal_domain' | 'dns_record' | 'inventory_change_log' | 'invoice' | 'invoice_summary' | 'invoice_line' | 'invoice_allocation' | 'invoice_for_payment' | 'shipment' | 'shipment_summary' | 'shipment_line' | 'shipping_case' | 'shipping_case_label_url' | 'settlement' | 'settlement_summary' | 'role_permission' | 'registration_flow' | 'registration_flow_option' | 'transaction' | 'transaction_summary' | 'transaction_method' | 'transaction_type' | 'transaction_allocation' | 'usage_item' | 'account_usage_response' | 'subscription_info' | 'billing_portal_session_response' | 'switch_plan_response' | 'ensure_billing_customer_response' | 'spending_cap_response' | 'agent_spend_info' | 'webhook_response' | 'address_suggestion' | 'address_components' | 'address_details_result' | 'validated_address' | 'plan_limit' | 'plan_change_proration' | 'plan_change_line_item' | 'setup_billing_response' | 'confirm_payment_response' | 'oauth_response' | 'oauth_status_response' | 'stripe_publishable_key' | 'stripe_status' | 'healthcheck' | 'agent_definition_config' | 'trigger_config' | 'customer_contact_info' | 'customer_freight_preferences' | 'customer_defaults' | 'customer_lead_time' | 'customer_notification_preferences' | 'order_notification_recipient' | 'order_discount' | 'sales_order_line' | 'sales_order_type' | 'sales_order_status' | 'material' | 'supplier_material' | 'part' | 'permission_group' | 'permission' | 'pick' | 'pick_line' | 'product_type' | 'production' | 'production_flow' | 'map' | 'purchase_order' | 'purchase_order_line' | 'supplier' | 'supplier_summary' | 'receivable_entry' | 'receiving_order' | 'receiving_order_line' | 'email_contact' | 'allocation_entry' | 'open_credit_entry' | 'volume_discount' | 'volume_discount_tier' | 'analyze_deliveries_response' | 'analyze_manufacturing_response' | 'analyze_manufacturing_batch_response' | 'analyze_quarterly_orders_response' | 'analyze_new_customers_response' | 'analyze_demand_forecast_response' | 'analyze_oee_response' | 'analyze_oee_trend_response' | 'analyze_schedule_attainment_response' | 'catalog_product_line' | 'catalog_category' | 'catalog_product' | 'catalog_property' | 'catalog_attribute' | 'dc_location' | 'edi_run' | 'inventory_item' | 'analyze_weeks_of_sales_response' | 'bulk_reconcile_items_response' | 'sys_property' | 'sys_property_type' | 'sys_property_value' | 'territory' | 'tenancy' | 'checkout_session' | 'estimate_rate_result' | 'rate_shop_option' | 'rate_shop_result' | 'owner' | 'created_by' | 'message' | 'account_photo_upload_result' | 'user_photo_upload_result' | 'user_photo_url' | 'batch_lot' | 'check_duplicate_result' | 'item_trend_point' | 'pack_pick_response' | 'pick_shipments_response' | 'tenancy_pending_registration' | 'invoice_allocation_entry' | 'allocation_customer' | 'checkout_sales_order' | 'sales_order_price_quote' | 'sales_order_freight_quote' | 'sales_order_price_quote_line' | 'sales_order_quote_rate' | 'hubspot_sync_job' | 'hubspot_sync_report' | 'hubspot_company_review' | 'hubspot_company_candidate' | 'hubspot_sync_record' | 'contact_match' | 'reply_draft' | 'conversation_link' | 'messaging_group' | 'messaging_group_member' | 'portal_profile' | 'portal_registration_session' | 'portal_registration_session_data' | 'pack_list' | 'pack_list_party' | 'pack_list_line_item' | 'pack_list_back_order' | 'pack_list_case' | 'job'>;
|
|
246
246
|
/**
|
|
247
247
|
* Resource type identifier.
|
|
248
248
|
*/
|
|
@@ -323,7 +323,7 @@ export interface AuditEventListParams {
|
|
|
323
323
|
* The full set of valid values is available from the List Audit Event Resource
|
|
324
324
|
* Types endpoint.
|
|
325
325
|
*/
|
|
326
|
-
resource_types?: Array<'account' | 'actor' | 'entity' | 'record' | 'freight' | 'sales_order_totals' | 'sales_order_stage_total' | 'sales_order_related' | 'order_contact' | 'user' | 'address' | 'api_key' | 'created_api_key' | 'refresh_token' | 'list' | 'sandbox' | 'registration_session' | 'pricing_plan' | 'account_plan' | 'plan_change' | 'enterprise_inquiry' | 'request_log' | 'audit_event' | 'audit_field_change' | 'role' | 'unit' | 'account_affiliation' | 'agent_definition' | 'available_tool' | 'agent_definition_tool' | 'agent_account_status' | 'agent_run' | 'agent_action' | 'agent_run_step' | 'agent_token_usage' | 'agent_memory' | 'notification' | 'notification_unread_count' | 'notification_send_result' | 'notification_unread_summary' | 'announcement' | 'conversation' | 'support_case' | 'conversation_participant' | 'read_cursor' | 'chat_message' | 'notification_unread_summary_account' | 'messaging_block' | 'notification_preference' | 'message_attachment' | 'attachment_upload_target' | 'scheduled_message' | 'messaging_contact' | 'message_report' | 'tool_group' | 'model' | 'payment_term' | 'shipping_term' | 'quantity' | 'account_group' | 'support_route' | 'support_availability' | 'account_status' | 'geolocation' | 'account_user' | 'department' | 'account_integration' | 'account_price' | 'product_line' | 'item_category' | 'attribute' | 'rate' | 'account_group_product_line_access' | 'sales_target' | 'adjustment_type' | 'account_branding' | 'account_portal' | 'account_logo_url' | 'account_favicon_url' | 'public_account' | 'property' | 'carrier' | 'service_level' | 'item' | 'item_lot_default' | 'item_inventory' | 'product' | 'batch' | 'batch_flow_node' | 'scanning_consumption' | 'open_batch_summary' | 'scanning_production_step_info' | 'scanning_station' | 'production_step' | 'production_run' | 'machine' | 'machine_status' | 'machine_downtime_event' | 'demand_override' | 'demand_override_type' | 'machine_downtime_reason' | 'production_schedule_preview' | 'production_schedule_regenerate_preview' | 'production_schedule' | 'production_schedule_line' | 'production_schedule_deviation' | 'production_schedule_derived_line' | 'production_schedule_settings' | 'production_schedule_resource_setting' | 'schedule_deviation_type' | 'production_schedule_finished_policy' | 'production_schedule_week_release' | 'production_schedule_week_release_preview' | 'production_schedule_item_policy' | 'child_account' | 'unit_group' | 'unit_group_unit' | 'consumption' | 'customer_product_line_access' | 'customer' | 'frequently_ordered_product' | 'priority' | 'delivery' | 'delivery_line' | 'sales_order' | 'location' | 'location_type' | 'lot' | 'email_log' | 'email_domain' | 'email_inbox' | 'portal_domain' | 'dns_record' | 'inventory_change_log' | 'invoice' | 'invoice_summary' | 'invoice_line' | 'invoice_allocation' | 'invoice_for_payment' | 'shipment' | 'shipment_summary' | 'shipment_line' | 'shipping_case' | 'shipping_case_label_url' | 'settlement' | 'settlement_summary' | 'role_permission' | 'registration_flow' | 'registration_flow_option' | 'transaction' | 'transaction_summary' | 'transaction_method' | 'transaction_type' | 'transaction_allocation' | 'usage_item' | 'account_usage_response' | 'subscription_info' | 'billing_portal_session_response' | 'switch_plan_response' | 'ensure_billing_customer_response' | 'spending_cap_response' | 'agent_spend_info' | 'webhook_response' | 'address_suggestion' | 'address_components' | 'address_details_result' | 'validated_address' | 'plan_limit' | 'plan_change_proration' | 'plan_change_line_item' | 'setup_billing_response' | 'confirm_payment_response' | 'oauth_response' | 'oauth_status_response' | 'stripe_publishable_key' | 'stripe_status' | 'healthcheck' | 'agent_definition_config' | 'trigger_config' | 'customer_contact_info' | 'customer_freight_preferences' | 'customer_defaults' | 'customer_notification_preferences' | 'order_notification_recipient' | 'order_discount' | 'sales_order_line' | 'sales_order_type' | 'sales_order_status' | 'material' | 'supplier_material' | 'part' | 'permission_group' | 'permission' | 'pick' | 'pick_line' | 'product_type' | 'production' | 'production_flow' | 'map' | 'purchase_order' | 'purchase_order_line' | 'supplier' | 'supplier_summary' | 'receivable_entry' | 'receiving_order' | 'receiving_order_line' | 'email_contact' | 'allocation_entry' | 'open_credit_entry' | 'volume_discount' | 'volume_discount_tier' | 'analyze_deliveries_response' | 'analyze_manufacturing_response' | 'analyze_manufacturing_batch_response' | 'analyze_quarterly_orders_response' | 'analyze_new_customers_response' | 'analyze_demand_forecast_response' | 'analyze_oee_response' | 'analyze_oee_trend_response' | 'analyze_schedule_attainment_response' | 'catalog_product_line' | 'catalog_category' | 'catalog_product' | 'catalog_property' | 'catalog_attribute' | 'dc_location' | 'edi_run' | 'inventory_item' | 'analyze_weeks_of_sales_response' | 'bulk_reconcile_items_response' | 'sys_property' | 'sys_property_type' | 'sys_property_value' | 'territory' | 'tenancy' | 'checkout_session' | 'estimate_rate_result' | 'rate_shop_option' | 'rate_shop_result' | 'owner' | 'created_by' | 'message' | 'account_photo_upload_result' | 'user_photo_upload_result' | 'user_photo_url' | 'batch_lot' | 'check_duplicate_result' | 'item_trend_point' | 'pack_pick_response' | 'pick_shipments_response' | 'tenancy_pending_registration' | 'invoice_allocation_entry' | 'allocation_customer' | 'checkout_sales_order' | 'sales_order_price_quote' | 'sales_order_freight_quote' | 'sales_order_price_quote_line' | 'sales_order_quote_rate' | 'hubspot_sync_job' | 'hubspot_sync_report' | 'hubspot_company_review' | 'hubspot_company_candidate' | 'hubspot_sync_record' | 'contact_match' | 'reply_draft' | 'conversation_link' | 'messaging_group' | 'messaging_group_member' | 'portal_profile' | 'portal_registration_session' | 'portal_registration_session_data' | 'pack_list' | 'pack_list_party' | 'pack_list_line_item' | 'pack_list_back_order' | 'pack_list_case' | 'job'>;
|
|
326
|
+
resource_types?: Array<'account' | 'actor' | 'entity' | 'record' | 'freight' | 'sales_order_totals' | 'sales_order_stage_total' | 'sales_order_related' | 'order_contact' | 'user' | 'address' | 'api_key' | 'created_api_key' | 'refresh_token' | 'list' | 'sandbox' | 'registration_session' | 'pricing_plan' | 'account_plan' | 'plan_change' | 'enterprise_inquiry' | 'request_log' | 'audit_event' | 'audit_field_change' | 'role' | 'unit' | 'account_affiliation' | 'agent_definition' | 'available_tool' | 'agent_definition_tool' | 'agent_account_status' | 'agent_run' | 'agent_action' | 'agent_run_step' | 'agent_token_usage' | 'agent_memory' | 'notification' | 'notification_unread_count' | 'notification_send_result' | 'notification_unread_summary' | 'announcement' | 'conversation' | 'support_case' | 'conversation_participant' | 'read_cursor' | 'chat_message' | 'notification_unread_summary_account' | 'messaging_block' | 'notification_preference' | 'message_attachment' | 'attachment_upload_target' | 'scheduled_message' | 'messaging_contact' | 'message_report' | 'tool_group' | 'model' | 'payment_term' | 'shipping_term' | 'quantity' | 'account_group' | 'support_route' | 'support_availability' | 'account_status' | 'geolocation' | 'account_user' | 'department' | 'account_integration' | 'account_price' | 'product_line' | 'item_category' | 'attribute' | 'rate' | 'account_group_product_line_access' | 'sales_target' | 'adjustment_type' | 'account_branding' | 'account_portal' | 'account_logo_url' | 'account_favicon_url' | 'public_account' | 'property' | 'carrier' | 'service_level' | 'item' | 'item_lot_default' | 'item_inventory' | 'product' | 'batch' | 'batch_flow_node' | 'scanning_consumption' | 'open_batch_summary' | 'scanning_production_step_info' | 'scanning_station' | 'production_step' | 'production_run' | 'machine' | 'machine_status' | 'machine_downtime_event' | 'demand_override' | 'demand_override_type' | 'machine_downtime_reason' | 'production_schedule_preview' | 'production_schedule_regenerate_preview' | 'production_schedule' | 'production_schedule_line' | 'production_schedule_deviation' | 'production_schedule_derived_line' | 'production_schedule_settings' | 'production_schedule_resource_setting' | 'production_schedule_item_setting' | 'fulfillment_recommendation' | 'analyze_delivery_performance_response' | 'delivery_performance' | 'delivery_backlog_bucket' | 'schedule_order_coverage' | 'schedule_order_coverage_line' | 'promise_date_quote' | 'schedule_deviation_type' | 'schedule_at_risk_order' | 'production_schedule_finished_policy' | 'production_schedule_week_release' | 'production_schedule_week_release_preview' | 'production_schedule_item_policy' | 'child_account' | 'unit_group' | 'unit_group_unit' | 'consumption' | 'customer_product_line_access' | 'customer' | 'frequently_ordered_product' | 'priority' | 'delivery' | 'delivery_line' | 'sales_order' | 'location' | 'location_type' | 'lot' | 'email_log' | 'email_domain' | 'email_inbox' | 'portal_domain' | 'dns_record' | 'inventory_change_log' | 'invoice' | 'invoice_summary' | 'invoice_line' | 'invoice_allocation' | 'invoice_for_payment' | 'shipment' | 'shipment_summary' | 'shipment_line' | 'shipping_case' | 'shipping_case_label_url' | 'settlement' | 'settlement_summary' | 'role_permission' | 'registration_flow' | 'registration_flow_option' | 'transaction' | 'transaction_summary' | 'transaction_method' | 'transaction_type' | 'transaction_allocation' | 'usage_item' | 'account_usage_response' | 'subscription_info' | 'billing_portal_session_response' | 'switch_plan_response' | 'ensure_billing_customer_response' | 'spending_cap_response' | 'agent_spend_info' | 'webhook_response' | 'address_suggestion' | 'address_components' | 'address_details_result' | 'validated_address' | 'plan_limit' | 'plan_change_proration' | 'plan_change_line_item' | 'setup_billing_response' | 'confirm_payment_response' | 'oauth_response' | 'oauth_status_response' | 'stripe_publishable_key' | 'stripe_status' | 'healthcheck' | 'agent_definition_config' | 'trigger_config' | 'customer_contact_info' | 'customer_freight_preferences' | 'customer_defaults' | 'customer_lead_time' | 'customer_notification_preferences' | 'order_notification_recipient' | 'order_discount' | 'sales_order_line' | 'sales_order_type' | 'sales_order_status' | 'material' | 'supplier_material' | 'part' | 'permission_group' | 'permission' | 'pick' | 'pick_line' | 'product_type' | 'production' | 'production_flow' | 'map' | 'purchase_order' | 'purchase_order_line' | 'supplier' | 'supplier_summary' | 'receivable_entry' | 'receiving_order' | 'receiving_order_line' | 'email_contact' | 'allocation_entry' | 'open_credit_entry' | 'volume_discount' | 'volume_discount_tier' | 'analyze_deliveries_response' | 'analyze_manufacturing_response' | 'analyze_manufacturing_batch_response' | 'analyze_quarterly_orders_response' | 'analyze_new_customers_response' | 'analyze_demand_forecast_response' | 'analyze_oee_response' | 'analyze_oee_trend_response' | 'analyze_schedule_attainment_response' | 'catalog_product_line' | 'catalog_category' | 'catalog_product' | 'catalog_property' | 'catalog_attribute' | 'dc_location' | 'edi_run' | 'inventory_item' | 'analyze_weeks_of_sales_response' | 'bulk_reconcile_items_response' | 'sys_property' | 'sys_property_type' | 'sys_property_value' | 'territory' | 'tenancy' | 'checkout_session' | 'estimate_rate_result' | 'rate_shop_option' | 'rate_shop_result' | 'owner' | 'created_by' | 'message' | 'account_photo_upload_result' | 'user_photo_upload_result' | 'user_photo_url' | 'batch_lot' | 'check_duplicate_result' | 'item_trend_point' | 'pack_pick_response' | 'pick_shipments_response' | 'tenancy_pending_registration' | 'invoice_allocation_entry' | 'allocation_customer' | 'checkout_sales_order' | 'sales_order_price_quote' | 'sales_order_freight_quote' | 'sales_order_price_quote_line' | 'sales_order_quote_rate' | 'hubspot_sync_job' | 'hubspot_sync_report' | 'hubspot_company_review' | 'hubspot_company_candidate' | 'hubspot_sync_record' | 'contact_match' | 'reply_draft' | 'conversation_link' | 'messaging_group' | 'messaging_group_member' | 'portal_profile' | 'portal_registration_session' | 'portal_registration_session_data' | 'pack_list' | 'pack_list_party' | 'pack_list_line_item' | 'pack_list_back_order' | 'pack_list_case' | 'job'>;
|
|
327
327
|
/**
|
|
328
328
|
* ID of the root record whose history tree to return.
|
|
329
329
|
*
|
|
@@ -338,7 +338,7 @@ export interface AuditEventListParams {
|
|
|
338
338
|
* picks, shipments, and invoices. Both `root_resource_type` and `root_resource_id`
|
|
339
339
|
* must be supplied together; supplying only one has no effect.
|
|
340
340
|
*/
|
|
341
|
-
root_resource_type?: 'account' | 'actor' | 'entity' | 'record' | 'freight' | 'sales_order_totals' | 'sales_order_stage_total' | 'sales_order_related' | 'order_contact' | 'user' | 'address' | 'api_key' | 'created_api_key' | 'refresh_token' | 'list' | 'sandbox' | 'registration_session' | 'pricing_plan' | 'account_plan' | 'plan_change' | 'enterprise_inquiry' | 'request_log' | 'audit_event' | 'audit_field_change' | 'role' | 'unit' | 'account_affiliation' | 'agent_definition' | 'available_tool' | 'agent_definition_tool' | 'agent_account_status' | 'agent_run' | 'agent_action' | 'agent_run_step' | 'agent_token_usage' | 'agent_memory' | 'notification' | 'notification_unread_count' | 'notification_send_result' | 'notification_unread_summary' | 'announcement' | 'conversation' | 'support_case' | 'conversation_participant' | 'read_cursor' | 'chat_message' | 'notification_unread_summary_account' | 'messaging_block' | 'notification_preference' | 'message_attachment' | 'attachment_upload_target' | 'scheduled_message' | 'messaging_contact' | 'message_report' | 'tool_group' | 'model' | 'payment_term' | 'shipping_term' | 'quantity' | 'account_group' | 'support_route' | 'support_availability' | 'account_status' | 'geolocation' | 'account_user' | 'department' | 'account_integration' | 'account_price' | 'product_line' | 'item_category' | 'attribute' | 'rate' | 'account_group_product_line_access' | 'sales_target' | 'adjustment_type' | 'account_branding' | 'account_portal' | 'account_logo_url' | 'account_favicon_url' | 'public_account' | 'property' | 'carrier' | 'service_level' | 'item' | 'item_lot_default' | 'item_inventory' | 'product' | 'batch' | 'batch_flow_node' | 'scanning_consumption' | 'open_batch_summary' | 'scanning_production_step_info' | 'scanning_station' | 'production_step' | 'production_run' | 'machine' | 'machine_status' | 'machine_downtime_event' | 'demand_override' | 'demand_override_type' | 'machine_downtime_reason' | 'production_schedule_preview' | 'production_schedule_regenerate_preview' | 'production_schedule' | 'production_schedule_line' | 'production_schedule_deviation' | 'production_schedule_derived_line' | 'production_schedule_settings' | 'production_schedule_resource_setting' | 'schedule_deviation_type' | 'production_schedule_finished_policy' | 'production_schedule_week_release' | 'production_schedule_week_release_preview' | 'production_schedule_item_policy' | 'child_account' | 'unit_group' | 'unit_group_unit' | 'consumption' | 'customer_product_line_access' | 'customer' | 'frequently_ordered_product' | 'priority' | 'delivery' | 'delivery_line' | 'sales_order' | 'location' | 'location_type' | 'lot' | 'email_log' | 'email_domain' | 'email_inbox' | 'portal_domain' | 'dns_record' | 'inventory_change_log' | 'invoice' | 'invoice_summary' | 'invoice_line' | 'invoice_allocation' | 'invoice_for_payment' | 'shipment' | 'shipment_summary' | 'shipment_line' | 'shipping_case' | 'shipping_case_label_url' | 'settlement' | 'settlement_summary' | 'role_permission' | 'registration_flow' | 'registration_flow_option' | 'transaction' | 'transaction_summary' | 'transaction_method' | 'transaction_type' | 'transaction_allocation' | 'usage_item' | 'account_usage_response' | 'subscription_info' | 'billing_portal_session_response' | 'switch_plan_response' | 'ensure_billing_customer_response' | 'spending_cap_response' | 'agent_spend_info' | 'webhook_response' | 'address_suggestion' | 'address_components' | 'address_details_result' | 'validated_address' | 'plan_limit' | 'plan_change_proration' | 'plan_change_line_item' | 'setup_billing_response' | 'confirm_payment_response' | 'oauth_response' | 'oauth_status_response' | 'stripe_publishable_key' | 'stripe_status' | 'healthcheck' | 'agent_definition_config' | 'trigger_config' | 'customer_contact_info' | 'customer_freight_preferences' | 'customer_defaults' | 'customer_notification_preferences' | 'order_notification_recipient' | 'order_discount' | 'sales_order_line' | 'sales_order_type' | 'sales_order_status' | 'material' | 'supplier_material' | 'part' | 'permission_group' | 'permission' | 'pick' | 'pick_line' | 'product_type' | 'production' | 'production_flow' | 'map' | 'purchase_order' | 'purchase_order_line' | 'supplier' | 'supplier_summary' | 'receivable_entry' | 'receiving_order' | 'receiving_order_line' | 'email_contact' | 'allocation_entry' | 'open_credit_entry' | 'volume_discount' | 'volume_discount_tier' | 'analyze_deliveries_response' | 'analyze_manufacturing_response' | 'analyze_manufacturing_batch_response' | 'analyze_quarterly_orders_response' | 'analyze_new_customers_response' | 'analyze_demand_forecast_response' | 'analyze_oee_response' | 'analyze_oee_trend_response' | 'analyze_schedule_attainment_response' | 'catalog_product_line' | 'catalog_category' | 'catalog_product' | 'catalog_property' | 'catalog_attribute' | 'dc_location' | 'edi_run' | 'inventory_item' | 'analyze_weeks_of_sales_response' | 'bulk_reconcile_items_response' | 'sys_property' | 'sys_property_type' | 'sys_property_value' | 'territory' | 'tenancy' | 'checkout_session' | 'estimate_rate_result' | 'rate_shop_option' | 'rate_shop_result' | 'owner' | 'created_by' | 'message' | 'account_photo_upload_result' | 'user_photo_upload_result' | 'user_photo_url' | 'batch_lot' | 'check_duplicate_result' | 'item_trend_point' | 'pack_pick_response' | 'pick_shipments_response' | 'tenancy_pending_registration' | 'invoice_allocation_entry' | 'allocation_customer' | 'checkout_sales_order' | 'sales_order_price_quote' | 'sales_order_freight_quote' | 'sales_order_price_quote_line' | 'sales_order_quote_rate' | 'hubspot_sync_job' | 'hubspot_sync_report' | 'hubspot_company_review' | 'hubspot_company_candidate' | 'hubspot_sync_record' | 'contact_match' | 'reply_draft' | 'conversation_link' | 'messaging_group' | 'messaging_group_member' | 'portal_profile' | 'portal_registration_session' | 'portal_registration_session_data' | 'pack_list' | 'pack_list_party' | 'pack_list_line_item' | 'pack_list_back_order' | 'pack_list_case' | 'job';
|
|
341
|
+
root_resource_type?: 'account' | 'actor' | 'entity' | 'record' | 'freight' | 'sales_order_totals' | 'sales_order_stage_total' | 'sales_order_related' | 'order_contact' | 'user' | 'address' | 'api_key' | 'created_api_key' | 'refresh_token' | 'list' | 'sandbox' | 'registration_session' | 'pricing_plan' | 'account_plan' | 'plan_change' | 'enterprise_inquiry' | 'request_log' | 'audit_event' | 'audit_field_change' | 'role' | 'unit' | 'account_affiliation' | 'agent_definition' | 'available_tool' | 'agent_definition_tool' | 'agent_account_status' | 'agent_run' | 'agent_action' | 'agent_run_step' | 'agent_token_usage' | 'agent_memory' | 'notification' | 'notification_unread_count' | 'notification_send_result' | 'notification_unread_summary' | 'announcement' | 'conversation' | 'support_case' | 'conversation_participant' | 'read_cursor' | 'chat_message' | 'notification_unread_summary_account' | 'messaging_block' | 'notification_preference' | 'message_attachment' | 'attachment_upload_target' | 'scheduled_message' | 'messaging_contact' | 'message_report' | 'tool_group' | 'model' | 'payment_term' | 'shipping_term' | 'quantity' | 'account_group' | 'support_route' | 'support_availability' | 'account_status' | 'geolocation' | 'account_user' | 'department' | 'account_integration' | 'account_price' | 'product_line' | 'item_category' | 'attribute' | 'rate' | 'account_group_product_line_access' | 'sales_target' | 'adjustment_type' | 'account_branding' | 'account_portal' | 'account_logo_url' | 'account_favicon_url' | 'public_account' | 'property' | 'carrier' | 'service_level' | 'item' | 'item_lot_default' | 'item_inventory' | 'product' | 'batch' | 'batch_flow_node' | 'scanning_consumption' | 'open_batch_summary' | 'scanning_production_step_info' | 'scanning_station' | 'production_step' | 'production_run' | 'machine' | 'machine_status' | 'machine_downtime_event' | 'demand_override' | 'demand_override_type' | 'machine_downtime_reason' | 'production_schedule_preview' | 'production_schedule_regenerate_preview' | 'production_schedule' | 'production_schedule_line' | 'production_schedule_deviation' | 'production_schedule_derived_line' | 'production_schedule_settings' | 'production_schedule_resource_setting' | 'production_schedule_item_setting' | 'fulfillment_recommendation' | 'analyze_delivery_performance_response' | 'delivery_performance' | 'delivery_backlog_bucket' | 'schedule_order_coverage' | 'schedule_order_coverage_line' | 'promise_date_quote' | 'schedule_deviation_type' | 'schedule_at_risk_order' | 'production_schedule_finished_policy' | 'production_schedule_week_release' | 'production_schedule_week_release_preview' | 'production_schedule_item_policy' | 'child_account' | 'unit_group' | 'unit_group_unit' | 'consumption' | 'customer_product_line_access' | 'customer' | 'frequently_ordered_product' | 'priority' | 'delivery' | 'delivery_line' | 'sales_order' | 'location' | 'location_type' | 'lot' | 'email_log' | 'email_domain' | 'email_inbox' | 'portal_domain' | 'dns_record' | 'inventory_change_log' | 'invoice' | 'invoice_summary' | 'invoice_line' | 'invoice_allocation' | 'invoice_for_payment' | 'shipment' | 'shipment_summary' | 'shipment_line' | 'shipping_case' | 'shipping_case_label_url' | 'settlement' | 'settlement_summary' | 'role_permission' | 'registration_flow' | 'registration_flow_option' | 'transaction' | 'transaction_summary' | 'transaction_method' | 'transaction_type' | 'transaction_allocation' | 'usage_item' | 'account_usage_response' | 'subscription_info' | 'billing_portal_session_response' | 'switch_plan_response' | 'ensure_billing_customer_response' | 'spending_cap_response' | 'agent_spend_info' | 'webhook_response' | 'address_suggestion' | 'address_components' | 'address_details_result' | 'validated_address' | 'plan_limit' | 'plan_change_proration' | 'plan_change_line_item' | 'setup_billing_response' | 'confirm_payment_response' | 'oauth_response' | 'oauth_status_response' | 'stripe_publishable_key' | 'stripe_status' | 'healthcheck' | 'agent_definition_config' | 'trigger_config' | 'customer_contact_info' | 'customer_freight_preferences' | 'customer_defaults' | 'customer_lead_time' | 'customer_notification_preferences' | 'order_notification_recipient' | 'order_discount' | 'sales_order_line' | 'sales_order_type' | 'sales_order_status' | 'material' | 'supplier_material' | 'part' | 'permission_group' | 'permission' | 'pick' | 'pick_line' | 'product_type' | 'production' | 'production_flow' | 'map' | 'purchase_order' | 'purchase_order_line' | 'supplier' | 'supplier_summary' | 'receivable_entry' | 'receiving_order' | 'receiving_order_line' | 'email_contact' | 'allocation_entry' | 'open_credit_entry' | 'volume_discount' | 'volume_discount_tier' | 'analyze_deliveries_response' | 'analyze_manufacturing_response' | 'analyze_manufacturing_batch_response' | 'analyze_quarterly_orders_response' | 'analyze_new_customers_response' | 'analyze_demand_forecast_response' | 'analyze_oee_response' | 'analyze_oee_trend_response' | 'analyze_schedule_attainment_response' | 'catalog_product_line' | 'catalog_category' | 'catalog_product' | 'catalog_property' | 'catalog_attribute' | 'dc_location' | 'edi_run' | 'inventory_item' | 'analyze_weeks_of_sales_response' | 'bulk_reconcile_items_response' | 'sys_property' | 'sys_property_type' | 'sys_property_value' | 'territory' | 'tenancy' | 'checkout_session' | 'estimate_rate_result' | 'rate_shop_option' | 'rate_shop_result' | 'owner' | 'created_by' | 'message' | 'account_photo_upload_result' | 'user_photo_upload_result' | 'user_photo_url' | 'batch_lot' | 'check_duplicate_result' | 'item_trend_point' | 'pack_pick_response' | 'pick_shipments_response' | 'tenancy_pending_registration' | 'invoice_allocation_entry' | 'allocation_customer' | 'checkout_sales_order' | 'sales_order_price_quote' | 'sales_order_freight_quote' | 'sales_order_price_quote_line' | 'sales_order_quote_rate' | 'hubspot_sync_job' | 'hubspot_sync_report' | 'hubspot_company_review' | 'hubspot_company_candidate' | 'hubspot_sync_record' | 'contact_match' | 'reply_draft' | 'conversation_link' | 'messaging_group' | 'messaging_group_member' | 'portal_profile' | 'portal_registration_session' | 'portal_registration_session_data' | 'pack_list' | 'pack_list_party' | 'pack_list_line_item' | 'pack_list_back_order' | 'pack_list_case' | 'job';
|
|
342
342
|
/**
|
|
343
343
|
* Restricts results to audit events on or after this timestamp.
|
|
344
344
|
*/
|