@augno/sdk 0.18.0 → 0.18.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 +4 -7
- package/package.json +1 -1
- package/resources/ai/memories.d.mts +6 -6
- package/resources/ai/memories.d.mts.map +1 -1
- package/resources/ai/memories.d.ts +6 -6
- package/resources/ai/memories.d.ts.map +1 -1
- package/resources/auth/api-keys/api-keys.d.mts +8 -0
- package/resources/auth/api-keys/api-keys.d.mts.map +1 -1
- package/resources/auth/api-keys/api-keys.d.ts +8 -0
- package/resources/auth/api-keys/api-keys.d.ts.map +1 -1
- package/resources/auth/api-keys/api-keys.js.map +1 -1
- package/resources/auth/api-keys/api-keys.mjs.map +1 -1
- package/resources/catalog/items/attributes.d.mts +3 -0
- package/resources/catalog/items/attributes.d.mts.map +1 -1
- package/resources/catalog/items/attributes.d.ts +3 -0
- package/resources/catalog/items/attributes.d.ts.map +1 -1
- package/resources/catalog/items/attributes.js +3 -0
- package/resources/catalog/items/attributes.js.map +1 -1
- package/resources/catalog/items/attributes.mjs +3 -0
- package/resources/catalog/items/attributes.mjs.map +1 -1
- package/resources/catalog/materials/materials.d.mts +6 -0
- package/resources/catalog/materials/materials.d.mts.map +1 -1
- package/resources/catalog/materials/materials.d.ts +6 -0
- package/resources/catalog/materials/materials.d.ts.map +1 -1
- package/resources/catalog/materials/materials.js.map +1 -1
- package/resources/catalog/materials/materials.mjs.map +1 -1
- package/resources/catalog/parts/parts.d.mts +6 -0
- package/resources/catalog/parts/parts.d.mts.map +1 -1
- package/resources/catalog/parts/parts.d.ts +6 -0
- package/resources/catalog/parts/parts.d.ts.map +1 -1
- package/resources/catalog/parts/parts.js.map +1 -1
- package/resources/catalog/parts/parts.mjs.map +1 -1
- package/resources/catalog/products/products.d.mts +6 -4
- package/resources/catalog/products/products.d.mts.map +1 -1
- package/resources/catalog/products/products.d.ts +6 -4
- package/resources/catalog/products/products.d.ts.map +1 -1
- package/resources/catalog/products/products.js.map +1 -1
- package/resources/catalog/products/products.mjs.map +1 -1
- package/resources/core/actions.d.mts +73 -0
- package/resources/core/actions.d.mts.map +1 -0
- package/resources/core/actions.d.ts +73 -0
- package/resources/core/actions.d.ts.map +1 -0
- package/resources/core/actions.js +36 -0
- package/resources/core/actions.js.map +1 -0
- package/resources/core/actions.mjs +32 -0
- package/resources/core/actions.mjs.map +1 -0
- 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 +6 -2
- package/resources/core/core.d.mts.map +1 -1
- package/resources/core/core.d.ts +6 -2
- package/resources/core/core.d.ts.map +1 -1
- package/resources/core/core.js +4 -0
- package/resources/core/core.js.map +1 -1
- package/resources/core/core.mjs +4 -0
- package/resources/core/core.mjs.map +1 -1
- package/resources/core/index.d.mts +1 -0
- package/resources/core/index.d.mts.map +1 -1
- package/resources/core/index.d.ts +1 -0
- package/resources/core/index.d.ts.map +1 -1
- package/resources/core/index.js +3 -1
- package/resources/core/index.js.map +1 -1
- package/resources/core/index.mjs +1 -0
- package/resources/core/index.mjs.map +1 -1
- package/resources/core/jobs.d.mts +1 -1
- package/resources/core/jobs.d.mts.map +1 -1
- package/resources/core/jobs.d.ts +1 -1
- package/resources/core/jobs.d.ts.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/index.d.mts +1 -0
- package/resources/operations/index.d.mts.map +1 -1
- package/resources/operations/index.d.ts +1 -0
- package/resources/operations/index.d.ts.map +1 -1
- package/resources/operations/index.js +9 -7
- 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/operating-calendars/closures.d.mts +173 -0
- package/resources/operations/operating-calendars/closures.d.mts.map +1 -0
- package/resources/operations/operating-calendars/closures.d.ts +173 -0
- package/resources/operations/operating-calendars/closures.d.ts.map +1 -0
- package/resources/operations/operating-calendars/closures.js +81 -0
- package/resources/operations/operating-calendars/closures.js.map +1 -0
- package/resources/operations/operating-calendars/closures.mjs +77 -0
- package/resources/operations/operating-calendars/closures.mjs.map +1 -0
- package/resources/operations/operating-calendars/index.d.mts +3 -0
- package/resources/operations/operating-calendars/index.d.mts.map +1 -0
- package/resources/operations/operating-calendars/index.d.ts +3 -0
- package/resources/operations/operating-calendars/index.d.ts.map +1 -0
- package/resources/operations/operating-calendars/index.js +9 -0
- package/resources/operations/operating-calendars/index.js.map +1 -0
- package/resources/operations/operating-calendars/index.mjs +4 -0
- package/resources/operations/operating-calendars/index.mjs.map +1 -0
- package/resources/operations/operating-calendars/operating-calendars.d.mts +332 -0
- package/resources/operations/operating-calendars/operating-calendars.d.mts.map +1 -0
- package/resources/operations/operating-calendars/operating-calendars.d.ts +332 -0
- package/resources/operations/operating-calendars/operating-calendars.d.ts.map +1 -0
- package/resources/operations/operating-calendars/operating-calendars.js +129 -0
- package/resources/operations/operating-calendars/operating-calendars.js.map +1 -0
- package/resources/operations/operating-calendars/operating-calendars.mjs +124 -0
- package/resources/operations/operating-calendars/operating-calendars.mjs.map +1 -0
- package/resources/operations/operating-calendars.d.mts +2 -0
- package/resources/operations/operating-calendars.d.mts.map +1 -0
- package/resources/operations/operating-calendars.d.ts +2 -0
- package/resources/operations/operating-calendars.d.ts.map +1 -0
- package/resources/operations/operating-calendars.js +6 -0
- package/resources/operations/operating-calendars.js.map +1 -0
- package/resources/operations/operating-calendars.mjs +3 -0
- package/resources/operations/operating-calendars.mjs.map +1 -0
- package/resources/operations/operations.d.mts +4 -0
- package/resources/operations/operations.d.mts.map +1 -1
- package/resources/operations/operations.d.ts +4 -0
- 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/production-schedule-settings.d.mts +30 -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 +30 -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.map +1 -1
- package/resources/operations/production-schedule-settings/production-schedule-settings.mjs.map +1 -1
- package/resources/operations/production-schedules/lines.d.mts +10 -6
- package/resources/operations/production-schedules/lines.d.mts.map +1 -1
- package/resources/operations/production-schedules/lines.d.ts +10 -6
- package/resources/operations/production-schedules/lines.d.ts.map +1 -1
- package/resources/sales/account-prices/account-prices.d.mts +8 -0
- package/resources/sales/account-prices/account-prices.d.mts.map +1 -1
- package/resources/sales/account-prices/account-prices.d.ts +8 -0
- package/resources/sales/account-prices/account-prices.d.ts.map +1 -1
- package/resources/sales/account-prices/account-prices.js.map +1 -1
- package/resources/sales/account-prices/account-prices.mjs.map +1 -1
- package/resources/sales/addresses.d.mts +20 -0
- package/resources/sales/addresses.d.mts.map +1 -1
- package/resources/sales/addresses.d.ts +20 -0
- package/resources/sales/addresses.d.ts.map +1 -1
- package/resources/sales/customers/customers.d.mts +30 -1
- package/resources/sales/customers/customers.d.mts.map +1 -1
- package/resources/sales/customers/customers.d.ts +30 -1
- package/resources/sales/customers/customers.d.ts.map +1 -1
- package/resources/sales/customers/customers.js.map +1 -1
- package/resources/sales/customers/customers.mjs.map +1 -1
- package/resources/sales/sales-orders/actions.d.mts +205 -1
- package/resources/sales/sales-orders/actions.d.mts.map +1 -1
- package/resources/sales/sales-orders/actions.d.ts +205 -1
- package/resources/sales/sales-orders/actions.d.ts.map +1 -1
- package/resources/sales/sales-orders/actions.js +36 -0
- package/resources/sales/sales-orders/actions.js.map +1 -1
- package/resources/sales/sales-orders/actions.mjs +36 -0
- package/resources/sales/sales-orders/actions.mjs.map +1 -1
- package/resources/sales/sales-orders/index.d.mts +1 -1
- package/resources/sales/sales-orders/index.d.mts.map +1 -1
- package/resources/sales/sales-orders/index.d.ts +1 -1
- package/resources/sales/sales-orders/index.d.ts.map +1 -1
- package/resources/sales/sales-orders/index.js.map +1 -1
- package/resources/sales/sales-orders/index.mjs.map +1 -1
- package/resources/sales/sales-orders/sales-orders.d.mts +105 -9
- package/resources/sales/sales-orders/sales-orders.d.mts.map +1 -1
- package/resources/sales/sales-orders/sales-orders.d.ts +105 -9
- 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/src/resources/ai/memories.ts +6 -6
- package/src/resources/auth/api-keys/api-keys.ts +9 -0
- package/src/resources/catalog/items/attributes.ts +3 -0
- package/src/resources/catalog/materials/materials.ts +6 -0
- package/src/resources/catalog/parts/parts.ts +6 -0
- package/src/resources/catalog/products/products.ts +6 -4
- package/src/resources/core/actions.ts +89 -0
- package/src/resources/core/audit-events.ts +12 -0
- package/src/resources/core/core.ts +17 -0
- package/src/resources/core/index.ts +6 -0
- package/src/resources/core/jobs.ts +3 -0
- package/src/resources/messaging/conversations/conversations.ts +9 -0
- package/src/resources/messaging/conversations/links.ts +6 -0
- package/src/resources/messaging/conversations/messages.ts +6 -0
- package/src/resources/messaging/notifications/notifications.ts +6 -0
- package/src/resources/operations/index.ts +11 -0
- package/src/resources/operations/operating-calendars/closures.ts +223 -0
- package/src/resources/operations/operating-calendars/index.ts +23 -0
- package/src/resources/operations/operating-calendars/operating-calendars.ts +427 -0
- package/src/resources/operations/operating-calendars.ts +3 -0
- package/src/resources/operations/operations.ts +28 -0
- package/src/resources/operations/production-schedule-settings/production-schedule-settings.ts +36 -0
- package/src/resources/operations/production-schedules/lines.ts +10 -6
- package/src/resources/sales/account-prices/account-prices.ts +9 -0
- package/src/resources/sales/addresses.ts +24 -0
- package/src/resources/sales/customers/customers.ts +34 -1
- package/src/resources/sales/sales-orders/actions.ts +252 -0
- package/src/resources/sales/sales-orders/index.ts +4 -0
- package/src/resources/sales/sales-orders/sales-orders.ts +130 -7
- 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
|
@@ -123,6 +123,40 @@ export declare class Actions extends APIResource {
|
|
|
123
123
|
* ```
|
|
124
124
|
*/
|
|
125
125
|
quoteFreight(id: string, options?: RequestOptions): APIPromise<QuoteSalesOrderFreightResponse>;
|
|
126
|
+
/**
|
|
127
|
+
* Previews the ship-by date a set of commitment inputs would produce, without
|
|
128
|
+
* creating or changing anything.
|
|
129
|
+
*
|
|
130
|
+
* Runs the same resolution an order runs when it is issued: a promised delivery
|
|
131
|
+
* date has the customer's receiving days, the carrier's transit, and the plant's
|
|
132
|
+
* shipping days worked back through it, while a lead time or a pinned ship date is
|
|
133
|
+
* snapped onto the next earlier day the plant ships. The returned steps are that
|
|
134
|
+
* derivation in order, so a caller can show why a date is what it is rather than
|
|
135
|
+
* restating the rules.
|
|
136
|
+
*
|
|
137
|
+
* At most one of `promised_at`, `lead_time_override_days`, and
|
|
138
|
+
* `ship_by_override_date` may be set; they are alternative answers to the same
|
|
139
|
+
* question.
|
|
140
|
+
*
|
|
141
|
+
* Advisory rather than binding. Carrier transit comes from a lane cache warmed in
|
|
142
|
+
* the background, so a lane nobody has shipped yet quotes against the service
|
|
143
|
+
* level's default or against no transit at all, and the date stamped at issue may
|
|
144
|
+
* differ once the lane has been rated.
|
|
145
|
+
*
|
|
146
|
+
* This endpoint requires the permission: `sales_orders:read`.
|
|
147
|
+
*
|
|
148
|
+
* @example
|
|
149
|
+
* ```ts
|
|
150
|
+
* const quoteSalesOrderCommitmentResponse =
|
|
151
|
+
* await client.sales.salesOrders.actions.quoteCommitment({
|
|
152
|
+
* buyer_account_id: 'ac_ykxoradjoeb3',
|
|
153
|
+
* promised_at: '2026-08-22T00:00:00Z',
|
|
154
|
+
* service_level_id: 'crop_4ilk9p6gccrx',
|
|
155
|
+
* ship_to_address_id: 'ad_npqa5y43q26z',
|
|
156
|
+
* });
|
|
157
|
+
* ```
|
|
158
|
+
*/
|
|
159
|
+
quoteCommitment(body?: ActionQuoteCommitmentParams | null | undefined, options?: RequestOptions): APIPromise<QuoteSalesOrderCommitmentResponse>;
|
|
126
160
|
/**
|
|
127
161
|
* Creates a production run from a sales order.
|
|
128
162
|
*
|
|
@@ -155,6 +189,34 @@ export interface BulkDeleteSalesOrdersRequest {
|
|
|
155
189
|
*/
|
|
156
190
|
sales_order_ids: Array<string>;
|
|
157
191
|
}
|
|
192
|
+
/**
|
|
193
|
+
* CommitmentQuoteStep is one rule's contribution to a previewed ship-by date.
|
|
194
|
+
*
|
|
195
|
+
* Returned as an ordered list so a caller can show why a date is what it is
|
|
196
|
+
* without reimplementing the arithmetic, and so the explanation cannot drift from
|
|
197
|
+
* the calculation that produced it.
|
|
198
|
+
*/
|
|
199
|
+
export interface CommitmentQuoteStep {
|
|
200
|
+
/**
|
|
201
|
+
* Which rule applied.
|
|
202
|
+
*/
|
|
203
|
+
code: 'basis' | 'receive_calendar' | 'carrier_transit' | 'ship_calendar' | 'pickup_cutoff';
|
|
204
|
+
/**
|
|
205
|
+
* Where the running date stood after this rule.
|
|
206
|
+
*/
|
|
207
|
+
date: string;
|
|
208
|
+
/**
|
|
209
|
+
* How far this rule pulled the date back. Zero means the rule applied and changed
|
|
210
|
+
* nothing, which is worth showing: it says the date was already on an open day.
|
|
211
|
+
*/
|
|
212
|
+
days_moved: number;
|
|
213
|
+
/**
|
|
214
|
+
* The rule's own parameter — where a transit estimate came from, or the cutoff
|
|
215
|
+
* time applied. Null for a rule that takes none, rather than an empty string:
|
|
216
|
+
* snapping onto an open day has no parameter to report.
|
|
217
|
+
*/
|
|
218
|
+
detail: string | null;
|
|
219
|
+
}
|
|
158
220
|
/**
|
|
159
221
|
* Request to issue a sales order.
|
|
160
222
|
*/
|
|
@@ -224,6 +286,101 @@ export interface ProductionRun {
|
|
|
224
286
|
*/
|
|
225
287
|
updated_at: string;
|
|
226
288
|
}
|
|
289
|
+
/**
|
|
290
|
+
* Request to preview the ship-by date a set of commitment inputs would produce.
|
|
291
|
+
*/
|
|
292
|
+
export interface QuoteSalesOrderCommitmentRequest {
|
|
293
|
+
/**
|
|
294
|
+
* The buying account, used to resolve its lead time and receiving days.
|
|
295
|
+
*/
|
|
296
|
+
buyer_account_id?: string;
|
|
297
|
+
/**
|
|
298
|
+
* Carrier for the shipment.
|
|
299
|
+
*/
|
|
300
|
+
carrier_id?: string;
|
|
301
|
+
/**
|
|
302
|
+
* When the order would be issued. Defaults to now, since a lead time is measured
|
|
303
|
+
* from issue and an order built today but issued next week commits to next week's
|
|
304
|
+
* date.
|
|
305
|
+
*/
|
|
306
|
+
issued_at?: string;
|
|
307
|
+
/**
|
|
308
|
+
* Days between issue and the order being due to ship, in place of the customer's
|
|
309
|
+
* standing lead time.
|
|
310
|
+
*/
|
|
311
|
+
lead_time_override_days?: number;
|
|
312
|
+
/**
|
|
313
|
+
* Date delivery would be promised to the customer.
|
|
314
|
+
*/
|
|
315
|
+
promised_at?: string;
|
|
316
|
+
/**
|
|
317
|
+
* An existing order to preview against. Its customer, ship-to address, carrier,
|
|
318
|
+
* and service level are used, and the commitment fields below replace whatever it
|
|
319
|
+
* currently carries.
|
|
320
|
+
*
|
|
321
|
+
* Omit it to preview an order that has not been created yet, supplying the parts
|
|
322
|
+
* directly.
|
|
323
|
+
*/
|
|
324
|
+
sales_order_id?: string;
|
|
325
|
+
/**
|
|
326
|
+
* Service level for the shipment, which the lane's transit estimate is keyed on.
|
|
327
|
+
*/
|
|
328
|
+
service_level_id?: string;
|
|
329
|
+
/**
|
|
330
|
+
* The exact date the order would be due to ship.
|
|
331
|
+
*/
|
|
332
|
+
ship_by_override_date?: string;
|
|
333
|
+
/**
|
|
334
|
+
* The ship-to address, which decides the destination timezone and the lane transit
|
|
335
|
+
* is quoted on.
|
|
336
|
+
*/
|
|
337
|
+
ship_to_address_id?: string;
|
|
338
|
+
}
|
|
339
|
+
/**
|
|
340
|
+
* The ship-by date a set of commitment inputs would produce, and how it was
|
|
341
|
+
* reached.
|
|
342
|
+
*/
|
|
343
|
+
export interface QuoteSalesOrderCommitmentResponse {
|
|
344
|
+
/**
|
|
345
|
+
* Days the receiving and shipping calendars pulled the date back, beyond what
|
|
346
|
+
* transit accounted for.
|
|
347
|
+
*/
|
|
348
|
+
calendar_adjustment_days: number;
|
|
349
|
+
/**
|
|
350
|
+
* Calendar days between issue and the ship-by date.
|
|
351
|
+
*/
|
|
352
|
+
lead_time_days: number | null;
|
|
353
|
+
/**
|
|
354
|
+
* Which rule produced the date.
|
|
355
|
+
*/
|
|
356
|
+
lead_time_source: 'customer' | 'account_group' | 'account' | 'manual' | 'order_lead_time' | 'order_ship_by' | null;
|
|
357
|
+
/**
|
|
358
|
+
* Resource type identifier.
|
|
359
|
+
*/
|
|
360
|
+
object: 'sales_order_commitment_quote';
|
|
361
|
+
/**
|
|
362
|
+
* That date at the plant's pickup cutoff — the moment freight would have to be
|
|
363
|
+
* tendered by. Null when the shipping calendar carries no cutoff.
|
|
364
|
+
*/
|
|
365
|
+
ship_by_cutoff_at: string | null;
|
|
366
|
+
/**
|
|
367
|
+
* The date the order would be due to ship, or null when no rule resolves one.
|
|
368
|
+
*/
|
|
369
|
+
ship_by_date: string | null;
|
|
370
|
+
/**
|
|
371
|
+
* The derivation in order, one entry per rule that moved the date.
|
|
372
|
+
*/
|
|
373
|
+
steps: Array<CommitmentQuoteStep>;
|
|
374
|
+
/**
|
|
375
|
+
* Days the carrier needs to cover the lane. Null when the lane has never been
|
|
376
|
+
* quoted and the service level carries no default.
|
|
377
|
+
*/
|
|
378
|
+
transit_days: number | null;
|
|
379
|
+
/**
|
|
380
|
+
* Where the transit estimate came from.
|
|
381
|
+
*/
|
|
382
|
+
transit_source: 'carrier_lane' | 'service_level' | null;
|
|
383
|
+
}
|
|
227
384
|
/**
|
|
228
385
|
* The freshly estimated freight charge for a sales order.
|
|
229
386
|
*/
|
|
@@ -261,6 +418,53 @@ export interface ActionIssueParams {
|
|
|
261
418
|
*/
|
|
262
419
|
notify_customer: boolean;
|
|
263
420
|
}
|
|
421
|
+
export interface ActionQuoteCommitmentParams {
|
|
422
|
+
/**
|
|
423
|
+
* The buying account, used to resolve its lead time and receiving days.
|
|
424
|
+
*/
|
|
425
|
+
buyer_account_id?: string;
|
|
426
|
+
/**
|
|
427
|
+
* Carrier for the shipment.
|
|
428
|
+
*/
|
|
429
|
+
carrier_id?: string;
|
|
430
|
+
/**
|
|
431
|
+
* When the order would be issued. Defaults to now, since a lead time is measured
|
|
432
|
+
* from issue and an order built today but issued next week commits to next week's
|
|
433
|
+
* date.
|
|
434
|
+
*/
|
|
435
|
+
issued_at?: string;
|
|
436
|
+
/**
|
|
437
|
+
* Days between issue and the order being due to ship, in place of the customer's
|
|
438
|
+
* standing lead time.
|
|
439
|
+
*/
|
|
440
|
+
lead_time_override_days?: number;
|
|
441
|
+
/**
|
|
442
|
+
* Date delivery would be promised to the customer.
|
|
443
|
+
*/
|
|
444
|
+
promised_at?: string;
|
|
445
|
+
/**
|
|
446
|
+
* An existing order to preview against. Its customer, ship-to address, carrier,
|
|
447
|
+
* and service level are used, and the commitment fields below replace whatever it
|
|
448
|
+
* currently carries.
|
|
449
|
+
*
|
|
450
|
+
* Omit it to preview an order that has not been created yet, supplying the parts
|
|
451
|
+
* directly.
|
|
452
|
+
*/
|
|
453
|
+
sales_order_id?: string;
|
|
454
|
+
/**
|
|
455
|
+
* Service level for the shipment, which the lane's transit estimate is keyed on.
|
|
456
|
+
*/
|
|
457
|
+
service_level_id?: string;
|
|
458
|
+
/**
|
|
459
|
+
* The exact date the order would be due to ship.
|
|
460
|
+
*/
|
|
461
|
+
ship_by_override_date?: string;
|
|
462
|
+
/**
|
|
463
|
+
* The ship-to address, which decides the destination timezone and the lane transit
|
|
464
|
+
* is quoted on.
|
|
465
|
+
*/
|
|
466
|
+
ship_to_address_id?: string;
|
|
467
|
+
}
|
|
264
468
|
export interface ActionCreateProductionRunParams {
|
|
265
469
|
/**
|
|
266
470
|
* Sub-objects to expand in the response. When omitted, sub-objects are returned as
|
|
@@ -269,6 +473,6 @@ export interface ActionCreateProductionRunParams {
|
|
|
269
473
|
include?: Array<'responsible_user' | 'responsible_user.user'>;
|
|
270
474
|
}
|
|
271
475
|
export declare namespace Actions {
|
|
272
|
-
export { type BulkDeleteSalesOrdersRequest as BulkDeleteSalesOrdersRequest, type IssueSalesOrderRequest as IssueSalesOrderRequest, type ProductionRun as ProductionRun, type QuoteSalesOrderFreightResponse as QuoteSalesOrderFreightResponse, type ActionBulkDeleteResponse as ActionBulkDeleteResponse, type ActionBulkDeleteParams as ActionBulkDeleteParams, type ActionIssueParams as ActionIssueParams, type ActionCreateProductionRunParams as ActionCreateProductionRunParams, };
|
|
476
|
+
export { type BulkDeleteSalesOrdersRequest as BulkDeleteSalesOrdersRequest, type CommitmentQuoteStep as CommitmentQuoteStep, type IssueSalesOrderRequest as IssueSalesOrderRequest, type ProductionRun as ProductionRun, type QuoteSalesOrderCommitmentRequest as QuoteSalesOrderCommitmentRequest, type QuoteSalesOrderCommitmentResponse as QuoteSalesOrderCommitmentResponse, type QuoteSalesOrderFreightResponse as QuoteSalesOrderFreightResponse, type ActionBulkDeleteResponse as ActionBulkDeleteResponse, type ActionBulkDeleteParams as ActionBulkDeleteParams, type ActionIssueParams as ActionIssueParams, type ActionQuoteCommitmentParams as ActionQuoteCommitmentParams, type ActionCreateProductionRunParams as ActionCreateProductionRunParams, };
|
|
273
477
|
}
|
|
274
478
|
//# sourceMappingURL=actions.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"actions.d.ts","sourceRoot":"","sources":["../../../src/resources/sales/sales-orders/actions.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,SAAS;OACd,KAAK,cAAc;OACnB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;OAgBG;IACH,UAAU,CAAC,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;IAIxG;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CACH,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,iBAAiB,EACvB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC,UAAU,CAAC;IAIxC;;;;;;;;;;;;;;;;OAgBG;IACH,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC,UAAU,CAAC;IAIpF;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC,UAAU,CAAC;IAIlF;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC,UAAU,CAAC;IAIjF;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,8BAA8B,CAAC;IAI9F;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,mBAAmB,CACjB,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,+BAA+B,GAAG,IAAI,GAAG,SAAc,EAC/D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC;CAO7B;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;;;;;OAOG;IACH,eAAe,EAAE,OAAO,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;;OAMG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,EAAE,gBAAgB,CAAC;IAEzB;;;;;;OAMG;IACH,gBAAgB,EAAE,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC;IAE/C;;;;OAIG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,MAAM,EAAE,2BAA2B,CAAC;IAEpC;;;;;;;OAOG;IACH,UAAU,EAAE,cAAc,CAAC,YAAY,GAAG,IAAI,CAAC;CAChD;AAED,MAAM,WAAW,wBAAwB;CAAG;AAE5C,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAChC;AAED,MAAM,WAAW,iBAAiB;IAChC;;;;;;;OAOG;IACH,eAAe,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,+BAA+B;IAC9C;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,kBAAkB,GAAG,uBAAuB,CAAC,CAAC;CAC/D;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,+BAA+B,IAAI,+BAA+B,GACxE,CAAC;CACH"}
|
|
1
|
+
{"version":3,"file":"actions.d.ts","sourceRoot":"","sources":["../../../src/resources/sales/sales-orders/actions.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,SAAS;OACd,KAAK,cAAc;OACnB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;OAgBG;IACH,UAAU,CAAC,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;IAIxG;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CACH,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,iBAAiB,EACvB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC,UAAU,CAAC;IAIxC;;;;;;;;;;;;;;;;OAgBG;IACH,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC,UAAU,CAAC;IAIpF;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC,UAAU,CAAC;IAIlF;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC,UAAU,CAAC;IAIjF;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,8BAA8B,CAAC;IAI9F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,eAAe,CACb,IAAI,GAAE,2BAA2B,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;IAIhD;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,mBAAmB,CACjB,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,+BAA+B,GAAG,IAAI,GAAG,SAAc,EAC/D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC;CAO7B;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAChC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,OAAO,GAAG,kBAAkB,GAAG,iBAAiB,GAAG,eAAe,GAAG,eAAe,CAAC;IAE3F;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;;;;;OAOG;IACH,eAAe,EAAE,OAAO,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;;OAMG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,EAAE,gBAAgB,CAAC;IAEzB;;;;;;OAMG;IACH,gBAAgB,EAAE,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC;IAE/C;;;;OAIG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;;OAOG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,iCAAiC;IAChD;;;OAGG;IACH,wBAAwB,EAAE,MAAM,CAAC;IAEjC;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,gBAAgB,EACZ,UAAU,GACV,eAAe,GACf,SAAS,GACT,QAAQ,GACR,iBAAiB,GACjB,eAAe,GACf,IAAI,CAAC;IAET;;OAEG;IACH,MAAM,EAAE,8BAA8B,CAAC;IAEvC;;;OAGG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;IAElC;;;OAGG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,cAAc,EAAE,cAAc,GAAG,eAAe,GAAG,IAAI,CAAC;CACzD;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,MAAM,EAAE,2BAA2B,CAAC;IAEpC;;;;;;;OAOG;IACH,UAAU,EAAE,cAAc,CAAC,YAAY,GAAG,IAAI,CAAC;CAChD;AAED,MAAM,WAAW,wBAAwB;CAAG;AAE5C,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAChC;AAED,MAAM,WAAW,iBAAiB;IAChC;;;;;;;OAOG;IACH,eAAe,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;;OAOG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,+BAA+B;IAC9C;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,kBAAkB,GAAG,uBAAuB,CAAC,CAAC;CAC/D;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,+BAA+B,IAAI,+BAA+B,GACxE,CAAC;CACH"}
|
|
@@ -136,6 +136,42 @@ class Actions extends resource_1.APIResource {
|
|
|
136
136
|
quoteFreight(id, options) {
|
|
137
137
|
return this._client.post((0, path_1.path) `/v1/sales/sales-orders/${id}/actions/quote-freight`, options);
|
|
138
138
|
}
|
|
139
|
+
/**
|
|
140
|
+
* Previews the ship-by date a set of commitment inputs would produce, without
|
|
141
|
+
* creating or changing anything.
|
|
142
|
+
*
|
|
143
|
+
* Runs the same resolution an order runs when it is issued: a promised delivery
|
|
144
|
+
* date has the customer's receiving days, the carrier's transit, and the plant's
|
|
145
|
+
* shipping days worked back through it, while a lead time or a pinned ship date is
|
|
146
|
+
* snapped onto the next earlier day the plant ships. The returned steps are that
|
|
147
|
+
* derivation in order, so a caller can show why a date is what it is rather than
|
|
148
|
+
* restating the rules.
|
|
149
|
+
*
|
|
150
|
+
* At most one of `promised_at`, `lead_time_override_days`, and
|
|
151
|
+
* `ship_by_override_date` may be set; they are alternative answers to the same
|
|
152
|
+
* question.
|
|
153
|
+
*
|
|
154
|
+
* Advisory rather than binding. Carrier transit comes from a lane cache warmed in
|
|
155
|
+
* the background, so a lane nobody has shipped yet quotes against the service
|
|
156
|
+
* level's default or against no transit at all, and the date stamped at issue may
|
|
157
|
+
* differ once the lane has been rated.
|
|
158
|
+
*
|
|
159
|
+
* This endpoint requires the permission: `sales_orders:read`.
|
|
160
|
+
*
|
|
161
|
+
* @example
|
|
162
|
+
* ```ts
|
|
163
|
+
* const quoteSalesOrderCommitmentResponse =
|
|
164
|
+
* await client.sales.salesOrders.actions.quoteCommitment({
|
|
165
|
+
* buyer_account_id: 'ac_ykxoradjoeb3',
|
|
166
|
+
* promised_at: '2026-08-22T00:00:00Z',
|
|
167
|
+
* service_level_id: 'crop_4ilk9p6gccrx',
|
|
168
|
+
* ship_to_address_id: 'ad_npqa5y43q26z',
|
|
169
|
+
* });
|
|
170
|
+
* ```
|
|
171
|
+
*/
|
|
172
|
+
quoteCommitment(body = {}, options) {
|
|
173
|
+
return this._client.post('/v1/sales/sales-orders/actions/quote-commitment', { body, ...options });
|
|
174
|
+
}
|
|
139
175
|
/**
|
|
140
176
|
* Creates a production run from a sales order.
|
|
141
177
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"actions.js","sourceRoot":"","sources":["../../../src/resources/sales/sales-orders/actions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAKrD,0DAAoD;AAEpD;;GAEG;AACH,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;;;;;;OAgBG;IACH,UAAU,CAAC,IAA4B,EAAE,OAAwB;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,4CAA4C,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CACH,EAAU,EACV,IAAuB,EACvB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,0BAA0B,EAAE,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClG,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,OAAO,CAAC,EAAU,EAAE,OAAwB;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,0BAA0B,EAAE,kBAAkB,EAAE,OAAO,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,EAAU,EAAE,OAAwB;QACxC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,0BAA0B,EAAE,gBAAgB,EAAE,OAAO,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CAAC,EAAU,EAAE,OAAwB;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,0BAA0B,EAAE,eAAe,EAAE,OAAO,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,YAAY,CAAC,EAAU,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,0BAA0B,EAAE,wBAAwB,EAAE,OAAO,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,mBAAmB,CACjB,EAAU,EACV,SAA6D,EAAE,EAC/D,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,0BAA0B,EAAE,gCAAgC,EAAE;YACzF,KAAK,EAAE,EAAE,OAAO,EAAE;YAClB,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;
|
|
1
|
+
{"version":3,"file":"actions.js","sourceRoot":"","sources":["../../../src/resources/sales/sales-orders/actions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAKrD,0DAAoD;AAEpD;;GAEG;AACH,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;;;;;;OAgBG;IACH,UAAU,CAAC,IAA4B,EAAE,OAAwB;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,4CAA4C,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CACH,EAAU,EACV,IAAuB,EACvB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,0BAA0B,EAAE,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClG,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,OAAO,CAAC,EAAU,EAAE,OAAwB;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,0BAA0B,EAAE,kBAAkB,EAAE,OAAO,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,EAAU,EAAE,OAAwB;QACxC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,0BAA0B,EAAE,gBAAgB,EAAE,OAAO,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CAAC,EAAU,EAAE,OAAwB;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,0BAA0B,EAAE,eAAe,EAAE,OAAO,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,YAAY,CAAC,EAAU,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,0BAA0B,EAAE,wBAAwB,EAAE,OAAO,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,eAAe,CACb,OAAuD,EAAE,EACzD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iDAAiD,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpG,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,mBAAmB,CACjB,EAAU,EACV,SAA6D,EAAE,EAC/D,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,0BAA0B,EAAE,gCAAgC,EAAE;YACzF,KAAK,EAAE,EAAE,OAAO,EAAE;YAClB,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAnND,0BAmNC"}
|
|
@@ -133,6 +133,42 @@ export class Actions extends APIResource {
|
|
|
133
133
|
quoteFreight(id, options) {
|
|
134
134
|
return this._client.post(path `/v1/sales/sales-orders/${id}/actions/quote-freight`, options);
|
|
135
135
|
}
|
|
136
|
+
/**
|
|
137
|
+
* Previews the ship-by date a set of commitment inputs would produce, without
|
|
138
|
+
* creating or changing anything.
|
|
139
|
+
*
|
|
140
|
+
* Runs the same resolution an order runs when it is issued: a promised delivery
|
|
141
|
+
* date has the customer's receiving days, the carrier's transit, and the plant's
|
|
142
|
+
* shipping days worked back through it, while a lead time or a pinned ship date is
|
|
143
|
+
* snapped onto the next earlier day the plant ships. The returned steps are that
|
|
144
|
+
* derivation in order, so a caller can show why a date is what it is rather than
|
|
145
|
+
* restating the rules.
|
|
146
|
+
*
|
|
147
|
+
* At most one of `promised_at`, `lead_time_override_days`, and
|
|
148
|
+
* `ship_by_override_date` may be set; they are alternative answers to the same
|
|
149
|
+
* question.
|
|
150
|
+
*
|
|
151
|
+
* Advisory rather than binding. Carrier transit comes from a lane cache warmed in
|
|
152
|
+
* the background, so a lane nobody has shipped yet quotes against the service
|
|
153
|
+
* level's default or against no transit at all, and the date stamped at issue may
|
|
154
|
+
* differ once the lane has been rated.
|
|
155
|
+
*
|
|
156
|
+
* This endpoint requires the permission: `sales_orders:read`.
|
|
157
|
+
*
|
|
158
|
+
* @example
|
|
159
|
+
* ```ts
|
|
160
|
+
* const quoteSalesOrderCommitmentResponse =
|
|
161
|
+
* await client.sales.salesOrders.actions.quoteCommitment({
|
|
162
|
+
* buyer_account_id: 'ac_ykxoradjoeb3',
|
|
163
|
+
* promised_at: '2026-08-22T00:00:00Z',
|
|
164
|
+
* service_level_id: 'crop_4ilk9p6gccrx',
|
|
165
|
+
* ship_to_address_id: 'ad_npqa5y43q26z',
|
|
166
|
+
* });
|
|
167
|
+
* ```
|
|
168
|
+
*/
|
|
169
|
+
quoteCommitment(body = {}, options) {
|
|
170
|
+
return this._client.post('/v1/sales/sales-orders/actions/quote-commitment', { body, ...options });
|
|
171
|
+
}
|
|
136
172
|
/**
|
|
137
173
|
* Creates a production run from a sales order.
|
|
138
174
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"actions.mjs","sourceRoot":"","sources":["../../../src/resources/sales/sales-orders/actions.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAKf,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;OAgBG;IACH,UAAU,CAAC,IAA4B,EAAE,OAAwB;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,4CAA4C,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CACH,EAAU,EACV,IAAuB,EACvB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,0BAA0B,EAAE,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClG,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,OAAO,CAAC,EAAU,EAAE,OAAwB;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,0BAA0B,EAAE,kBAAkB,EAAE,OAAO,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,EAAU,EAAE,OAAwB;QACxC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,0BAA0B,EAAE,gBAAgB,EAAE,OAAO,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CAAC,EAAU,EAAE,OAAwB;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,0BAA0B,EAAE,eAAe,EAAE,OAAO,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,YAAY,CAAC,EAAU,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,0BAA0B,EAAE,wBAAwB,EAAE,OAAO,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,mBAAmB,CACjB,EAAU,EACV,SAA6D,EAAE,EAC/D,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,0BAA0B,EAAE,gCAAgC,EAAE;YACzF,KAAK,EAAE,EAAE,OAAO,EAAE;YAClB,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}
|
|
1
|
+
{"version":3,"file":"actions.mjs","sourceRoot":"","sources":["../../../src/resources/sales/sales-orders/actions.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAKf,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;OAgBG;IACH,UAAU,CAAC,IAA4B,EAAE,OAAwB;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,4CAA4C,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CACH,EAAU,EACV,IAAuB,EACvB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,0BAA0B,EAAE,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClG,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,OAAO,CAAC,EAAU,EAAE,OAAwB;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,0BAA0B,EAAE,kBAAkB,EAAE,OAAO,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,EAAU,EAAE,OAAwB;QACxC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,0BAA0B,EAAE,gBAAgB,EAAE,OAAO,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CAAC,EAAU,EAAE,OAAwB;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,0BAA0B,EAAE,eAAe,EAAE,OAAO,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,YAAY,CAAC,EAAU,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,0BAA0B,EAAE,wBAAwB,EAAE,OAAO,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,eAAe,CACb,OAAuD,EAAE,EACzD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iDAAiD,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpG,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,mBAAmB,CACjB,EAAU,EACV,SAA6D,EAAE,EAC/D,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,0BAA0B,EAAE,gCAAgC,EAAE;YACzF,KAAK,EAAE,EAAE,OAAO,EAAE;YAClB,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export { Actions, type BulkDeleteSalesOrdersRequest, type IssueSalesOrderRequest, type ProductionRun, type QuoteSalesOrderFreightResponse, type ActionBulkDeleteResponse, type ActionBulkDeleteParams, type ActionIssueParams, type ActionCreateProductionRunParams, } from "./actions.mjs";
|
|
1
|
+
export { Actions, type BulkDeleteSalesOrdersRequest, type CommitmentQuoteStep, type IssueSalesOrderRequest, type ProductionRun, type QuoteSalesOrderCommitmentRequest, type QuoteSalesOrderCommitmentResponse, type QuoteSalesOrderFreightResponse, type ActionBulkDeleteResponse, type ActionBulkDeleteParams, type ActionIssueParams, type ActionQuoteCommitmentParams, type ActionCreateProductionRunParams, } from "./actions.mjs";
|
|
2
2
|
export { Lines, type CreateSalesOrderLineRequest, type UpdateSalesOrderLineRequest, type LineDeleteResponse, type LineCreateParams, type LineUpdateParams, type LineDeleteParams, } from "./lines/index.mjs";
|
|
3
3
|
export { SalesOrders, type CheckoutSalesOrderRequest, type CheckoutSalesOrderResponse, type ComputedRate, type CreateSalesOrderLineInput, type CreateSalesOrderRequest, type CreatedBy, type Freight, type ListQuotedSalesOrderLine, type ListRecord, type ListSalesOrder, type ListSalesOrderLine, type ListSalesOrderStatus, type OrderContact, type QuoteSalesOrderLineInput, type QuoteSalesOrderPricesRequest, type QuoteSalesOrderPricesResponse, type QuotedSalesOrderLine, type Record, type SalesOrder, type SalesOrderEmailContactInput, type SalesOrderLine, type SalesOrderRelated, type SalesOrderStageTotal, type SalesOrderStatus, type SalesOrderTotals, type UpdateSalesOrderRequest, type SalesOrderDeleteResponse, type SalesOrderRetrieveStatusesParams, type SalesOrderListParams, type SalesOrderRetrieveParams, type SalesOrderCreateParams, type SalesOrderUpdateParams, type SalesOrderCheckoutParams, type SalesOrderPriceQuoteParams, } from "./sales-orders.mjs";
|
|
4
4
|
//# sourceMappingURL=index.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/resources/sales/sales-orders/index.ts"],"names":[],"mappings":"OAEO,EACL,OAAO,EACP,KAAK,4BAA4B,EACjC,KAAK,sBAAsB,EAC3B,KAAK,aAAa,EAClB,KAAK,8BAA8B,EACnC,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,iBAAiB,EACtB,KAAK,+BAA+B,GACrC;OACM,EACL,KAAK,EACL,KAAK,2BAA2B,EAChC,KAAK,2BAA2B,EAChC,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,GACtB;OACM,EACL,WAAW,EACX,KAAK,yBAAyB,EAC9B,KAAK,0BAA0B,EAC/B,KAAK,YAAY,EACjB,KAAK,yBAAyB,EAC9B,KAAK,uBAAuB,EAC5B,KAAK,SAAS,EACd,KAAK,OAAO,EACZ,KAAK,wBAAwB,EAC7B,KAAK,UAAU,EACf,KAAK,cAAc,EACnB,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,EACzB,KAAK,YAAY,EACjB,KAAK,wBAAwB,EAC7B,KAAK,4BAA4B,EACjC,KAAK,6BAA6B,EAClC,KAAK,oBAAoB,EACzB,KAAK,MAAM,EACX,KAAK,UAAU,EACf,KAAK,2BAA2B,EAChC,KAAK,cAAc,EACnB,KAAK,iBAAiB,EACtB,KAAK,oBAAoB,EACzB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,uBAAuB,EAC5B,KAAK,wBAAwB,EAC7B,KAAK,gCAAgC,EACrC,KAAK,oBAAoB,EACzB,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,GAChC"}
|
|
1
|
+
{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/resources/sales/sales-orders/index.ts"],"names":[],"mappings":"OAEO,EACL,OAAO,EACP,KAAK,4BAA4B,EACjC,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,EAC3B,KAAK,aAAa,EAClB,KAAK,gCAAgC,EACrC,KAAK,iCAAiC,EACtC,KAAK,8BAA8B,EACnC,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,iBAAiB,EACtB,KAAK,2BAA2B,EAChC,KAAK,+BAA+B,GACrC;OACM,EACL,KAAK,EACL,KAAK,2BAA2B,EAChC,KAAK,2BAA2B,EAChC,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,GACtB;OACM,EACL,WAAW,EACX,KAAK,yBAAyB,EAC9B,KAAK,0BAA0B,EAC/B,KAAK,YAAY,EACjB,KAAK,yBAAyB,EAC9B,KAAK,uBAAuB,EAC5B,KAAK,SAAS,EACd,KAAK,OAAO,EACZ,KAAK,wBAAwB,EAC7B,KAAK,UAAU,EACf,KAAK,cAAc,EACnB,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,EACzB,KAAK,YAAY,EACjB,KAAK,wBAAwB,EAC7B,KAAK,4BAA4B,EACjC,KAAK,6BAA6B,EAClC,KAAK,oBAAoB,EACzB,KAAK,MAAM,EACX,KAAK,UAAU,EACf,KAAK,2BAA2B,EAChC,KAAK,cAAc,EACnB,KAAK,iBAAiB,EACtB,KAAK,oBAAoB,EACzB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,uBAAuB,EAC5B,KAAK,wBAAwB,EAC7B,KAAK,gCAAgC,EACrC,KAAK,oBAAoB,EACzB,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,GAChC"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export { Actions, type BulkDeleteSalesOrdersRequest, type IssueSalesOrderRequest, type ProductionRun, type QuoteSalesOrderFreightResponse, type ActionBulkDeleteResponse, type ActionBulkDeleteParams, type ActionIssueParams, type ActionCreateProductionRunParams, } from "./actions.js";
|
|
1
|
+
export { Actions, type BulkDeleteSalesOrdersRequest, type CommitmentQuoteStep, type IssueSalesOrderRequest, type ProductionRun, type QuoteSalesOrderCommitmentRequest, type QuoteSalesOrderCommitmentResponse, type QuoteSalesOrderFreightResponse, type ActionBulkDeleteResponse, type ActionBulkDeleteParams, type ActionIssueParams, type ActionQuoteCommitmentParams, type ActionCreateProductionRunParams, } from "./actions.js";
|
|
2
2
|
export { Lines, type CreateSalesOrderLineRequest, type UpdateSalesOrderLineRequest, type LineDeleteResponse, type LineCreateParams, type LineUpdateParams, type LineDeleteParams, } from "./lines/index.js";
|
|
3
3
|
export { SalesOrders, type CheckoutSalesOrderRequest, type CheckoutSalesOrderResponse, type ComputedRate, type CreateSalesOrderLineInput, type CreateSalesOrderRequest, type CreatedBy, type Freight, type ListQuotedSalesOrderLine, type ListRecord, type ListSalesOrder, type ListSalesOrderLine, type ListSalesOrderStatus, type OrderContact, type QuoteSalesOrderLineInput, type QuoteSalesOrderPricesRequest, type QuoteSalesOrderPricesResponse, type QuotedSalesOrderLine, type Record, type SalesOrder, type SalesOrderEmailContactInput, type SalesOrderLine, type SalesOrderRelated, type SalesOrderStageTotal, type SalesOrderStatus, type SalesOrderTotals, type UpdateSalesOrderRequest, type SalesOrderDeleteResponse, type SalesOrderRetrieveStatusesParams, type SalesOrderListParams, type SalesOrderRetrieveParams, type SalesOrderCreateParams, type SalesOrderUpdateParams, type SalesOrderCheckoutParams, type SalesOrderPriceQuoteParams, } from "./sales-orders.js";
|
|
4
4
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/resources/sales/sales-orders/index.ts"],"names":[],"mappings":"OAEO,EACL,OAAO,EACP,KAAK,4BAA4B,EACjC,KAAK,sBAAsB,EAC3B,KAAK,aAAa,EAClB,KAAK,8BAA8B,EACnC,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,iBAAiB,EACtB,KAAK,+BAA+B,GACrC;OACM,EACL,KAAK,EACL,KAAK,2BAA2B,EAChC,KAAK,2BAA2B,EAChC,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,GACtB;OACM,EACL,WAAW,EACX,KAAK,yBAAyB,EAC9B,KAAK,0BAA0B,EAC/B,KAAK,YAAY,EACjB,KAAK,yBAAyB,EAC9B,KAAK,uBAAuB,EAC5B,KAAK,SAAS,EACd,KAAK,OAAO,EACZ,KAAK,wBAAwB,EAC7B,KAAK,UAAU,EACf,KAAK,cAAc,EACnB,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,EACzB,KAAK,YAAY,EACjB,KAAK,wBAAwB,EAC7B,KAAK,4BAA4B,EACjC,KAAK,6BAA6B,EAClC,KAAK,oBAAoB,EACzB,KAAK,MAAM,EACX,KAAK,UAAU,EACf,KAAK,2BAA2B,EAChC,KAAK,cAAc,EACnB,KAAK,iBAAiB,EACtB,KAAK,oBAAoB,EACzB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,uBAAuB,EAC5B,KAAK,wBAAwB,EAC7B,KAAK,gCAAgC,EACrC,KAAK,oBAAoB,EACzB,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,GAChC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/resources/sales/sales-orders/index.ts"],"names":[],"mappings":"OAEO,EACL,OAAO,EACP,KAAK,4BAA4B,EACjC,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,EAC3B,KAAK,aAAa,EAClB,KAAK,gCAAgC,EACrC,KAAK,iCAAiC,EACtC,KAAK,8BAA8B,EACnC,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,iBAAiB,EACtB,KAAK,2BAA2B,EAChC,KAAK,+BAA+B,GACrC;OACM,EACL,KAAK,EACL,KAAK,2BAA2B,EAChC,KAAK,2BAA2B,EAChC,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,GACtB;OACM,EACL,WAAW,EACX,KAAK,yBAAyB,EAC9B,KAAK,0BAA0B,EAC/B,KAAK,YAAY,EACjB,KAAK,yBAAyB,EAC9B,KAAK,uBAAuB,EAC5B,KAAK,SAAS,EACd,KAAK,OAAO,EACZ,KAAK,wBAAwB,EAC7B,KAAK,UAAU,EACf,KAAK,cAAc,EACnB,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,EACzB,KAAK,YAAY,EACjB,KAAK,wBAAwB,EAC7B,KAAK,4BAA4B,EACjC,KAAK,6BAA6B,EAClC,KAAK,oBAAoB,EACzB,KAAK,MAAM,EACX,KAAK,UAAU,EACf,KAAK,2BAA2B,EAChC,KAAK,cAAc,EACnB,KAAK,iBAAiB,EACtB,KAAK,oBAAoB,EACzB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,uBAAuB,EAC5B,KAAK,wBAAwB,EAC7B,KAAK,gCAAgC,EACrC,KAAK,oBAAoB,EACzB,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,GAChC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/resources/sales/sales-orders/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/resources/sales/sales-orders/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wCAcmB;AAbjB,kGAAA,OAAO,OAAA;AAcT,0CAQuB;AAPrB,8FAAA,KAAK,OAAA;AAQP,kDAoCwB;AAnCtB,2GAAA,WAAW,OAAA"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../src/resources/sales/sales-orders/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,OAAO,
|
|
1
|
+
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../src/resources/sales/sales-orders/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,OAAO,GAaR;OACM,EACL,KAAK,GAON;OACM,EACL,WAAW,GAmCZ"}
|
|
@@ -9,7 +9,7 @@ import * as UnitsAPI from "../../catalog/units/units.mjs";
|
|
|
9
9
|
import * as AccountPricesAPI from "../account-prices/account-prices.mjs";
|
|
10
10
|
import * as OrderDiscountsAPI from "../order-discounts/order-discounts.mjs";
|
|
11
11
|
import * as ActionsAPI from "./actions.mjs";
|
|
12
|
-
import { ActionBulkDeleteParams, ActionBulkDeleteResponse, ActionCreateProductionRunParams, ActionIssueParams, Actions, BulkDeleteSalesOrdersRequest, IssueSalesOrderRequest, ProductionRun, QuoteSalesOrderFreightResponse } from "./actions.mjs";
|
|
12
|
+
import { ActionBulkDeleteParams, ActionBulkDeleteResponse, ActionCreateProductionRunParams, ActionIssueParams, ActionQuoteCommitmentParams, Actions, BulkDeleteSalesOrdersRequest, CommitmentQuoteStep, IssueSalesOrderRequest, ProductionRun, QuoteSalesOrderCommitmentRequest, QuoteSalesOrderCommitmentResponse, QuoteSalesOrderFreightResponse } from "./actions.mjs";
|
|
13
13
|
import * as LinesAPI from "./lines/lines.mjs";
|
|
14
14
|
import { CreateSalesOrderLineRequest, LineCreateParams, LineDeleteParams, LineDeleteResponse, LineUpdateParams, Lines, UpdateSalesOrderLineRequest } from "./lines/lines.mjs";
|
|
15
15
|
import { APIPromise } from "../../../core/api-promise.mjs";
|
|
@@ -362,6 +362,14 @@ export interface CreateSalesOrderRequest {
|
|
|
362
362
|
* Each must be a user on the customer's account.
|
|
363
363
|
*/
|
|
364
364
|
invoice_email_contacts?: Array<SalesOrderEmailContactInput>;
|
|
365
|
+
/**
|
|
366
|
+
* Days between this order being issued and it being due to ship, replacing the
|
|
367
|
+
* customer's standing lead time for this order alone.
|
|
368
|
+
*
|
|
369
|
+
* Already a ship lead time, so no carrier transit is subtracted from it. Mutually
|
|
370
|
+
* exclusive with promised_at and ship_by_override_date.
|
|
371
|
+
*/
|
|
372
|
+
lead_time_override_days?: number;
|
|
365
373
|
/**
|
|
366
374
|
* Free-form note about the order.
|
|
367
375
|
*/
|
|
@@ -382,6 +390,11 @@ export interface CreateSalesOrderRequest {
|
|
|
382
390
|
payment_term_id?: string;
|
|
383
391
|
/**
|
|
384
392
|
* Date delivery is promised to the customer.
|
|
393
|
+
*
|
|
394
|
+
* The order's ship-by date is worked back from this: the goods have to reach the
|
|
395
|
+
* customer on a day they receive, so transit and both operating calendars are
|
|
396
|
+
* subtracted from it. Mutually exclusive with lead_time_override_days and
|
|
397
|
+
* ship_by_override_date.
|
|
385
398
|
*/
|
|
386
399
|
promised_at?: string;
|
|
387
400
|
/**
|
|
@@ -401,6 +414,15 @@ export interface CreateSalesOrderRequest {
|
|
|
401
414
|
* level unset.
|
|
402
415
|
*/
|
|
403
416
|
service_level_id?: string;
|
|
417
|
+
/**
|
|
418
|
+
* The exact date the order is due to ship, bypassing transit and the customer's
|
|
419
|
+
* receiving days.
|
|
420
|
+
*
|
|
421
|
+
* Still moved back to the nearest earlier day the plant ships on, since a date
|
|
422
|
+
* nobody can ship on is not a deadline. Mutually exclusive with promised_at and
|
|
423
|
+
* lead_time_override_days.
|
|
424
|
+
*/
|
|
425
|
+
ship_by_override_date?: string;
|
|
404
426
|
/**
|
|
405
427
|
* ID of the shipping terms for the order.
|
|
406
428
|
*
|
|
@@ -765,6 +787,14 @@ export interface SalesOrder {
|
|
|
765
787
|
* invoices, and shipments.
|
|
766
788
|
*/
|
|
767
789
|
bill_to_address: APIKeysAPI.Address | null;
|
|
790
|
+
/**
|
|
791
|
+
* Days the customer's receiving calendar and the plant's shipping calendar pulled
|
|
792
|
+
* the ship-by date back, beyond what carrier transit accounted for.
|
|
793
|
+
*
|
|
794
|
+
* Zero means every date along the way already fell on an open day. This is what
|
|
795
|
+
* explains a ship-by date that is earlier than transit alone would suggest.
|
|
796
|
+
*/
|
|
797
|
+
calendar_adjustment_days: number | null;
|
|
768
798
|
/**
|
|
769
799
|
* When the order was fulfilled and closed.
|
|
770
800
|
*/
|
|
@@ -818,10 +848,15 @@ export interface SalesOrder {
|
|
|
818
848
|
* Calendar days between issue and the ship-by date.
|
|
819
849
|
*/
|
|
820
850
|
lead_time_days: number | null;
|
|
851
|
+
/**
|
|
852
|
+
* Days between issue and the ship-by date, set on this order alone in place of the
|
|
853
|
+
* customer's standing lead time.
|
|
854
|
+
*/
|
|
855
|
+
lead_time_override_days: number | null;
|
|
821
856
|
/**
|
|
822
857
|
* Which rule produced the ship-by date.
|
|
823
858
|
*/
|
|
824
|
-
lead_time_source: 'customer' | 'account_group' | 'account' | 'manual' | null;
|
|
859
|
+
lead_time_source: 'customer' | 'account_group' | 'account' | 'manual' | 'order_lead_time' | 'order_ship_by' | null;
|
|
825
860
|
/**
|
|
826
861
|
* Number of lines on this order.
|
|
827
862
|
*/
|
|
@@ -887,19 +922,34 @@ export interface SalesOrder {
|
|
|
887
922
|
* with an action.
|
|
888
923
|
*/
|
|
889
924
|
sales_rep: RequestLogsAPI.Actor | null;
|
|
925
|
+
/**
|
|
926
|
+
* The ship-by date at the plant's pickup cutoff — the moment freight has to be
|
|
927
|
+
* tendered by, not just the day.
|
|
928
|
+
*
|
|
929
|
+
* Only set when the account's shipping calendar carries a cutoff time.
|
|
930
|
+
*/
|
|
931
|
+
ship_by_cutoff_at: string | null;
|
|
890
932
|
/**
|
|
891
933
|
* Date this order is contractually due to ship.
|
|
892
934
|
*
|
|
893
935
|
* Stamped when the order is issued. With a promised delivery date, this is that
|
|
894
|
-
* date less the carrier's transit for the order's lane
|
|
895
|
-
* the day the order has to leave to arrive when
|
|
896
|
-
*
|
|
936
|
+
* date less the carrier's transit for the order's lane and less any day the
|
|
937
|
+
* customer cannot receive on — the day the order has to leave to arrive when
|
|
938
|
+
* promised. Otherwise it comes from a lead time, whether this order's own or the
|
|
939
|
+
* one on the customer, its account group, or the account.
|
|
897
940
|
*
|
|
898
|
-
*
|
|
899
|
-
*
|
|
900
|
-
*
|
|
941
|
+
* Always a day the plant actually ships on, whichever rule produced it.
|
|
942
|
+
*
|
|
943
|
+
* It is not recomputed afterwards, so neither renegotiating a customer's lead
|
|
944
|
+
* time, nor a later carrier estimate, nor a holiday added to a calendar moves
|
|
945
|
+
* commitments already made. Cleared if the order is unissued.
|
|
901
946
|
*/
|
|
902
947
|
ship_by_date: string | null;
|
|
948
|
+
/**
|
|
949
|
+
* The ship date pinned on this order, bypassing transit and the customer's
|
|
950
|
+
* receiving days.
|
|
951
|
+
*/
|
|
952
|
+
ship_by_override_date: string | null;
|
|
903
953
|
/**
|
|
904
954
|
* A saved address that can be used for billing and shipping on sales orders,
|
|
905
955
|
* invoices, and shipments.
|
|
@@ -1240,6 +1290,12 @@ export interface UpdateSalesOrderRequest {
|
|
|
1240
1290
|
* untouched.
|
|
1241
1291
|
*/
|
|
1242
1292
|
invoice_email_contacts?: Array<SalesOrderEmailContactInput>;
|
|
1293
|
+
/**
|
|
1294
|
+
* Days between this order being issued and it being due to ship, replacing the
|
|
1295
|
+
* customer's standing lead time for this order alone. Mutually exclusive with
|
|
1296
|
+
* promised_at and ship_by_override_date; clear one to switch to another.
|
|
1297
|
+
*/
|
|
1298
|
+
lead_time_override_days?: number | null;
|
|
1243
1299
|
/**
|
|
1244
1300
|
* Free-form note about the order.
|
|
1245
1301
|
*/
|
|
@@ -1271,6 +1327,11 @@ export interface UpdateSalesOrderRequest {
|
|
|
1271
1327
|
* ID of the carrier service level the order ships on.
|
|
1272
1328
|
*/
|
|
1273
1329
|
service_level_id?: string | null;
|
|
1330
|
+
/**
|
|
1331
|
+
* The exact date the order is due to ship, bypassing transit and the customer's
|
|
1332
|
+
* receiving days. Mutually exclusive with promised_at and lead_time_override_days.
|
|
1333
|
+
*/
|
|
1334
|
+
ship_by_override_date?: string | null;
|
|
1274
1335
|
/**
|
|
1275
1336
|
* Shipping address ID.
|
|
1276
1337
|
*
|
|
@@ -1474,6 +1535,14 @@ export interface SalesOrderCreateParams {
|
|
|
1474
1535
|
* Each must be a user on the customer's account.
|
|
1475
1536
|
*/
|
|
1476
1537
|
invoice_email_contacts?: Array<SalesOrderEmailContactInput>;
|
|
1538
|
+
/**
|
|
1539
|
+
* Body param: Days between this order being issued and it being due to ship,
|
|
1540
|
+
* replacing the customer's standing lead time for this order alone.
|
|
1541
|
+
*
|
|
1542
|
+
* Already a ship lead time, so no carrier transit is subtracted from it. Mutually
|
|
1543
|
+
* exclusive with promised_at and ship_by_override_date.
|
|
1544
|
+
*/
|
|
1545
|
+
lead_time_override_days?: number;
|
|
1477
1546
|
/**
|
|
1478
1547
|
* Body param: Free-form note about the order.
|
|
1479
1548
|
*/
|
|
@@ -1495,6 +1564,11 @@ export interface SalesOrderCreateParams {
|
|
|
1495
1564
|
payment_term_id?: string;
|
|
1496
1565
|
/**
|
|
1497
1566
|
* Body param: Date delivery is promised to the customer.
|
|
1567
|
+
*
|
|
1568
|
+
* The order's ship-by date is worked back from this: the goods have to reach the
|
|
1569
|
+
* customer on a day they receive, so transit and both operating calendars are
|
|
1570
|
+
* subtracted from it. Mutually exclusive with lead_time_override_days and
|
|
1571
|
+
* ship_by_override_date.
|
|
1498
1572
|
*/
|
|
1499
1573
|
promised_at?: string;
|
|
1500
1574
|
/**
|
|
@@ -1514,6 +1588,15 @@ export interface SalesOrderCreateParams {
|
|
|
1514
1588
|
* level unset.
|
|
1515
1589
|
*/
|
|
1516
1590
|
service_level_id?: string;
|
|
1591
|
+
/**
|
|
1592
|
+
* Body param: The exact date the order is due to ship, bypassing transit and the
|
|
1593
|
+
* customer's receiving days.
|
|
1594
|
+
*
|
|
1595
|
+
* Still moved back to the nearest earlier day the plant ships on, since a date
|
|
1596
|
+
* nobody can ship on is not a deadline. Mutually exclusive with promised_at and
|
|
1597
|
+
* lead_time_override_days.
|
|
1598
|
+
*/
|
|
1599
|
+
ship_by_override_date?: string;
|
|
1517
1600
|
/**
|
|
1518
1601
|
* Body param: ID of the shipping terms for the order.
|
|
1519
1602
|
*
|
|
@@ -1584,6 +1667,13 @@ export interface SalesOrderUpdateParams {
|
|
|
1584
1667
|
* untouched.
|
|
1585
1668
|
*/
|
|
1586
1669
|
invoice_email_contacts?: Array<SalesOrderEmailContactInput>;
|
|
1670
|
+
/**
|
|
1671
|
+
* Body param: Days between this order being issued and it being due to ship,
|
|
1672
|
+
* replacing the customer's standing lead time for this order alone. Mutually
|
|
1673
|
+
* exclusive with promised_at and ship_by_override_date; clear one to switch to
|
|
1674
|
+
* another.
|
|
1675
|
+
*/
|
|
1676
|
+
lead_time_override_days?: number | null;
|
|
1587
1677
|
/**
|
|
1588
1678
|
* Body param: Free-form note about the order.
|
|
1589
1679
|
*/
|
|
@@ -1615,6 +1705,12 @@ export interface SalesOrderUpdateParams {
|
|
|
1615
1705
|
* Body param: ID of the carrier service level the order ships on.
|
|
1616
1706
|
*/
|
|
1617
1707
|
service_level_id?: string | null;
|
|
1708
|
+
/**
|
|
1709
|
+
* Body param: The exact date the order is due to ship, bypassing transit and the
|
|
1710
|
+
* customer's receiving days. Mutually exclusive with promised_at and
|
|
1711
|
+
* lead_time_override_days.
|
|
1712
|
+
*/
|
|
1713
|
+
ship_by_override_date?: string | null;
|
|
1618
1714
|
/**
|
|
1619
1715
|
* Body param: Shipping address ID.
|
|
1620
1716
|
*
|
|
@@ -1645,7 +1741,7 @@ export interface SalesOrderPriceQuoteParams {
|
|
|
1645
1741
|
}
|
|
1646
1742
|
export declare namespace SalesOrders {
|
|
1647
1743
|
export { type CheckoutSalesOrderRequest as CheckoutSalesOrderRequest, type CheckoutSalesOrderResponse as CheckoutSalesOrderResponse, type ComputedRate as ComputedRate, type CreateSalesOrderLineInput as CreateSalesOrderLineInput, type CreateSalesOrderRequest as CreateSalesOrderRequest, type CreatedBy as CreatedBy, type Freight as Freight, type ListQuotedSalesOrderLine as ListQuotedSalesOrderLine, type ListRecord as ListRecord, type ListSalesOrder as ListSalesOrder, type ListSalesOrderLine as ListSalesOrderLine, type ListSalesOrderStatus as ListSalesOrderStatus, type OrderContact as OrderContact, type QuoteSalesOrderLineInput as QuoteSalesOrderLineInput, type QuoteSalesOrderPricesRequest as QuoteSalesOrderPricesRequest, type QuoteSalesOrderPricesResponse as QuoteSalesOrderPricesResponse, type QuotedSalesOrderLine as QuotedSalesOrderLine, type Record as Record, type SalesOrder as SalesOrder, type SalesOrderEmailContactInput as SalesOrderEmailContactInput, type SalesOrderLine as SalesOrderLine, type SalesOrderRelated as SalesOrderRelated, type SalesOrderStageTotal as SalesOrderStageTotal, type SalesOrderStatus as SalesOrderStatus, type SalesOrderTotals as SalesOrderTotals, type UpdateSalesOrderRequest as UpdateSalesOrderRequest, type SalesOrderDeleteResponse as SalesOrderDeleteResponse, type SalesOrderRetrieveStatusesParams as SalesOrderRetrieveStatusesParams, type SalesOrderListParams as SalesOrderListParams, type SalesOrderRetrieveParams as SalesOrderRetrieveParams, type SalesOrderCreateParams as SalesOrderCreateParams, type SalesOrderUpdateParams as SalesOrderUpdateParams, type SalesOrderCheckoutParams as SalesOrderCheckoutParams, type SalesOrderPriceQuoteParams as SalesOrderPriceQuoteParams, };
|
|
1648
|
-
export { Actions as Actions, type BulkDeleteSalesOrdersRequest as BulkDeleteSalesOrdersRequest, type IssueSalesOrderRequest as IssueSalesOrderRequest, type ProductionRun as ProductionRun, type QuoteSalesOrderFreightResponse as QuoteSalesOrderFreightResponse, type ActionBulkDeleteResponse as ActionBulkDeleteResponse, type ActionBulkDeleteParams as ActionBulkDeleteParams, type ActionIssueParams as ActionIssueParams, type ActionCreateProductionRunParams as ActionCreateProductionRunParams, };
|
|
1744
|
+
export { Actions as Actions, type BulkDeleteSalesOrdersRequest as BulkDeleteSalesOrdersRequest, type CommitmentQuoteStep as CommitmentQuoteStep, type IssueSalesOrderRequest as IssueSalesOrderRequest, type ProductionRun as ProductionRun, type QuoteSalesOrderCommitmentRequest as QuoteSalesOrderCommitmentRequest, type QuoteSalesOrderCommitmentResponse as QuoteSalesOrderCommitmentResponse, type QuoteSalesOrderFreightResponse as QuoteSalesOrderFreightResponse, type ActionBulkDeleteResponse as ActionBulkDeleteResponse, type ActionBulkDeleteParams as ActionBulkDeleteParams, type ActionIssueParams as ActionIssueParams, type ActionQuoteCommitmentParams as ActionQuoteCommitmentParams, type ActionCreateProductionRunParams as ActionCreateProductionRunParams, };
|
|
1649
1745
|
export { Lines as Lines, type CreateSalesOrderLineRequest as CreateSalesOrderLineRequest, type UpdateSalesOrderLineRequest as UpdateSalesOrderLineRequest, type LineDeleteResponse as LineDeleteResponse, type LineCreateParams as LineCreateParams, type LineUpdateParams as LineUpdateParams, type LineDeleteParams as LineDeleteParams, };
|
|
1650
1746
|
}
|
|
1651
1747
|
//# sourceMappingURL=sales-orders.d.mts.map
|