@augno/sdk 0.18.0 → 0.18.1

package/src/resources/sales/customers/customers.ts

@@ -360,6 +360,15 @@ export interface CreateCustomerRequest {
    */
   phone?: string;
 
+  /**
+   * The operating calendar naming the days this customer's dock accepts freight.
+   *
+   * Sits in the same chain as lead_time_days: leaving it unset falls through to the
+   * customer's group, then the account default, then Monday to Friday. A promised
+   * delivery date is never worked back from a day nobody is there to receive on.
+   */
+  receive_calendar_id?: string;
+
   /**
    * The customer's account standing.
    *
@@ -414,7 +423,7 @@ export interface CustomerLeadTime {
    * on one specific order, which is a fact about that order rather than about the
    * customer.
    */
-  source: 'customer' | 'account_group' | 'account' | 'manual';
+  source: 'customer' | 'account_group' | 'account' | 'manual' | 'order_lead_time' | 'order_ship_by';
 }
 
 /**
@@ -562,6 +571,13 @@ export interface UpdateCustomerRequest {
    */
   phone?: string | null;
 
+  /**
+   * The operating calendar naming the days this customer's dock accepts freight.
+   * Clearing it returns the customer to their group's calendar, then the account
+   * default.
+   */
+  receive_calendar_id?: string | null;
+
   /**
    * ID of an existing address to use as the default shipping address.
    *
@@ -939,6 +955,16 @@ export interface CustomerCreateParams {
    */
   phone?: string;
 
+  /**
+   * Body param: The operating calendar naming the days this customer's dock accepts
+   * freight.
+   *
+   * Sits in the same chain as lead_time_days: leaving it unset falls through to the
+   * customer's group, then the account default, then Monday to Friday. A promised
+   * delivery date is never worked back from a day nobody is there to receive on.
+   */
+  receive_calendar_id?: string;
+
   /**
    * Body param: The customer's account standing.
    *
@@ -1128,6 +1154,13 @@ export interface CustomerUpdateParams {
    */
   phone?: string | null;
 
+  /**
+   * Body param: The operating calendar naming the days this customer's dock accepts
+   * freight. Clearing it returns the customer to their group's calendar, then the
+   * account default.
+   */
+  receive_calendar_id?: string | null;
+
   /**
    * Body param: ID of an existing address to use as the default shipping address.
    *

package/src/resources/sales/sales-orders/actions.ts

@@ -149,6 +149,46 @@ export class Actions extends APIResource {
     return this._client.post(path`/v1/sales/sales-orders/${id}/actions/quote-freight`, options);
   }
 
+  /**
+   * Previews the ship-by date a set of commitment inputs would produce, without
+   * creating or changing anything.
+   *
+   * Runs the same resolution an order runs when it is issued: a promised delivery
+   * date has the customer's receiving days, the carrier's transit, and the plant's
+   * shipping days worked back through it, while a lead time or a pinned ship date is
+   * snapped onto the next earlier day the plant ships. The returned steps are that
+   * derivation in order, so a caller can show why a date is what it is rather than
+   * restating the rules.
+   *
+   * At most one of `promised_at`, `lead_time_override_days`, and
+   * `ship_by_override_date` may be set; they are alternative answers to the same
+   * question.
+   *
+   * Advisory rather than binding. Carrier transit comes from a lane cache warmed in
+   * the background, so a lane nobody has shipped yet quotes against the service
+   * level's default or against no transit at all, and the date stamped at issue may
+   * differ once the lane has been rated.
+   *
+   * This endpoint requires the permission: `sales_orders:read`.
+   *
+   * @example
+   * ```ts
+   * const quoteSalesOrderCommitmentResponse =
+   *   await client.sales.salesOrders.actions.quoteCommitment({
+   *     buyer_account_id: 'ac_ykxoradjoeb3',
+   *     promised_at: '2026-08-22T00:00:00Z',
+   *     service_level_id: 'crop_4ilk9p6gccrx',
+   *     ship_to_address_id: 'ad_npqa5y43q26z',
+   *   });
+   * ```
+   */
+  quoteCommitment(
+    body: ActionQuoteCommitmentParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<QuoteSalesOrderCommitmentResponse> {
+    return this._client.post('/v1/sales/sales-orders/actions/quote-commitment', { body, ...options });
+  }
+
   /**
    * Creates a production run from a sales order.
    *
@@ -193,6 +233,38 @@ export interface BulkDeleteSalesOrdersRequest {
   sales_order_ids: Array<string>;
 }
 
+/**
+ * CommitmentQuoteStep is one rule's contribution to a previewed ship-by date.
+ *
+ * Returned as an ordered list so a caller can show why a date is what it is
+ * without reimplementing the arithmetic, and so the explanation cannot drift from
+ * the calculation that produced it.
+ */
+export interface CommitmentQuoteStep {
+  /**
+   * Which rule applied.
+   */
+  code: 'basis' | 'receive_calendar' | 'carrier_transit' | 'ship_calendar' | 'pickup_cutoff';
+
+  /**
+   * Where the running date stood after this rule.
+   */
+  date: string;
+
+  /**
+   * How far this rule pulled the date back. Zero means the rule applied and changed
+   * nothing, which is worth showing: it says the date was already on an open day.
+   */
+  days_moved: number;
+
+  /**
+   * The rule's own parameter — where a transit estimate came from, or the cutoff
+   * time applied. Null for a rule that takes none, rather than an empty string:
+   * snapping onto an open day has no parameter to report.
+   */
+  detail: string | null;
+}
+
 /**
  * Request to issue a sales order.
  */
@@ -272,6 +344,126 @@ export interface ProductionRun {
   updated_at: string;
 }
 
+/**
+ * Request to preview the ship-by date a set of commitment inputs would produce.
+ */
+export interface QuoteSalesOrderCommitmentRequest {
+  /**
+   * The buying account, used to resolve its lead time and receiving days.
+   */
+  buyer_account_id?: string;
+
+  /**
+   * Carrier for the shipment.
+   */
+  carrier_id?: string;
+
+  /**
+   * When the order would be issued. Defaults to now, since a lead time is measured
+   * from issue and an order built today but issued next week commits to next week's
+   * date.
+   */
+  issued_at?: string;
+
+  /**
+   * Days between issue and the order being due to ship, in place of the customer's
+   * standing lead time.
+   */
+  lead_time_override_days?: number;
+
+  /**
+   * Date delivery would be promised to the customer.
+   */
+  promised_at?: string;
+
+  /**
+   * An existing order to preview against. Its customer, ship-to address, carrier,
+   * and service level are used, and the commitment fields below replace whatever it
+   * currently carries.
+   *
+   * Omit it to preview an order that has not been created yet, supplying the parts
+   * directly.
+   */
+  sales_order_id?: string;
+
+  /**
+   * Service level for the shipment, which the lane's transit estimate is keyed on.
+   */
+  service_level_id?: string;
+
+  /**
+   * The exact date the order would be due to ship.
+   */
+  ship_by_override_date?: string;
+
+  /**
+   * The ship-to address, which decides the destination timezone and the lane transit
+   * is quoted on.
+   */
+  ship_to_address_id?: string;
+}
+
+/**
+ * The ship-by date a set of commitment inputs would produce, and how it was
+ * reached.
+ */
+export interface QuoteSalesOrderCommitmentResponse {
+  /**
+   * Days the receiving and shipping calendars pulled the date back, beyond what
+   * transit accounted for.
+   */
+  calendar_adjustment_days: number;
+
+  /**
+   * Calendar days between issue and the ship-by date.
+   */
+  lead_time_days: number | null;
+
+  /**
+   * Which rule produced the date.
+   */
+  lead_time_source:
+    | 'customer'
+    | 'account_group'
+    | 'account'
+    | 'manual'
+    | 'order_lead_time'
+    | 'order_ship_by'
+    | null;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'sales_order_commitment_quote';
+
+  /**
+   * That date at the plant's pickup cutoff — the moment freight would have to be
+   * tendered by. Null when the shipping calendar carries no cutoff.
+   */
+  ship_by_cutoff_at: string | null;
+
+  /**
+   * The date the order would be due to ship, or null when no rule resolves one.
+   */
+  ship_by_date: string | null;
+
+  /**
+   * The derivation in order, one entry per rule that moved the date.
+   */
+  steps: Array<CommitmentQuoteStep>;
+
+  /**
+   * Days the carrier needs to cover the lane. Null when the lane has never been
+   * quoted and the service level carries no default.
+   */
+  transit_days: number | null;
+
+  /**
+   * Where the transit estimate came from.
+   */
+  transit_source: 'carrier_lane' | 'service_level' | null;
+}
+
 /**
  * The freshly estimated freight charge for a sales order.
  */
@@ -313,6 +505,62 @@ export interface ActionIssueParams {
   notify_customer: boolean;
 }
 
+export interface ActionQuoteCommitmentParams {
+  /**
+   * The buying account, used to resolve its lead time and receiving days.
+   */
+  buyer_account_id?: string;
+
+  /**
+   * Carrier for the shipment.
+   */
+  carrier_id?: string;
+
+  /**
+   * When the order would be issued. Defaults to now, since a lead time is measured
+   * from issue and an order built today but issued next week commits to next week's
+   * date.
+   */
+  issued_at?: string;
+
+  /**
+   * Days between issue and the order being due to ship, in place of the customer's
+   * standing lead time.
+   */
+  lead_time_override_days?: number;
+
+  /**
+   * Date delivery would be promised to the customer.
+   */
+  promised_at?: string;
+
+  /**
+   * An existing order to preview against. Its customer, ship-to address, carrier,
+   * and service level are used, and the commitment fields below replace whatever it
+   * currently carries.
+   *
+   * Omit it to preview an order that has not been created yet, supplying the parts
+   * directly.
+   */
+  sales_order_id?: string;
+
+  /**
+   * Service level for the shipment, which the lane's transit estimate is keyed on.
+   */
+  service_level_id?: string;
+
+  /**
+   * The exact date the order would be due to ship.
+   */
+  ship_by_override_date?: string;
+
+  /**
+   * The ship-to address, which decides the destination timezone and the lane transit
+   * is quoted on.
+   */
+  ship_to_address_id?: string;
+}
+
 export interface ActionCreateProductionRunParams {
   /**
    * Sub-objects to expand in the response. When omitted, sub-objects are returned as
@@ -324,12 +572,16 @@ export interface ActionCreateProductionRunParams {
 export declare namespace Actions {
   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,
   };
 }

package/src/resources/sales/sales-orders/index.ts

@@ -3,12 +3,16 @@
 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';
 export {

package/src/resources/sales/sales-orders/sales-orders.ts

@@ -16,10 +16,14 @@ import {
   ActionBulkDeleteResponse,
   ActionCreateProductionRunParams,
   ActionIssueParams,
+  ActionQuoteCommitmentParams,
   Actions,
   BulkDeleteSalesOrdersRequest,
+  CommitmentQuoteStep,
   IssueSalesOrderRequest,
   ProductionRun,
+  QuoteSalesOrderCommitmentRequest,
+  QuoteSalesOrderCommitmentResponse,
   QuoteSalesOrderFreightResponse,
 } from './actions';
 import * as LinesAPI from './lines/lines';
@@ -456,6 +460,15 @@ export interface CreateSalesOrderRequest {
    */
   invoice_email_contacts?: Array<SalesOrderEmailContactInput>;
 
+  /**
+   * Days between this order being issued and it being due to ship, replacing the
+   * customer's standing lead time for this order alone.
+   *
+   * Already a ship lead time, so no carrier transit is subtracted from it. Mutually
+   * exclusive with promised_at and ship_by_override_date.
+   */
+  lead_time_override_days?: number;
+
   /**
    * Free-form note about the order.
    */
@@ -479,6 +492,11 @@ export interface CreateSalesOrderRequest {
 
   /**
    * Date delivery is promised to the customer.
+   *
+   * The order's ship-by date is worked back from this: the goods have to reach the
+   * customer on a day they receive, so transit and both operating calendars are
+   * subtracted from it. Mutually exclusive with lead_time_override_days and
+   * ship_by_override_date.
    */
   promised_at?: string;
 
@@ -501,6 +519,16 @@ export interface CreateSalesOrderRequest {
    */
   service_level_id?: string;
 
+  /**
+   * The exact date the order is due to ship, bypassing transit and the customer's
+   * receiving days.
+   *
+   * Still moved back to the nearest earlier day the plant ships on, since a date
+   * nobody can ship on is not a deadline. Mutually exclusive with promised_at and
+   * lead_time_override_days.
+   */
+  ship_by_override_date?: string;
+
   /**
    * ID of the shipping terms for the order.
    *
@@ -919,6 +947,15 @@ export interface SalesOrder {
    */
   bill_to_address: APIKeysAPI.Address | null;
 
+  /**
+   * Days the customer's receiving calendar and the plant's shipping calendar pulled
+   * the ship-by date back, beyond what carrier transit accounted for.
+   *
+   * Zero means every date along the way already fell on an open day. This is what
+   * explains a ship-by date that is earlier than transit alone would suggest.
+   */
+  calendar_adjustment_days: number | null;
+
   /**
    * When the order was fulfilled and closed.
    */
@@ -983,10 +1020,23 @@ export interface SalesOrder {
    */
   lead_time_days: number | null;
 
+  /**
+   * Days between issue and the ship-by date, set on this order alone in place of the
+   * customer's standing lead time.
+   */
+  lead_time_override_days: number | null;
+
   /**
    * Which rule produced the ship-by date.
    */
-  lead_time_source: 'customer' | 'account_group' | 'account' | 'manual' | null;
+  lead_time_source:
+    | 'customer'
+    | 'account_group'
+    | 'account'
+    | 'manual'
+    | 'order_lead_time'
+    | 'order_ship_by'
+    | null;
 
   /**
    * Number of lines on this order.
@@ -1066,20 +1116,37 @@ export interface SalesOrder {
    */
   sales_rep: RequestLogsAPI.Actor | null;
 
+  /**
+   * The ship-by date at the plant's pickup cutoff — the moment freight has to be
+   * tendered by, not just the day.
+   *
+   * Only set when the account's shipping calendar carries a cutoff time.
+   */
+  ship_by_cutoff_at: string | null;
+
   /**
    * Date this order is contractually due to ship.
    *
    * Stamped when the order is issued. With a promised delivery date, this is that
-   * date less the carrier's transit for the order's lane, counted in business days —
-   * the day the order has to leave to arrive when promised. Otherwise it comes from
-   * the lead time on the customer, its account group, or the account.
+   * date less the carrier's transit for the order's lane and less any day the
+   * customer cannot receive on — the day the order has to leave to arrive when
+   * promised. Otherwise it comes from a lead time, whether this order's own or the
+   * one on the customer, its account group, or the account.
    *
-   * It is not recomputed afterwards, so neither renegotiating a customer's lead time
-   * nor a later carrier estimate moves commitments already made. Cleared if the
-   * order is unissued.
+   * Always a day the plant actually ships on, whichever rule produced it.
+   *
+   * It is not recomputed afterwards, so neither renegotiating a customer's lead
+   * time, nor a later carrier estimate, nor a holiday added to a calendar moves
+   * commitments already made. Cleared if the order is unissued.
    */
   ship_by_date: string | null;
 
+  /**
+   * The ship date pinned on this order, bypassing transit and the customer's
+   * receiving days.
+   */
+  ship_by_override_date: string | null;
+
   /**
    * A saved address that can be used for billing and shipping on sales orders,
    * invoices, and shipments.
@@ -1469,6 +1536,13 @@ export interface UpdateSalesOrderRequest {
    */
   invoice_email_contacts?: Array<SalesOrderEmailContactInput>;
 
+  /**
+   * Days between this order being issued and it being due to ship, replacing the
+   * customer's standing lead time for this order alone. Mutually exclusive with
+   * promised_at and ship_by_override_date; clear one to switch to another.
+   */
+  lead_time_override_days?: number | null;
+
   /**
    * Free-form note about the order.
    */
@@ -1507,6 +1581,12 @@ export interface UpdateSalesOrderRequest {
    */
   service_level_id?: string | null;
 
+  /**
+   * The exact date the order is due to ship, bypassing transit and the customer's
+   * receiving days. Mutually exclusive with promised_at and lead_time_override_days.
+   */
+  ship_by_override_date?: string | null;
+
   /**
    * Shipping address ID.
    *
@@ -1840,6 +1920,15 @@ export interface SalesOrderCreateParams {
    */
   invoice_email_contacts?: Array<SalesOrderEmailContactInput>;
 
+  /**
+   * Body param: Days between this order being issued and it being due to ship,
+   * replacing the customer's standing lead time for this order alone.
+   *
+   * Already a ship lead time, so no carrier transit is subtracted from it. Mutually
+   * exclusive with promised_at and ship_by_override_date.
+   */
+  lead_time_override_days?: number;
+
   /**
    * Body param: Free-form note about the order.
    */
@@ -1864,6 +1953,11 @@ export interface SalesOrderCreateParams {
 
   /**
    * Body param: Date delivery is promised to the customer.
+   *
+   * The order's ship-by date is worked back from this: the goods have to reach the
+   * customer on a day they receive, so transit and both operating calendars are
+   * subtracted from it. Mutually exclusive with lead_time_override_days and
+   * ship_by_override_date.
    */
   promised_at?: string;
 
@@ -1886,6 +1980,16 @@ export interface SalesOrderCreateParams {
    */
   service_level_id?: string;
 
+  /**
+   * Body param: The exact date the order is due to ship, bypassing transit and the
+   * customer's receiving days.
+   *
+   * Still moved back to the nearest earlier day the plant ships on, since a date
+   * nobody can ship on is not a deadline. Mutually exclusive with promised_at and
+   * lead_time_override_days.
+   */
+  ship_by_override_date?: string;
+
   /**
    * Body param: ID of the shipping terms for the order.
    *
@@ -1993,6 +2097,14 @@ export interface SalesOrderUpdateParams {
    */
   invoice_email_contacts?: Array<SalesOrderEmailContactInput>;
 
+  /**
+   * Body param: Days between this order being issued and it being due to ship,
+   * replacing the customer's standing lead time for this order alone. Mutually
+   * exclusive with promised_at and ship_by_override_date; clear one to switch to
+   * another.
+   */
+  lead_time_override_days?: number | null;
+
   /**
    * Body param: Free-form note about the order.
    */
@@ -2031,6 +2143,13 @@ export interface SalesOrderUpdateParams {
    */
   service_level_id?: string | null;
 
+  /**
+   * Body param: The exact date the order is due to ship, bypassing transit and the
+   * customer's receiving days. Mutually exclusive with promised_at and
+   * lead_time_override_days.
+   */
+  ship_by_override_date?: string | null;
+
   /**
    * Body param: Shipping address ID.
    *
@@ -2108,12 +2227,16 @@ export declare namespace SalesOrders {
   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,
   };
 

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.18.0'; // x-release-please-version
+export const VERSION = '0.18.1'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.18.0";
+export declare const VERSION = "0.18.1";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.18.0";
+export declare const VERSION = "0.18.1";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.18.0'; // x-release-please-version
+exports.VERSION = '0.18.1'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.18.0'; // x-release-please-version
+export const VERSION = '0.18.1'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map