@augno/sdk 0.13.4 → 0.15.0

package/resources/operations/production-schedule-settings/items.d.mts

@@ -0,0 +1,228 @@
+import { APIResource } from "../../../core/resource.mjs";
+import * as CoreAPI from "../../core/core.mjs";
+import * as APIKeysAPI from "../../auth/api-keys/api-keys.mjs";
+import { APIPromise } from "../../../core/api-promise.mjs";
+import { RequestOptions } from "../../../internal/request-options.mjs";
+/**
+ * The planning assumptions production schedules are solved against, and the per-resource overrides that mark which machines constrain the plan.
+ */
+export declare 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+}
+/**
+ * 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, };
+}
+//# sourceMappingURL=items.d.mts.map

package/resources/operations/production-schedule-settings/items.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"items.d.mts","sourceRoot":"","sources":["../../../src/resources/operations/production-schedule-settings/items.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,OAAO;OACZ,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;;;OAcG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iCAAiC,CAAC;IAI7E;;;;;;;;;;;;;;;;;OAiBG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,6BAA6B,CAAC;IAI7F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,MAAM,CACJ,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,gBAAgB,EACtB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAO5C;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;CAGjF;AAED;;;GAGG;AACH,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,6BAA6B,CAAC,CAAC;IAE3C;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;;OAQG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;;;;;OASG;IACH,kBAAkB,EAAE,eAAe,GAAG,eAAe,GAAG,IAAI,CAAC;IAE7D;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,MAAM,EAAE,kCAAkC,CAAC;IAE3C;;;;;OAKG;IACH,oBAAoB,EAAE,UAAU,GAAG,UAAU,CAAC;IAE9C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;;;;OAKG;IACH,oBAAoB,EAAE,UAAU,GAAG,UAAU,CAAC;IAE9C;;;;;;;;;;OAUG;IACH,kBAAkB,CAAC,EAAE,eAAe,GAAG,eAAe,GAAG,IAAI,CAAC;IAE9D;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,kBAAkB;CAAG;AAEtC,MAAM,WAAW,gBAAgB;IAC/B;;;;;OAKG;IACH,oBAAoB,EAAE,UAAU,GAAG,UAAU,CAAC;IAE9C;;;;;;;;;;OAUG;IACH,kBAAkB,CAAC,EAAE,eAAe,GAAG,eAAe,GAAG,IAAI,CAAC;IAE9D;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}

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

@@ -0,0 +1,228 @@
+import { APIResource } from "../../../core/resource.js";
+import * as CoreAPI from "../../core/core.js";
+import * as APIKeysAPI from "../../auth/api-keys/api-keys.js";
+import { APIPromise } from "../../../core/api-promise.js";
+import { RequestOptions } from "../../../internal/request-options.js";
+/**
+ * The planning assumptions production schedules are solved against, and the per-resource overrides that mark which machines constrain the plan.
+ */
+export declare 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+}
+/**
+ * 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, };
+}
+//# sourceMappingURL=items.d.ts.map

package/resources/operations/production-schedule-settings/items.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"items.d.ts","sourceRoot":"","sources":["../../../src/resources/operations/production-schedule-settings/items.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,OAAO;OACZ,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;;;OAcG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iCAAiC,CAAC;IAI7E;;;;;;;;;;;;;;;;;OAiBG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,6BAA6B,CAAC;IAI7F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,MAAM,CACJ,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,gBAAgB,EACtB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAO5C;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;CAGjF;AAED;;;GAGG;AACH,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,6BAA6B,CAAC,CAAC;IAE3C;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;;OAQG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;;;;;OASG;IACH,kBAAkB,EAAE,eAAe,GAAG,eAAe,GAAG,IAAI,CAAC;IAE7D;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,MAAM,EAAE,kCAAkC,CAAC;IAE3C;;;;;OAKG;IACH,oBAAoB,EAAE,UAAU,GAAG,UAAU,CAAC;IAE9C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;;;;OAKG;IACH,oBAAoB,EAAE,UAAU,GAAG,UAAU,CAAC;IAE9C;;;;;;;;;;OAUG;IACH,kBAAkB,CAAC,EAAE,eAAe,GAAG,eAAe,GAAG,IAAI,CAAC;IAE9D;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,kBAAkB;CAAG;AAEtC,MAAM,WAAW,gBAAgB;IAC/B;;;;;OAKG;IACH,oBAAoB,EAAE,UAAU,GAAG,UAAU,CAAC;IAE9C;;;;;;;;;;OAUG;IACH,kBAAkB,CAAC,EAAE,eAAe,GAAG,eAAe,GAAG,IAAI,CAAC;IAE9D;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}

package/resources/operations/production-schedule-settings/items.js

@@ -0,0 +1,109 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Items = void 0;
+const resource_1 = require("../../../core/resource.js");
+const path_1 = require("../../../internal/utils/path.js");
+/**
+ * The planning assumptions production schedules are solved against, and the per-resource overrides that mark which machines constrain the plan.
+ */
+class Items extends resource_1.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) {
+        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, options) {
+        return this._client.get((0, path_1.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, body, options) {
+        return this._client.put((0, path_1.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, options) {
+        return this._client.delete((0, path_1.path) `/v1/operations/production-schedule-settings/items/${itemID}`, options);
+    }
+}
+exports.Items = Items;
+//# sourceMappingURL=items.js.map

package/resources/operations/production-schedule-settings/items.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"items.js","sourceRoot":"","sources":["../../../src/resources/operations/production-schedule-settings/items.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAKrD,0DAAoD;AAEpD;;GAEG;AACH,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;;;;;;;;;;;;OAcG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mDAAmD,EAAE,OAAO,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,QAAQ,CAAC,MAAc,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,qDAAqD,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IACtG,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,MAAM,CACJ,MAAc,EACd,IAAsB,EACtB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,qDAAqD,MAAM,EAAE,EAAE;YACzF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,MAAc,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,qDAAqD,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IACzG,CAAC;CACF;AAxGD,sBAwGC"}

package/resources/operations/production-schedule-settings/items.mjs

@@ -0,0 +1,105 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../../core/resource.mjs";
+import { path } from "../../../internal/utils/path.mjs";
+/**
+ * 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) {
+        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, options) {
+        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, body, options) {
+        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, options) {
+        return this._client.delete(path `/v1/operations/production-schedule-settings/items/${itemID}`, options);
+    }
+}
+//# sourceMappingURL=items.mjs.map