@augno/sdk 0.17.0 → 0.18.1

package/src/resources/sales/priorities.ts

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../../core/resource';
 import * as APIKeysAPI from '../auth/api-keys/api-keys';
+import * as AccountPricesAPI from './account-prices/account-prices';
 import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
@@ -50,7 +51,7 @@ export class Priorities extends APIResource {
     id: string,
     query: PriorityRetrieveParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<Priority> {
+  ): APIPromise<AccountPricesAPI.Priority> {
     return this._client.get(path`/v1/sales/priorities/${id}`, { query, ...options });
   }
 }
@@ -63,7 +64,7 @@ export interface ListPriority {
   /**
    * Resources in this page.
    */
-  data: Array<Priority>;
+  data: Array<AccountPricesAPI.Priority>;
 
   /**
    * Resource type identifier.
@@ -82,54 +83,6 @@ export interface ListPriority {
   page_info: APIKeysAPI.PageInfo;
 }
 
-/**
- * Priority level used to order work on sales orders, purchase orders, and picks.
- *
- * The levels are platform-provided and the same for every account, so they cannot
- * be created, renamed, or removed. A customer can carry a default priority that
- * pre-fills new orders for them.
- */
-export interface Priority {
-  /**
-   * Priority ID.
-   */
-  id: string;
-
-  /**
-   * Machine-readable code identifying the priority level.
-   *
-   * Other resources refer to a priority by this code rather than by its ID, such as
-   * a sales order's `priority`, and it can be used in place of the ID when
-   * retrieving a priority.
-   */
-  code: 'low' | 'normal' | 'high';
-
-  /**
-   * Creation timestamp.
-   */
-  created_at: string;
-
-  /**
-   * Display name of the priority level.
-   */
-  name: string;
-
-  /**
-   * Resource type identifier.
-   */
-  object: 'priority';
-
-  /**
-   * Owner describes the provenance of a resource.
-   */
-  owner: APIKeysAPI.Owner | null;
-
-  /**
-   * Last updated timestamp.
-   */
-  updated_at: string;
-}
-
 export interface PriorityListParams {
   /**
    * Opaque cursor token identifying where the page of results starts.
@@ -170,7 +123,6 @@ export interface PriorityRetrieveParams {
 export declare namespace Priorities {
   export {
     type ListPriority as ListPriority,
-    type Priority as Priority,
     type PriorityListParams as PriorityListParams,
     type PriorityRetrieveParams as PriorityRetrieveParams,
   };

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 {
@@ -35,7 +39,6 @@ export {
   type ListSalesOrderLine,
   type ListSalesOrderStatus,
   type OrderContact,
-  type OrderDiscount,
   type QuoteSalesOrderLineInput,
   type QuoteSalesOrderPricesRequest,
   type QuoteSalesOrderPricesResponse,

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

@@ -169,7 +169,7 @@ export interface UpdateSalesOrderLineRequest {
   /**
    * Description recorded on the line.
    */
-  product_description?: string;
+  product_description?: string | null;
 
   /**
    * SKU recorded on the line.
@@ -260,7 +260,7 @@ export interface LineUpdateParams {
   /**
    * Body param: Description recorded on the line.
    */
-  product_description?: string;
+  product_description?: string | null;
 
   /**
    * Body param: SKU recorded on the line.