@augno/sdk 0.14.0 → 0.15.1

package/src/resources/operations/operations.ts

@@ -90,6 +90,12 @@ import {
   ListCarrier,
   UpdateCarrierRequest,
 } from './carriers/carriers';
+import * as FulfillmentRecommendationsAPI from './fulfillment-recommendations/fulfillment-recommendations';
+import {
+  FulfillmentRecommendation,
+  FulfillmentRecommendations,
+  ListFulfillmentRecommendation,
+} from './fulfillment-recommendations/fulfillment-recommendations';
 import * as LocationsAPI from './locations/locations';
 import {
   CreateLocationRequest,
@@ -118,6 +124,9 @@ import {
   ListReleaseScheduleBatch,
   ListReleasedScheduleLine,
   ListScheduleAppliedOverride,
+  ListScheduleAtRiskOrder,
+  ListScheduleOrderCoverage,
+  ListScheduleOrderCoverageLine,
   ProductionSchedule,
   ProductionScheduleCreateParams,
   ProductionScheduleDeleteResponse,
@@ -134,7 +143,10 @@ import {
   ReleaseScheduleWeekPreview,
   ReleasedScheduleLine,
   ScheduleAppliedOverride,
+  ScheduleAtRiskOrder,
   ScheduleDiagnostics,
+  ScheduleOrderCoverage,
+  ScheduleOrderCoverageLine,
 } from './production-schedules/production-schedules';
 import * as ShipmentsAPI from './shipments/shipments';
 import { Shipments } from './shipments/shipments';
@@ -153,6 +165,8 @@ export class Operations extends APIResource {
     new ProductionSchedulesAPI.ProductionSchedules(this._client);
   productionScheduleSettings: ProductionScheduleSettingsAPI.ProductionScheduleSettings =
     new ProductionScheduleSettingsAPI.ProductionScheduleSettings(this._client);
+  fulfillmentRecommendations: FulfillmentRecommendationsAPI.FulfillmentRecommendations =
+    new FulfillmentRecommendationsAPI.FulfillmentRecommendations(this._client);
   locations: LocationsAPI.Locations = new LocationsAPI.Locations(this._client);
   locationTypes: LocationTypesAPI.LocationTypes = new LocationTypesAPI.LocationTypes(this._client);
   shipments: ShipmentsAPI.Shipments = new ShipmentsAPI.Shipments(this._client);
@@ -756,6 +770,7 @@ Operations.Machines = Machines;
 Operations.MachineDowntimeEvents = MachineDowntimeEvents;
 Operations.DemandOverrides = DemandOverrides;
 Operations.ProductionSchedules = ProductionSchedules;
+Operations.FulfillmentRecommendations = FulfillmentRecommendations;
 Operations.Locations = Locations;
 Operations.LocationTypes = LocationTypes;
 Operations.Shipments = Shipments;
@@ -862,6 +877,9 @@ export declare namespace Operations {
     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,
@@ -871,7 +889,10 @@ export declare namespace Operations {
     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,
@@ -886,6 +907,12 @@ export declare namespace Operations {
     type ProductionScheduleSettingUpdateParams as ProductionScheduleSettingUpdateParams,
   };
 
+  export {
+    FulfillmentRecommendations as FulfillmentRecommendations,
+    type FulfillmentRecommendation as FulfillmentRecommendation,
+    type ListFulfillmentRecommendation as ListFulfillmentRecommendation,
+  };
+
   export {
     Locations as Locations,
     type CreateLocationRequest as CreateLocationRequest,

package/src/resources/operations/production-schedule-settings/index.ts

@@ -1,5 +1,13 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+export {
+  Items,
+  type ListProductionScheduleItemSetting,
+  type ProductionScheduleItemSetting,
+  type UpsertItemSettingRequest,
+  type ItemDeleteResponse,
+  type ItemUpdateParams,
+} from './items';
 export {
   ProductionScheduleSettings,
   type UpdateProductionScheduleSettingsRequest,

package/src/resources/operations/production-schedule-settings/items.ts

@@ -0,0 +1,273 @@
+// 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 APIKeysAPI from '../../auth/api-keys/api-keys';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+/**
+ * The planning assumptions production schedules are solved against, and the per-resource overrides that mark which machines constrain the plan.
+ */
+export class Items extends APIResource {
+  /**
+   * Returns every per-item planning override in the account.
+   *
+   * Only items that have been given an override appear here. An item with none is
+   * planned on the account defaults and its product line's conventions, which is the
+   * normal case — this is the list of exceptions, not a list of every item.
+   *
+   * This endpoint requires the permission: `production_schedules:read`.
+   *
+   * @example
+   * ```ts
+   * const listProductionScheduleItemSetting =
+   *   await client.operations.productionScheduleSettings.items.list();
+   * ```
+   */
+  list(options?: RequestOptions): APIPromise<ListProductionScheduleItemSetting> {
+    return this._client.get('/v1/operations/production-schedule-settings/items', options);
+  }
+
+  /**
+   * Returns the planning overrides for one item.
+   *
+   * Fails with a not-found error when the item has none, rather than returning an
+   * empty set of overrides: an item with no overrides is planned on the account
+   * defaults and its product line's conventions, and reporting that as a resource
+   * would suggest there is something here to edit.
+   *
+   * This endpoint requires the permission: `production_schedules:read`.
+   *
+   * @example
+   * ```ts
+   * const productionScheduleItemSetting =
+   *   await client.operations.productionScheduleSettings.items.retrieve(
+   *     'example',
+   *   );
+   * ```
+   */
+  retrieve(itemID: string, options?: RequestOptions): APIPromise<ProductionScheduleItemSetting> {
+    return this._client.get(path`/v1/operations/production-schedule-settings/items/${itemID}`, options);
+  }
+
+  /**
+   * Writes the planning overrides for one item.
+   *
+   * An item has at most one set of overrides, so this replaces the existing entry
+   * rather than adding a second, and the entry keeps the ID it already had.
+   *
+   * The fulfillment policy is the most consequential of these. A `make_to_order`
+   * item contributes no forecast demand and holds no safety stock, so it is built
+   * only against orders already on the book — which is what stops a slow mover
+   * accumulating inventory nobody asked for. It also propagates: an intermediate
+   * item is planned to order only when every finished good it becomes is, so one
+   * stocked sibling keeps the whole family buffered.
+   *
+   * Overrides are read when a plan is generated, so a change takes effect on the
+   * next generated version and leaves existing ones untouched.
+   *
+   * This endpoint requires the permission: `production_schedules:update`.
+   *
+   * @example
+   * ```ts
+   * const productionScheduleItemSetting =
+   *   await client.operations.productionScheduleSettings.items.update(
+   *     'example',
+   *     {
+   *       participation_status: 'included',
+   *       fulfillment_policy: 'make_to_order',
+   *     },
+   *   );
+   * ```
+   */
+  update(
+    itemID: string,
+    body: ItemUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<ProductionScheduleItemSetting> {
+    return this._client.put(path`/v1/operations/production-schedule-settings/items/${itemID}`, {
+      body,
+      ...options,
+    });
+  }
+
+  /**
+   * Removes one item's planning overrides, returning it to the account defaults and
+   * its product line's conventions.
+   *
+   * Fails with a not-found error when the item has no overrides, rather than
+   * reporting success: a mistyped item ID would otherwise read as a change that
+   * never happened.
+   *
+   * This endpoint requires the permission: `production_schedules:update`.
+   *
+   * @example
+   * ```ts
+   * const item =
+   *   await client.operations.productionScheduleSettings.items.delete(
+   *     'example',
+   *   );
+   * ```
+   */
+  delete(itemID: string, options?: RequestOptions): APIPromise<ItemDeleteResponse> {
+    return this._client.delete(path`/v1/operations/production-schedule-settings/items/${itemID}`, options);
+  }
+}
+
+/**
+ * A single page of resources, together with the metadata needed to page through
+ * the rest of the result set.
+ */
+export interface ListProductionScheduleItemSetting {
+  /**
+   * Resources in this page.
+   */
+  data: Array<ProductionScheduleItemSetting>;
+
+  /**
+   * 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;
+}
+
+/**
+ * Planning overrides for one item, on top of the account-wide assumptions.
+ */
+export interface ProductionScheduleItemSetting {
+  /**
+   * Item setting ID.
+   */
+  id: string;
+
+  /**
+   * Creation timestamp.
+   */
+  created_at: string;
+
+  /**
+   * How this item is produced.
+   *
+   * - `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.
+   *
+   * Null inherits from the item's product line, then from the account default.
+   */
+  fulfillment_policy: 'make_to_stock' | 'make_to_order' | null;
+
+  /**
+   * Entity is a polymorphic reference to any resource in the system.
+   */
+  item: CoreAPI.Entity | null;
+
+  /**
+   * Units in one production lot for this item, overriding the lot its product line
+   * would supply.
+   */
+  lot_multiple_units: number | null;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'production_schedule_item_setting';
+
+  /**
+   * Whether this item takes part in planning.
+   *
+   * An excluded item is left out of the plan entirely: no campaigns, no policy, no
+   * capacity.
+   */
+  participation_status: 'included' | 'excluded';
+
+  /**
+   * Last updated timestamp.
+   */
+  updated_at: string;
+}
+
+/**
+ * Request to write one item's planning overrides.
+ */
+export interface UpsertItemSettingRequest {
+  /**
+   * Whether this item takes part in planning.
+   *
+   * An excluded item is left out of the plan entirely: no campaigns, no policy, no
+   * capacity.
+   */
+  participation_status: 'included' | 'excluded';
+
+  /**
+   * How this item is produced.
+   *
+   * - `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.
+   *
+   * Clearing it returns the item to its product line's policy, then to the account
+   * default.
+   */
+  fulfillment_policy?: 'make_to_stock' | 'make_to_order' | null;
+
+  /**
+   * Units in one production lot for this item, overriding the lot its product line
+   * would supply.
+   */
+  lot_multiple_units?: number;
+}
+
+export interface ItemDeleteResponse {}
+
+export interface ItemUpdateParams {
+  /**
+   * Whether this item takes part in planning.
+   *
+   * An excluded item is left out of the plan entirely: no campaigns, no policy, no
+   * capacity.
+   */
+  participation_status: 'included' | 'excluded';
+
+  /**
+   * How this item is produced.
+   *
+   * - `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.
+   *
+   * Clearing it returns the item to its product line's policy, then to the account
+   * default.
+   */
+  fulfillment_policy?: 'make_to_stock' | 'make_to_order' | null;
+
+  /**
+   * Units in one production lot for this item, overriding the lot its product line
+   * would supply.
+   */
+  lot_multiple_units?: number;
+}
+
+export declare namespace Items {
+  export {
+    type ListProductionScheduleItemSetting as ListProductionScheduleItemSetting,
+    type ProductionScheduleItemSetting as ProductionScheduleItemSetting,
+    type UpsertItemSettingRequest as UpsertItemSettingRequest,
+    type ItemDeleteResponse as ItemDeleteResponse,
+    type ItemUpdateParams as ItemUpdateParams,
+  };
+}

package/src/resources/operations/production-schedule-settings/production-schedule-settings.ts

@@ -2,6 +2,15 @@
 
 import { APIResource } from '../../../core/resource';
 import * as CoreAPI from '../../core/core';
+import * as ItemsAPI from './items';
+import {
+  ItemDeleteResponse,
+  ItemUpdateParams,
+  Items,
+  ListProductionScheduleItemSetting,
+  ProductionScheduleItemSetting,
+  UpsertItemSettingRequest,
+} from './items';
 import * as ResourcesAPI from './resources';
 import {
   ListProductionScheduleResourceSetting,
@@ -19,6 +28,7 @@ import { RequestOptions } from '../../../internal/request-options';
  */
 export class ProductionScheduleSettings extends APIResource {
   resources: ResourcesAPI.Resources = new ResourcesAPI.Resources(this._client);
+  items: ItemsAPI.Items = new ItemsAPI.Items(this._client);
 
   /**
    * Returns the planning assumptions production schedules are solved against.
@@ -73,6 +83,8 @@ export class ProductionScheduleSettings extends APIResource {
    *     changeover_max_minutes: 0,
    *     changeover_min_minutes: 0,
    *     default_constraint_lead_time_weeks: 0,
+   *     default_customer_lead_time_days: 30,
+   *     default_fulfillment_policy: 'make_to_stock',
    *     default_lot_units: 60,
    *     demand_basis: 'trailing_12',
    *     demand_window_months: 12,
@@ -191,6 +203,24 @@ export interface ProductionScheduleSettings {
    */
   default_constraint_lead_time_weeks: number;
 
+  /**
+   * Calendar days between an order being issued and it being due to ship.
+   *
+   * The last resort in the ship-by chain: a lead time set on the customer, or on the
+   * customer's account group, takes precedence. Zero means same-day shipping.
+   */
+  default_customer_lead_time_days: number;
+
+  /**
+   * How a SKU is produced when neither it nor its product line says.
+   *
+   * - `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.
+   */
+  default_fulfillment_policy: 'make_to_stock' | 'make_to_order';
+
   /**
    * Units in a default production lot.
    *
@@ -436,6 +466,27 @@ export interface UpdateProductionScheduleSettingsRequest {
    */
   default_constraint_lead_time_weeks: number;
 
+  /**
+   * Calendar days between an order being issued and it being due to ship.
+   *
+   * The last resort in the ship-by chain: a lead time set on the customer, or on the
+   * customer's account group, takes precedence. Zero commits the account to same-day
+   * shipping on every order that falls through to it, so this update replaces the
+   * whole settings object and omitting the field is not the same as leaving it
+   * alone.
+   */
+  default_customer_lead_time_days: number;
+
+  /**
+   * How a SKU is produced when neither it nor its product line says.
+   *
+   * - `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.
+   */
+  default_fulfillment_policy: 'make_to_stock' | 'make_to_order';
+
   /**
    * Units in a default production lot.
    *
@@ -663,6 +714,27 @@ export interface ProductionScheduleSettingUpdateParams {
    */
   default_constraint_lead_time_weeks: number;
 
+  /**
+   * Calendar days between an order being issued and it being due to ship.
+   *
+   * The last resort in the ship-by chain: a lead time set on the customer, or on the
+   * customer's account group, takes precedence. Zero commits the account to same-day
+   * shipping on every order that falls through to it, so this update replaces the
+   * whole settings object and omitting the field is not the same as leaving it
+   * alone.
+   */
+  default_customer_lead_time_days: number;
+
+  /**
+   * How a SKU is produced when neither it nor its product line says.
+   *
+   * - `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.
+   */
+  default_fulfillment_policy: 'make_to_stock' | 'make_to_order';
+
   /**
    * Units in a default production lot.
    *
@@ -821,6 +893,7 @@ export interface ProductionScheduleSettingUpdateParams {
 }
 
 ProductionScheduleSettings.Resources = Resources;
+ProductionScheduleSettings.Items = Items;
 
 export declare namespace ProductionScheduleSettings {
   export {
@@ -837,4 +910,13 @@ export declare namespace ProductionScheduleSettings {
     type ResourceDeleteResponse as ResourceDeleteResponse,
     type ResourceUpdateParams as ResourceUpdateParams,
   };
+
+  export {
+    Items as Items,
+    type ListProductionScheduleItemSetting as ListProductionScheduleItemSetting,
+    type ProductionScheduleItemSetting as ProductionScheduleItemSetting,
+    type UpsertItemSettingRequest as UpsertItemSettingRequest,
+    type ItemDeleteResponse as ItemDeleteResponse,
+    type ItemUpdateParams as ItemUpdateParams,
+  };
 }

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,
   };
 }