@augno/sdk 0.13.4 → 0.15.0

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

@@ -126,6 +126,44 @@ export class Actions extends APIResource {
     });
   }
 
+  /**
+   * Returns the earliest date the published schedule could ship a quantity of an
+   * item.
+   *
+   * Quoted from the published version — the plan the floor is actually working to —
+   * and net of everything already promised to other orders. A date backed by stock
+   * somebody else is owed is not a date, so existing commitments are consumed before
+   * anything is offered.
+   *
+   * The answer allows for finishing after the constraint stage completes, so it is a
+   * ship date rather than a production date. When the published horizon cannot
+   * supply the quantity at all, `is_promisable` is false and no date is returned: a
+   * plan that runs thirteen weeks cannot speak for the fourteenth, and inventing a
+   * date beyond it would be the one number a customer actually relies on.
+   *
+   * Quoting does not reserve anything. Two quotes taken a minute apart can both come
+   * back with the same date, and only issuing an order commits the supply.
+   *
+   * This endpoint requires the permission: `production_schedules:read`.
+   *
+   * @example
+   * ```ts
+   * const promiseDateQuote =
+   *   await client.operations.productionSchedules.actions.quotePromiseDate(
+   *     { item_id: 'it_pej07ckhvu62', quantity: 1200 },
+   *   );
+   * ```
+   */
+  quotePromiseDate(
+    body: ActionQuotePromiseDateParams,
+    options?: RequestOptions,
+  ): APIPromise<PromiseDateQuote> {
+    return this._client.post('/v1/operations/production-schedules/actions/quote-promise-date', {
+      body,
+      ...options,
+    });
+  }
+
   /**
    * Publishes a draft schedule, freezing its first weeks.
    *
@@ -509,6 +547,71 @@ export interface ProductionScheduleRegeneratePreview {
   solver_version: string;
 }
 
+/**
+ * The earliest date the published plan could ship a quantity of an item.
+ */
+export interface PromiseDateQuote {
+  /**
+   * Earliest date the quantity could ship, allowing for finishing after the
+   * constraint stage completes.
+   */
+  earliest_ship_date: string | null;
+
+  /**
+   * Horizon week the constraint stage would complete in.
+   */
+  earliest_week_index: number | null;
+
+  /**
+   * Whether the published horizon can supply it at all.
+   *
+   * False means the plan as published runs out before it could cover this quantity.
+   * That is not the same as "never" — it is the honest limit of a plan that only
+   * runs so many weeks.
+   */
+  is_promisable: boolean;
+
+  /**
+   * Entity is a polymorphic reference to any resource in the system.
+   */
+  item: CoreAPI.Entity | null;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'promise_date_quote';
+
+  /**
+   * Entity is a polymorphic reference to any resource in the system.
+   */
+  production_schedule: CoreAPI.Entity | null;
+
+  /**
+   * Version number of that schedule.
+   */
+  production_schedule_version: number;
+
+  /**
+   * The quantity being quoted.
+   */
+  quantity: number;
+}
+
+/**
+ * Request to quote the earliest date a quantity could ship.
+ */
+export interface QuotePromiseDateRequest {
+  /**
+   * Item being quoted.
+   */
+  item_id: string;
+
+  /**
+   * Quantity being quoted, in the item's own unit.
+   */
+  quantity: number;
+}
+
 /**
  * Request to re-solve a draft in place.
  */
@@ -766,6 +869,26 @@ export interface SchedulePolicy {
    */
   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.
    */
@@ -796,6 +919,12 @@ export interface SchedulePolicy {
    */
   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';
+
   /**
    * Stock position at which a campaign is triggered.
    */
@@ -955,6 +1084,18 @@ export interface ActionRegenerateParams {
   planning_as_of?: string;
 }
 
+export interface ActionQuotePromiseDateParams {
+  /**
+   * Item being quoted.
+   */
+  item_id: string;
+
+  /**
+   * Quantity being quoted, in the item's own unit.
+   */
+  quantity: number;
+}
+
 export interface ActionReleaseWeekParams {
   /**
    * ID of the account user accountable for executing the run.
@@ -987,6 +1128,8 @@ export declare namespace Actions {
     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,
@@ -997,6 +1140,7 @@ export declare namespace Actions {
     type ActionPreviewParams as ActionPreviewParams,
     type ActionPreviewRegenerateParams as ActionPreviewRegenerateParams,
     type ActionRegenerateParams as ActionRegenerateParams,
+    type ActionQuotePromiseDateParams as ActionQuotePromiseDateParams,
     type ActionReleaseWeekParams as ActionReleaseWeekParams,
   };
 }

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

@@ -10,6 +10,8 @@ export {
   type PreviewRegenerateProductionScheduleRequest,
   type ProductionSchedulePreview,
   type ProductionScheduleRegeneratePreview,
+  type PromiseDateQuote,
+  type QuotePromiseDateRequest,
   type RegenerateProductionScheduleRequest,
   type ReleaseProductionScheduleWeekRequest,
   type ReleaseScheduleWeekResult,
@@ -20,6 +22,7 @@ export {
   type ActionPreviewParams,
   type ActionPreviewRegenerateParams,
   type ActionRegenerateParams,
+  type ActionQuotePromiseDateParams,
   type ActionReleaseWeekParams,
 } from './actions';
 export {
@@ -45,6 +48,9 @@ export {
   type ListReleaseScheduleBatch,
   type ListReleasedScheduleLine,
   type ListScheduleAppliedOverride,
+  type ListScheduleAtRiskOrder,
+  type ListScheduleOrderCoverage,
+  type ListScheduleOrderCoverageLine,
   type ProductionSchedule,
   type ProductionScheduleDerivedLine,
   type ProductionScheduleDeviation,
@@ -54,7 +60,10 @@ export {
   type ReleaseScheduleWeekPreview,
   type ReleasedScheduleLine,
   type ScheduleAppliedOverride,
+  type ScheduleAtRiskOrder,
   type ScheduleDiagnostics,
+  type ScheduleOrderCoverage,
+  type ScheduleOrderCoverageLine,
   type ProductionScheduleDeleteResponse,
   type ProductionScheduleListParams,
   type ProductionScheduleCreateParams,

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/operations/scanning-stations.ts

@@ -214,8 +214,10 @@ export interface UpdateScanningStationRequest {
   /**
    * Size of the labels printed at this station, given as width-by-height (for
    * example, `1x1`).
+   *
+   * Send `null` or an empty string to clear.
    */
-  label_size?: '1x1' | '1x3' | '1x4' | '2x4';
+  label_size?: '1x1' | '1x3' | '1x4' | '2x4' | null;
 
   /**
    * Type of label printed at this station.
@@ -223,8 +225,10 @@ export interface UpdateScanningStationRequest {
    * - `tag`: a label attached to the physical product.
    * - `traveler`: a routing sheet that accompanies the batch through every
    *   production step.
+   *
+   * Send `null` or an empty string to clear.
    */
-  label_type?: 'tag' | 'traveler';
+  label_type?: 'tag' | 'traveler' | null;
 
   /**
    * Display name of the scanning station.
@@ -362,8 +366,10 @@ export interface ScanningStationUpdateParams {
   /**
    * Body param: Size of the labels printed at this station, given as width-by-height
    * (for example, `1x1`).
+   *
+   * Send `null` or an empty string to clear.
    */
-  label_size?: '1x1' | '1x3' | '1x4' | '2x4';
+  label_size?: '1x1' | '1x3' | '1x4' | '2x4' | null;
 
   /**
    * Body param: Type of label printed at this station.
@@ -371,8 +377,10 @@ export interface ScanningStationUpdateParams {
    * - `tag`: a label attached to the physical product.
    * - `traveler`: a routing sheet that accompanies the batch through every
    *   production step.
+   *
+   * Send `null` or an empty string to clear.
    */
-  label_type?: 'tag' | 'traveler';
+  label_type?: 'tag' | 'traveler' | null;
 
   /**
    * Body param: Display name of the scanning station.

package/src/resources/operations/shipping-terms.ts

@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
-import * as ProductLinesAPI from '../catalog/product-lines';
 import * as APIKeysAPI from '../auth/api-keys/api-keys';
+import * as ProductLinesAPI from '../catalog/product-lines/product-lines';
 import * as CustomersAPI from '../sales/customers/customers';
 import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';