@openmrp/sdk 0.20.0 → 0.22.0

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

@@ -409,73 +409,30 @@ export interface QuoteSalesOrderCommitmentRequest {
  */
 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.
+   * Commitment describes when a record is due to ship: what was asked for, what that
+   * resolved to, and which rule decided.
    *
-   * 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.
+   * It is a generic, reusable sub-resource shared by anything carrying a ship-by
+   * commitment — a sales order, the pick that fulfills it, or a preview of an order
+   * that does not exist yet.
+   *
+   * The three inputs are alternative answers to the same question and at most one is
+   * ever set; `lead_time_source` reports which of them, or which level of the
+   * customer chain, produced the date. They are written flat on the create and
+   * update bodies, the way a carrier is written as `carrier_id` and read back under
+   * `freight`.
    */
-  lead_time_source:
-    | 'customer'
-    | 'parent_customer'
-    | 'account_group'
-    | 'account'
-    | 'manual'
-    | 'order_lead_time'
-    | 'order_ship_by'
-    | null;
+  commitment: SalesOrdersAPI.Commitment | 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;
 }
 
 /**

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

@@ -28,6 +28,7 @@ export {
   SalesOrders,
   type CheckoutSalesOrderRequest,
   type CheckoutSalesOrderResponse,
+  type Commitment,
   type ComputedRate,
   type CreateSalesOrderLineInput,
   type CreateSalesOrderRequest,

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

@@ -298,6 +298,117 @@ export interface CheckoutSalesOrderResponse {
   object: 'checkout_sales_order';
 }
 
+/**
+ * Commitment describes when a record is due to ship: what was asked for, what that
+ * resolved to, and which rule decided.
+ *
+ * It is a generic, reusable sub-resource shared by anything carrying a ship-by
+ * commitment — a sales order, the pick that fulfills it, or a preview of an order
+ * that does not exist yet.
+ *
+ * The three inputs are alternative answers to the same question and at most one is
+ * ever set; `lead_time_source` reports which of them, or which level of the
+ * customer chain, produced the date. They are written flat on the create and
+ * update bodies, the way a carrier is written as `carrier_id` and read back under
+ * `freight`.
+ */
+export interface Commitment {
+  /**
+   * 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 freight leaving on the ship-by date would reach the customer: transit
+   * walked forward from it and landed on a day their dock receives.
+   *
+   * Reported by the commitment preview, which is asked what a set of inputs would
+   * produce and so computes the arrival too. A record carries the commitment it was
+   * stamped with, not a projection, and leaves this null.
+   */
+  estimated_delivery_date: string | null;
+
+  /**
+   * Calendar days between issue and the ship-by date.
+   */
+  lead_time_days: number | null;
+
+  /**
+   * Days between issue and the ship-by date, set on this record 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'
+    | 'parent_customer'
+    | 'account_group'
+    | 'account'
+    | 'manual'
+    | 'order_lead_time'
+    | 'order_ship_by'
+    | null;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'commitment';
+
+  /**
+   * Date delivery was promised to the customer, if one was committed.
+   */
+  promised_at: string | null;
+
+  /**
+   * When the record is contractually due to ship.
+   *
+   * Stamped at issue. With a promised delivery date, this is that date less the
+   * carrier's transit for the order's lane and less any day the customer cannot
+   * receive on — when the order has to leave to arrive when promised. Otherwise it
+   * comes from a lead time, whether the order's own or the one on the customer, its
+   * parent account, its account group, or the account.
+   *
+   * Always a day the plant actually ships on, whichever rule produced it, and
+   * carries the plant's pickup cutoff as its time of day when the shipping calendar
+   * sets one — the moment freight has to be tendered by, not just the day. Midnight
+   * UTC means no cutoff is configured rather than a deadline at midnight.
+   *
+   * Recomputed while the order is still open whenever something it was derived from
+   * moves — the basis above, or the carrier, service level, or ship-to address the
+   * transit was quoted on. Renegotiating a customer's standing lead time or adding a
+   * holiday to a calendar does not reach back into commitments already made. Cleared
+   * if the order is unissued.
+   */
+  ship_by_date: string | null;
+
+  /**
+   * The ship date pinned by hand, bypassing transit and the customer's receiving
+   * days.
+   */
+  ship_by_override_date: string | null;
+
+  /**
+   * Business days the carrier needs to cover this lane, subtracted from the promised
+   * delivery date to reach the ship-by date.
+   *
+   * Only set when a delivery date was promised and the lane could be priced. Without
+   * it the ship-by date falls back to the promised date itself.
+   */
+  transit_days: number | null;
+
+  /**
+   * Where the transit estimate came from.
+   */
+  transit_source: 'carrier_lane' | 'service_level' | null;
+}
+
 /**
  * A rate calculated on demand rather than stored.
  *
@@ -948,13 +1059,20 @@ 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.
+   * Commitment describes when a record is due to ship: what was asked for, what that
+   * resolved to, and which rule decided.
    *
-   * 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.
+   * It is a generic, reusable sub-resource shared by anything carrying a ship-by
+   * commitment — a sales order, the pick that fulfills it, or a preview of an order
+   * that does not exist yet.
+   *
+   * The three inputs are alternative answers to the same question and at most one is
+   * ever set; `lead_time_source` reports which of them, or which level of the
+   * customer chain, produced the date. They are written flat on the create and
+   * update bodies, the way a carrier is written as `carrier_id` and read back under
+   * `freight`.
    */
-  calendar_adjustment_days: number | null;
+  commitment: Commitment | null;
 
   /**
    * When the order was fulfilled and closed.
@@ -1015,30 +1133,6 @@ export interface SalesOrder {
    */
   issued_at: string | null;
 
-  /**
-   * Calendar days between issue and the ship-by date.
-   */
-  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'
-    | 'parent_customer'
-    | 'account_group'
-    | 'account'
-    | 'manual'
-    | 'order_lead_time'
-    | 'order_ship_by'
-    | null;
-
   /**
    * Number of lines on this order.
    */
@@ -1098,11 +1192,6 @@ export interface SalesOrder {
    */
   priority: 'low' | 'normal' | 'high';
 
-  /**
-   * Date promised to the customer for delivery, if one was committed.
-   */
-  promised_at: string | null;
-
   /**
    * The fulfillment records produced from a sales order.
    *
@@ -1117,37 +1206,6 @@ 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 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 parent account, its account group, or the account.
-   *
-   * 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.
@@ -1186,20 +1244,6 @@ export interface SalesOrder {
    */
   totals: SalesOrderTotals | null;
 
-  /**
-   * Business days the carrier needs to cover this order's lane, subtracted from the
-   * promised delivery date to reach the ship-by date.
-   *
-   * Only set when a delivery date was promised and the lane could be priced. Without
-   * it the ship-by date falls back to the promised date itself.
-   */
-  transit_days: number | null;
-
-  /**
-   * Where the transit estimate came from.
-   */
-  transit_source: 'carrier_lane' | 'service_level' | null;
-
   /**
    * Last updated timestamp.
    */
@@ -2195,6 +2239,7 @@ export declare namespace SalesOrders {
   export {
     type CheckoutSalesOrderRequest as CheckoutSalesOrderRequest,
     type CheckoutSalesOrderResponse as CheckoutSalesOrderResponse,
+    type Commitment as Commitment,
     type ComputedRate as ComputedRate,
     type CreateSalesOrderLineInput as CreateSalesOrderLineInput,
     type CreateSalesOrderRequest as CreateSalesOrderRequest,

package/src/resources/sales/sales.ts

@@ -108,6 +108,7 @@ import * as SalesOrdersAPI from './sales-orders/sales-orders';
 import {
   CheckoutSalesOrderRequest,
   CheckoutSalesOrderResponse,
+  Commitment,
   ComputedRate,
   CreateSalesOrderLineInput,
   CreateSalesOrderRequest,
@@ -265,6 +266,7 @@ export declare namespace Sales {
     SalesOrders as SalesOrders,
     type CheckoutSalesOrderRequest as CheckoutSalesOrderRequest,
     type CheckoutSalesOrderResponse as CheckoutSalesOrderResponse,
+    type Commitment as Commitment,
     type ComputedRate as ComputedRate,
     type CreateSalesOrderLineInput as CreateSalesOrderLineInput,
     type CreateSalesOrderRequest as CreateSalesOrderRequest,

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.20.0'; // x-release-please-version
+export const VERSION = '0.22.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.20.0";
+export declare const VERSION = "0.22.0";
 //# 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.20.0'; // x-release-please-version
+exports.VERSION = '0.22.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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