@augno/sdk 0.14.0 → 0.15.0

package/src/resources/operations/production-schedules/production-schedules.ts

@@ -8,6 +8,7 @@ import * as ActionsAPI from './actions';
 import {
   ActionPreviewParams,
   ActionPreviewRegenerateParams,
+  ActionQuotePromiseDateParams,
   ActionRegenerateParams,
   ActionReleaseWeekParams,
   Actions,
@@ -19,6 +20,8 @@ import {
   PreviewRegenerateProductionScheduleRequest,
   ProductionSchedulePreview,
   ProductionScheduleRegeneratePreview,
+  PromiseDateQuote,
+  QuotePromiseDateRequest,
   RegenerateProductionScheduleRequest,
   ReleaseProductionScheduleWeekRequest,
   ReleaseScheduleWeekResult,
@@ -228,6 +231,36 @@ export class ProductionSchedules extends APIResource {
     });
   }
 
+  /**
+   * Returns the customer commitments this schedule version does not meet, soonest
+   * first.
+   *
+   * Three ways an order lands here. `past_due` means the constraint stage needed to
+   * start before this plan begins. `undated` means the order carries no ship-by
+   * commitment at all, so it is treated as owed now. `short` means the plan simply
+   * does not build enough of it in time — the campaigns it does allocate are listed
+   * alongside, because building three hundred of five hundred is a different
+   * conversation from building none.
+   *
+   * Read from the version's own record rather than re-solved, so what comes back is
+   * what was decided when the plan was made. A version generated before commitments
+   * were tracked reports nothing, which is correct: it made no promises it could
+   * break.
+   *
+   * This endpoint requires the permission: `production_schedules:read`.
+   *
+   * @example
+   * ```ts
+   * const listScheduleOrderCoverage =
+   *   await client.operations.productionSchedules.retrieveAtRiskOrders(
+   *     'pnsc_m4zt3z8g8src',
+   *   );
+   * ```
+   */
+  retrieveAtRiskOrders(id: string, options?: RequestOptions): APIPromise<ListScheduleOrderCoverage> {
+    return this._client.get(path`/v1/operations/production-schedules/${id}/at-risk-orders`, options);
+  }
+
   /**
    * Returns the append-only log of hand changes made to a schedule, most recent
    * first.
@@ -570,6 +603,87 @@ export interface ListScheduleAppliedOverride {
   page_info: APIKeysAPI.PageInfo;
 }
 
+/**
+ * A single page of resources, together with the metadata needed to page through
+ * the rest of the result set.
+ */
+export interface ListScheduleAtRiskOrder {
+  /**
+   * Resources in this page.
+   */
+  data: Array<ScheduleAtRiskOrder>;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'list';
+
+  /**
+   * PageInfo describes where the current page sits within a paginated result set and
+   * how to move to the adjacent pages.
+   *
+   * Page a list by following the URLs below rather than assembling cursors yourself.
+   * For a top-level list endpoint the URL repeats the original request's query
+   * string with only the cursor swapped, so following it preserves the same filters,
+   * search term, and page size.
+   */
+  page_info: APIKeysAPI.PageInfo;
+}
+
+/**
+ * A single page of resources, together with the metadata needed to page through
+ * the rest of the result set.
+ */
+export interface ListScheduleOrderCoverage {
+  /**
+   * Resources in this page.
+   */
+  data: Array<ScheduleOrderCoverage>;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'list';
+
+  /**
+   * PageInfo describes where the current page sits within a paginated result set and
+   * how to move to the adjacent pages.
+   *
+   * Page a list by following the URLs below rather than assembling cursors yourself.
+   * For a top-level list endpoint the URL repeats the original request's query
+   * string with only the cursor swapped, so following it preserves the same filters,
+   * search term, and page size.
+   */
+  page_info: APIKeysAPI.PageInfo;
+}
+
+/**
+ * A single page of resources, together with the metadata needed to page through
+ * the rest of the result set.
+ */
+export interface ListScheduleOrderCoverageLine {
+  /**
+   * Resources in this page.
+   */
+  data: Array<ScheduleOrderCoverageLine>;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'list';
+
+  /**
+   * PageInfo describes where the current page sits within a paginated result set and
+   * how to move to the adjacent pages.
+   *
+   * Page a list by following the URLs below rather than assembling cursors yourself.
+   * For a top-level list endpoint the URL repeats the original request's query
+   * string with only the cursor swapped, so following it preserves the same filters,
+   * search term, and page size.
+   */
+  page_info: APIKeysAPI.PageInfo;
+}
+
 /**
  * A saved production schedule.
  *
@@ -1140,6 +1254,26 @@ export interface ProductionScheduleItemPolicy {
    */
   finish_lead_time_weeks: number;
 
+  /**
+   * Outstanding quantity the order book already owed for this item over the horizon.
+   */
+  firm_demand_units: number;
+
+  /**
+   * Quantity the forecast projected for the same window.
+   */
+  forecast_demand_units: number;
+
+  /**
+   * How this item was planned.
+   *
+   * - `make_to_stock`: built to the forecast, holding a safety stock against its
+   *   variability.
+   * - `make_to_order`: built only against orders already on the book, holding no
+   *   buffer, so its safety stocks and reorder point are all zero.
+   */
+  fulfillment_policy: 'make_to_stock' | 'make_to_order';
+
   /**
    * Annual cost of holding one unit.
    */
@@ -1181,6 +1315,12 @@ export interface ProductionScheduleItemPolicy {
    */
   order_up_to: number;
 
+  /**
+   * Which rule decided that policy: the item itself, its product line, or the
+   * account default.
+   */
+  policy_source: 'item' | 'product_line' | 'account_default';
+
   /**
    * Entity is a polymorphic reference to any resource in the system.
    */
@@ -1479,6 +1619,53 @@ export interface ScheduleAppliedOverride {
     | null;
 }
 
+/**
+ * An order commitment the plan does not meet.
+ */
+export interface ScheduleAtRiskOrder {
+  /**
+   * Horizon week the constraint stage has to finish in for the order to ship on
+   * time.
+   */
+  due_week: number;
+
+  /**
+   * Entity is a polymorphic reference to any resource in the system.
+   */
+  item: CoreAPI.Entity | null;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'schedule_at_risk_order';
+
+  /**
+   * Why the commitment is at risk.
+   *
+   * - `past_due`: production needed to start before this plan begins.
+   * - `undated`: the order carries no ship-by commitment, so it is treated as owed
+   *   now.
+   * - `short`: the plan projects less stock than the order needs in the week it is
+   *   needed.
+   */
+  reason: 'past_due' | 'undated' | 'short';
+
+  /**
+   * Entity is a polymorphic reference to any resource in the system.
+   */
+  sales_order: CoreAPI.Entity | null;
+
+  /**
+   * SKU of that item.
+   */
+  sku: string;
+
+  /**
+   * Outstanding quantity still owed.
+   */
+  units: number;
+}
+
 /**
  * What the solver could not do, and why the plan differs from raw history.
  */
@@ -1489,6 +1676,12 @@ export interface ScheduleDiagnostics {
    */
   applied_overrides: ListScheduleAppliedOverride | null;
 
+  /**
+   * A single page of resources, together with the metadata needed to page through
+   * the rest of the result set.
+   */
+  at_risk_orders: ListScheduleAtRiskOrder | null;
+
   /**
    * Average inputs a product transition introduces, measured from history.
    */
@@ -1527,6 +1720,14 @@ export interface ScheduleDiagnostics {
    */
   excluded_item_count: number;
 
+  /**
+   * Outstanding order quantity this plan owes, expressed in the constraint item's
+   * own unit.
+   *
+   * Zero means nothing is on order and the plan is driven purely by the forecast.
+   */
+  firm_demand_units: number;
+
   /**
    * Items with no measured run rate, which cannot be scheduled because their machine
    * time is unknown.
@@ -1540,6 +1741,11 @@ export interface ScheduleDiagnostics {
    */
   machines_without_step: number;
 
+  /**
+   * Planned items built only against the order book rather than to a forecast.
+   */
+  make_to_order_item_count: number;
+
   /**
    * Batches found on those machines in the demand window.
    *
@@ -1548,6 +1754,15 @@ export interface ScheduleDiagnostics {
    */
   measured_batch_count: number;
 
+  /**
+   * Open orders carrying no ship-by commitment, dated at the front of the horizon
+   * because they are issued and unshipped.
+   *
+   * A non-zero count means orders placed before commitments were tracked still need
+   * a ship-by date.
+   */
+  undated_firm_order_count: number;
+
   /**
    * Items that cannot fit even a single lot into a machine-week and are therefore
    * never scheduled.
@@ -1555,6 +1770,92 @@ export interface ScheduleDiagnostics {
   unschedulable_skus: Array<string>;
 }
 
+/**
+ * An order this schedule does not build in time, with the campaigns covering the
+ * part it does.
+ */
+export interface ScheduleOrderCoverage {
+  /**
+   * A single page of resources, together with the metadata needed to page through
+   * the rest of the result set.
+   */
+  covering_lines: ListScheduleOrderCoverageLine | null;
+
+  /**
+   * Horizon week the constraint stage has to finish in for the order to ship on
+   * time.
+   */
+  due_week: number;
+
+  /**
+   * Entity is a polymorphic reference to any resource in the system.
+   */
+  item: CoreAPI.Entity | null;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'schedule_order_coverage';
+
+  /**
+   * Why the commitment is at risk.
+   */
+  reason: 'past_due' | 'undated' | 'short';
+
+  /**
+   * Entity is a polymorphic reference to any resource in the system.
+   */
+  sales_order: CoreAPI.Entity | null;
+
+  /**
+   * The date this order is contractually due to ship.
+   */
+  ship_by_date: string | null;
+
+  /**
+   * SKU of that item.
+   */
+  sku: string;
+
+  /**
+   * Quantity the plan does not build in time.
+   *
+   * Less than the whole order when the plan builds part of it — a mostly-built order
+   * is mostly built, and reporting the full quantity would read as a total miss.
+   */
+  units_at_risk: number;
+}
+
+/**
+ * One campaign earmarked for an order.
+ */
+export interface ScheduleOrderCoverageLine {
+  /**
+   * Quantity of that campaign earmarked for this order.
+   */
+  allocated_quantity: number;
+
+  /**
+   * Entity is a polymorphic reference to any resource in the system.
+   */
+  machine: CoreAPI.Entity | null;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'schedule_order_coverage_line';
+
+  /**
+   * Entity is a polymorphic reference to any resource in the system.
+   */
+  production_schedule_line: CoreAPI.Entity | null;
+
+  /**
+   * Horizon week it runs in.
+   */
+  week_index: number;
+}
+
 export interface ProductionScheduleDeleteResponse {}
 
 export interface ProductionScheduleListParams {
@@ -1693,6 +1994,9 @@ export declare namespace ProductionSchedules {
     type ListReleaseScheduleBatch as ListReleaseScheduleBatch,
     type ListReleasedScheduleLine as ListReleasedScheduleLine,
     type ListScheduleAppliedOverride as ListScheduleAppliedOverride,
+    type ListScheduleAtRiskOrder as ListScheduleAtRiskOrder,
+    type ListScheduleOrderCoverage as ListScheduleOrderCoverage,
+    type ListScheduleOrderCoverageLine as ListScheduleOrderCoverageLine,
     type ProductionSchedule as ProductionSchedule,
     type ProductionScheduleDerivedLine as ProductionScheduleDerivedLine,
     type ProductionScheduleDeviation as ProductionScheduleDeviation,
@@ -1702,7 +2006,10 @@ export declare namespace ProductionSchedules {
     type ReleaseScheduleWeekPreview as ReleaseScheduleWeekPreview,
     type ReleasedScheduleLine as ReleasedScheduleLine,
     type ScheduleAppliedOverride as ScheduleAppliedOverride,
+    type ScheduleAtRiskOrder as ScheduleAtRiskOrder,
     type ScheduleDiagnostics as ScheduleDiagnostics,
+    type ScheduleOrderCoverage as ScheduleOrderCoverage,
+    type ScheduleOrderCoverageLine as ScheduleOrderCoverageLine,
     type ProductionScheduleDeleteResponse as ProductionScheduleDeleteResponse,
     type ProductionScheduleListParams as ProductionScheduleListParams,
     type ProductionScheduleCreateParams as ProductionScheduleCreateParams,
@@ -1734,6 +2041,8 @@ export declare namespace ProductionSchedules {
     type PreviewRegenerateProductionScheduleRequest as PreviewRegenerateProductionScheduleRequest,
     type ProductionSchedulePreview as ProductionSchedulePreview,
     type ProductionScheduleRegeneratePreview as ProductionScheduleRegeneratePreview,
+    type PromiseDateQuote as PromiseDateQuote,
+    type QuotePromiseDateRequest as QuotePromiseDateRequest,
     type RegenerateProductionScheduleRequest as RegenerateProductionScheduleRequest,
     type ReleaseProductionScheduleWeekRequest as ReleaseProductionScheduleWeekRequest,
     type ReleaseScheduleWeekResult as ReleaseScheduleWeekResult,
@@ -1744,6 +2053,7 @@ export declare namespace ProductionSchedules {
     type ActionPreviewParams as ActionPreviewParams,
     type ActionPreviewRegenerateParams as ActionPreviewRegenerateParams,
     type ActionRegenerateParams as ActionRegenerateParams,
+    type ActionQuotePromiseDateParams as ActionQuotePromiseDateParams,
     type ActionReleaseWeekParams as ActionReleaseWeekParams,
   };
 }

package/src/resources/sales/account-groups.ts

@@ -162,6 +162,12 @@ export interface AccountGroup {
    */
   created_at: string;
 
+  /**
+   * Calendar days between an order being issued and it being due to ship, inherited
+   * by every customer in this group that has not set its own.
+   */
+  default_lead_time_days: number | null;
+
   /**
    * Free-form description of the account group.
    */
@@ -242,6 +248,12 @@ export interface CreateAccountGroupRequest {
    */
   commission_policy?: 'commission_applied' | 'commission_exempt';
 
+  /**
+   * Calendar days between an order being issued and it being due to ship, inherited
+   * by every customer in this group that has not set its own.
+   */
+  default_lead_time_days?: number;
+
   /**
    * Free-form description of the account group.
    */
@@ -298,6 +310,13 @@ export interface UpdateAccountGroupRequest {
    */
   commission_policy?: 'commission_applied' | 'commission_exempt';
 
+  /**
+   * Calendar days between an order being issued and it being due to ship, inherited
+   * by every customer in this group that has not set its own. Clearing it returns
+   * the group's customers to the account default.
+   */
+  default_lead_time_days?: number | null;
+
   /**
    * Free-form description of the account group.
    */
@@ -383,6 +402,12 @@ export interface AccountGroupCreateParams {
    */
   commission_policy?: 'commission_applied' | 'commission_exempt';
 
+  /**
+   * Calendar days between an order being issued and it being due to ship, inherited
+   * by every customer in this group that has not set its own.
+   */
+  default_lead_time_days?: number;
+
   /**
    * Free-form description of the account group.
    */
@@ -409,6 +434,13 @@ export interface AccountGroupUpdateParams {
    */
   commission_policy?: 'commission_applied' | 'commission_exempt';
 
+  /**
+   * Calendar days between an order being issued and it being due to ship, inherited
+   * by every customer in this group that has not set its own. Clearing it returns
+   * the group's customers to the account default.
+   */
+  default_lead_time_days?: number | null;
+
   /**
    * Free-form description of the account group.
    */

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

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../../core/resource';
+import * as CoreAPI from '../../core/core';
 import * as BlocksAPI from '../../messaging/blocks';
 import * as AccountGroupsAPI from '../account-groups';
 import * as AddressesAPI from '../addresses';
@@ -178,6 +179,34 @@ export class Customers extends APIResource {
   delete(id: string, options?: RequestOptions): APIPromise<CustomerDeleteResponse> {
     return this._client.delete(path`/v1/sales/customers/${id}`, options);
   }
+
+  /**
+   * Returns the ship-by lead time a new order for this customer would be committed
+   * 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.
+   *
+   * 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
+   * time here moves what future orders will promise and leaves promises already made
+   * alone.
+   *
+   * This endpoint requires the permission: `customers:read`.
+   *
+   * @example
+   * ```ts
+   * const customerLeadTime =
+   *   await client.sales.customers.retrieveLeadTime(
+   *     'ac_opnlh43ymyee',
+   *   );
+   * ```
+   */
+  retrieveLeadTime(id: string, options?: RequestOptions): APIPromise<CustomerLeadTime> {
+    return this._client.get(path`/v1/sales/customers/${id}/lead-time`, options);
+  }
 }
 
 /**
@@ -387,6 +416,14 @@ export interface CreateCustomerRequest {
    */
   freight_policy?: 'free_freight' | 'billed_freight';
 
+  /**
+   * 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.
+   */
+  lead_time_days?: number;
+
   /**
    * Free-form note about the customer.
    */
@@ -611,6 +648,14 @@ export interface CustomerContactInfo {
  * not supply its own.
  */
 export interface CustomerDefaults {
+  /**
+   * Calendar days between an order being issued and it being due to ship.
+   *
+   * Sets each order's `ship_by_date` when it is issued. With none set here the
+   * customer inherits its account group's lead time, then the account default.
+   */
+  lead_time_days: number | null;
+
   /**
    * Resource type identifier.
    */
@@ -704,6 +749,46 @@ export interface CustomerFreightPreferences {
   status: 'free_freight' | 'billed_freight';
 }
 
+/**
+ * The ship-by lead time a new order for this customer would be committed to.
+ */
+export interface CustomerLeadTime {
+  /**
+   * Entity is a polymorphic reference to any resource in the system.
+   */
+  account_group: CoreAPI.Entity | null;
+
+  /**
+   * Entity is a polymorphic reference to any resource in the system.
+   */
+  customer: CoreAPI.Entity | null;
+
+  /**
+   * Calendar days between an order being issued and it being due to ship.
+   *
+   * `0` means same-day: an order issued today would be due to ship today.
+   */
+  days: number;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'customer_lead_time';
+
+  /**
+   * Which rule in the chain produced this lead time.
+   *
+   * - `customer`: a lead time set on the customer itself.
+   * - `account_group`: inherited from the customer's account group.
+   * - `account`: the account-wide fallback.
+   *
+   * The shared `manual` value cannot appear here: it means a promised date was set
+   * on one specific order, which is a fact about that order rather than about the
+   * customer.
+   */
+  source: 'customer' | 'account_group' | 'account' | 'manual';
+}
+
 /**
  * Customer notification settings.
  */
@@ -1078,6 +1163,14 @@ export interface UpdateCustomerRequest {
    */
   freight_policy?: 'free_freight' | 'billed_freight';
 
+  /**
+   * 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.
+   */
+  lead_time_days?: number | null;
+
   /**
    * The customer's business name, as shown throughout the app and on documents.
    */
@@ -1450,6 +1543,15 @@ export interface CustomerCreateParams {
    */
   freight_policy?: 'free_freight' | 'billed_freight';
 
+  /**
+   * 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.
+   */
+  lead_time_days?: number;
+
   /**
    * Body param: Free-form note about the customer.
    */
@@ -1625,6 +1727,15 @@ export interface CustomerUpdateParams {
    */
   freight_policy?: 'free_freight' | 'billed_freight';
 
+  /**
+   * 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.
+   */
+  lead_time_days?: number | null;
+
   /**
    * Body param: The customer's business name, as shown throughout the app and on
    * documents.
@@ -1683,6 +1794,7 @@ export declare namespace Customers {
     type CustomerContactInfo as CustomerContactInfo,
     type CustomerDefaults as CustomerDefaults,
     type CustomerFreightPreferences as CustomerFreightPreferences,
+    type CustomerLeadTime as CustomerLeadTime,
     type CustomerNotificationPreferences as CustomerNotificationPreferences,
     type ListCustomer as ListCustomer,
     type ListServiceLevel as ListServiceLevel,

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

@@ -9,6 +9,7 @@ export {
   type CustomerContactInfo,
   type CustomerDefaults,
   type CustomerFreightPreferences,
+  type CustomerLeadTime,
   type CustomerNotificationPreferences,
   type ListCustomer,
   type ListServiceLevel,

package/src/resources/sales/index.ts

@@ -38,6 +38,7 @@ export {
   type CustomerContactInfo,
   type CustomerDefaults,
   type CustomerFreightPreferences,
+  type CustomerLeadTime,
   type CustomerNotificationPreferences,
   type ListCustomer,
   type ListServiceLevel,