@augno/sdk 0.18.0 → 0.18.2

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

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../../../core/resource';
 import * as CoreAPI from '../../core/core';
+import * as AccountGroupsAPI from '../account-groups';
 import * as AddressesAPI from '../addresses';
 import * as ProductLinesAPI from '../../catalog/product-lines/product-lines';
 import * as AccountPricesAPI from '../account-prices/account-prices';
@@ -181,9 +182,14 @@ export class Customers extends APIResource {
    * to.
    *
    * Resolved through the same chain the issue path stamps onto an order, most
-   * specific first: a lead time set on the customer, then on the customer's account
-   * group, then the account-wide default. `source` names which rule applied, so a
-   * form can show where the number came from rather than leaving a rep to guess.
+   * specific first: a lead time set on the customer, then on its parent account,
+   * then on the customer's account group, then the account-wide default. `source`
+   * names which rule applied, so a form can show where the number came from rather
+   * than leaving a rep to guess.
+   *
+   * A lead time set on a parent account therefore governs every child account under
+   * it that has not set its own, which is how a head office's terms are given to its
+   * locations without repeating them on each one.
    *
    * This is a preview of a commitment, not the commitment itself. An order takes its
    * own `ship_by_date` when it is issued and keeps it afterwards, so changing a lead
@@ -200,8 +206,12 @@ export class Customers extends APIResource {
    *   );
    * ```
    */
-  retrieveLeadTime(id: string, options?: RequestOptions): APIPromise<CustomerLeadTime> {
-    return this._client.get(path`/v1/sales/customers/${id}/lead-time`, options);
+  retrieveLeadTime(
+    id: string,
+    query: CustomerRetrieveLeadTimeParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CustomerLeadTime> {
+    return this._client.get(path`/v1/sales/customers/${id}/lead-time`, { query, ...options });
   }
 }
 
@@ -337,7 +347,8 @@ export interface CreateCustomerRequest {
    * Calendar days between an order being issued and it being due to ship.
    *
    * Sets each order's `ship_by_date` when it is issued. Leave unset to inherit the
-   * customer's account group lead time, then the account default.
+   * parent account's lead time, then the customer's account group lead time, then
+   * the account default.
    */
   lead_time_days?: number;
 
@@ -360,6 +371,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.
    *
@@ -382,9 +402,15 @@ export interface CreateCustomerRequest {
  */
 export interface CustomerLeadTime {
   /**
-   * Entity is a polymorphic reference to any resource in the system.
+   * A named grouping of customer accounts, used for pricing rules or to categorize
+   * accounts.
+   *
+   * A customer carries at most one group of type `type_group` as its customer type,
+   * plus any number of groups of type `pricing_group`. Membership of either kind can
+   * scope a volume discount to the customer and open up product lines for it to
+   * order from.
    */
-  account_group: CoreAPI.Entity | null;
+  account_group: AccountGroupsAPI.AccountGroup | null;
 
   /**
    * Entity is a polymorphic reference to any resource in the system.
@@ -403,10 +429,17 @@ export interface CustomerLeadTime {
    */
   object: 'customer_lead_time';
 
+  /**
+   * A business you sell to, with its contact details, default fulfillment settings,
+   * and order policies.
+   */
+  parent_customer: AccountPricesAPI.Customer | null;
+
   /**
    * Which rule in the chain produced this lead time.
    *
    * - `customer`: a lead time set on the customer itself.
+   * - `parent_customer`: inherited from the customer's parent account.
    * - `account_group`: inherited from the customer's account group.
    * - `account`: the account-wide fallback.
    *
@@ -414,7 +447,14 @@ 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'
+    | 'parent_customer'
+    | 'account_group'
+    | 'account'
+    | 'manual'
+    | 'order_lead_time'
+    | 'order_ship_by';
 }
 
 /**
@@ -534,8 +574,9 @@ export interface UpdateCustomerRequest {
   /**
    * Calendar days between an order being issued and it being due to ship.
    *
-   * Sets each order's `ship_by_date` when it is issued. Leave unset to inherit the
-   * customer's account group lead time, then the account default.
+   * Sets each order's `ship_by_date` when it is issued. Clear it to inherit the
+   * parent account's lead time, then the customer's account group lead time, then
+   * the account default.
    */
   lead_time_days?: number | null;
 
@@ -562,6 +603,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.
    *
@@ -916,7 +964,8 @@ export interface CustomerCreateParams {
    * ship.
    *
    * Sets each order's `ship_by_date` when it is issued. Leave unset to inherit the
-   * customer's account group lead time, then the account default.
+   * parent account's lead time, then the customer's account group lead time, then
+   * the account default.
    */
   lead_time_days?: number;
 
@@ -939,6 +988,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.
    *
@@ -1099,8 +1158,9 @@ export interface CustomerUpdateParams {
    * Body param: Calendar days between an order being issued and it being due to
    * ship.
    *
-   * Sets each order's `ship_by_date` when it is issued. Leave unset to inherit the
-   * customer's account group lead time, then the account default.
+   * Sets each order's `ship_by_date` when it is issued. Clear it to inherit the
+   * parent account's lead time, then the customer's account group lead time, then
+   * the account default.
    */
   lead_time_days?: number | null;
 
@@ -1128,6 +1188,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.
    *
@@ -1152,6 +1219,14 @@ export interface CustomerUpdateParams {
   url?: string | null;
 }
 
+export interface CustomerRetrieveLeadTimeParams {
+  /**
+   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+   * `null`.
+   */
+  include?: Array<'account_group' | 'parent_customer'>;
+}
+
 Customers.Actions = Actions;
 
 export declare namespace Customers {
@@ -1164,6 +1239,7 @@ export declare namespace Customers {
     type CustomerRetrieveParams as CustomerRetrieveParams,
     type CustomerCreateParams as CustomerCreateParams,
     type CustomerUpdateParams as CustomerUpdateParams,
+    type CustomerRetrieveLeadTimeParams as CustomerRetrieveLeadTimeParams,
   };
 
   export {

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

@@ -11,4 +11,5 @@ export {
   type CustomerRetrieveParams,
   type CustomerCreateParams,
   type CustomerUpdateParams,
+  type CustomerRetrieveLeadTimeParams,
 } from './customers';

package/src/resources/sales/index.ts

@@ -64,6 +64,7 @@ export {
   type CustomerRetrieveParams,
   type CustomerCreateParams,
   type CustomerUpdateParams,
+  type CustomerRetrieveLeadTimeParams,
 } from './customers/index';
 export {
   OrderDiscounts,

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,140 @@ 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;
+
+  /**
+   * When freight leaving on the ship-by date would reach the customer: transit
+   * walked forward from it and landed on a day their dock receives. Null whenever
+   * `transit_days` is, since an arrival with no journey behind it would just be the
+   * ship date wearing a different name.
+   *
+   * Reported for every basis, including the ones that do not use transit to decide
+   * the ship-by date. An order committed on a lead time has the same journey ahead
+   * of it; it simply was not worked backwards from.
+   */
+  estimated_delivery_date: string | null;
+
+  /**
+   * Calendar days between issue and the ship-by date.
+   */
+  lead_time_days: number | null;
+
+  /**
+   * Which rule produced the date.
+   */
+  lead_time_source:
+    | 'customer'
+    | 'parent_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, or when no service level was
+   * supplied to quote one on.
+   */
+  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 +519,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 +586,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 {