@augno/sdk 0.18.2 → 0.19.0

package/resources/catalog/items/actions.d.ts

@@ -0,0 +1,249 @@
+import { APIResource } from "../../../core/resource.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";
+/**
+ * List and manage inventory items.
+ */
+export declare class Actions extends APIResource {
+    /**
+     * Reconciles inventory for multiple items by SKU in one call, the bulk equivalent
+     * of counting stock and correcting the books.
+     *
+     * `reconcile_type` controls whether each quantity is added to the item's current
+     * quantity (`addition`) or replaces it (`force`). The figure a `force` measures
+     * against is what is on hand net of demand nothing has covered, the same basis the
+     * single-item endpoint uses. The response reports each item as reconciled, skipped
+     * (e.g. unknown SKU), or errored (e.g. unknown unit), so a problem with one item
+     * does not fail the rest of the batch.
+     *
+     * Each correction is written to the item's inventory audit trail as a user
+     * correction, attributed to the caller.
+     *
+     * This endpoint requires the permission: `items:create`.
+     *
+     * @example
+     * ```ts
+     * const bulkReconcileItemsResponse =
+     *   await client.catalog.items.actions.bulkReconcile({
+     *     data: [
+     *       {
+     *         sku: 'ALM-2024-1001',
+     *         unit: 'kg',
+     *         quantity: '10.5',
+     *       },
+     *     ],
+     *     reconcile_type: 'addition',
+     *   });
+     * ```
+     */
+    bulkReconcile(body: ActionBulkReconcileParams, options?: RequestOptions): APIPromise<BulkReconcileItemsResponse>;
+}
+/**
+ * One item to reconcile in a bulk reconcile request.
+ */
+export interface BulkReconcileItemInput {
+    /**
+     * Quantity to apply, interpreted according to the request's `reconcile_type`.
+     *
+     * A decimal string rather than a number: a quantity that has been through a binary
+     * float is not the quantity you sent.
+     */
+    quantity: string;
+    /**
+     * SKU of the item to reconcile.
+     *
+     * Items whose SKU does not match an existing item are reported in the response's
+     * `skipped_items` rather than failing the request.
+     */
+    sku: string;
+    /**
+     * Abbreviation of a unit available to your account (e.g. `kg`).
+     *
+     * The unit is checked for existence only: the quantity is always recorded in the
+     * item's own base unit, so send figures already expressed in that unit. Rows
+     * naming an abbreviation that matches no built-in or account-defined unit are
+     * reported in the response's `errors`.
+     */
+    unit: string;
+}
+/**
+ * Request to reconcile inventory for many items at once.
+ */
+export interface BulkReconcileItemsRequest {
+    /**
+     * Items to reconcile.
+     */
+    data: Array<BulkReconcileItemInput>;
+    /**
+     * How each item's quantity is applied to its current quantity.
+     *
+     * - `addition`: adds the quantity to the item's current quantity.
+     * - `force`: sets the item's current quantity to exactly the given quantity.
+     */
+    reconcile_type: string;
+}
+/**
+ * The outcome of a bulk inventory reconciliation, reported as three separate
+ * lists.
+ */
+export interface BulkReconcileItemsResponse {
+    /**
+     * A single page of resources, together with the metadata needed to page through
+     * the rest of the result set.
+     */
+    errors: ListReconcileErrorResult | null;
+    /**
+     * Resource type identifier.
+     */
+    object: 'bulk_reconcile_items_response';
+    /**
+     * A single page of resources, together with the metadata needed to page through
+     * the rest of the result set.
+     */
+    reconciled_items: ListReconciledItemResult | null;
+    /**
+     * A single page of resources, together with the metadata needed to page through
+     * the rest of the result set.
+     */
+    skipped_items: ListSkippedItemResult | null;
+}
+/**
+ * A single page of resources, together with the metadata needed to page through
+ * the rest of the result set.
+ */
+export interface ListReconcileErrorResult {
+    /**
+     * Resources in this page.
+     */
+    data: Array<ReconcileErrorResult>;
+    /**
+     * 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 ListReconciledItemResult {
+    /**
+     * Resources in this page.
+     */
+    data: Array<ReconciledItemResult>;
+    /**
+     * 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 ListSkippedItemResult {
+    /**
+     * Resources in this page.
+     */
+    data: Array<SkippedItemResult>;
+    /**
+     * 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 submitted row that could not be reconciled.
+ */
+export interface ReconcileErrorResult {
+    /**
+     * Error message.
+     */
+    error: string;
+    /**
+     * Item SKU.
+     */
+    sku: string;
+}
+/**
+ * An item whose on-hand quantity was successfully reconciled.
+ *
+ * Both quantities are expressed in the item's own base unit, not in the unit
+ * submitted with the request.
+ */
+export interface ReconciledItemResult {
+    /**
+     * Item ID.
+     */
+    item_id: string;
+    /**
+     * Quantity after the reconciliation, as a decimal string.
+     */
+    new_quantity: string;
+    /**
+     * Quantity before the reconciliation, as a decimal string.
+     */
+    previous_quantity: string;
+    /**
+     * Item SKU.
+     */
+    sku: string;
+}
+/**
+ * A submitted row that was skipped rather than reconciled.
+ */
+export interface SkippedItemResult {
+    /**
+     * Human-readable reason the item was skipped.
+     */
+    reason: string;
+    /**
+     * Item SKU.
+     */
+    sku: string;
+}
+export interface ActionBulkReconcileParams {
+    /**
+     * Items to reconcile.
+     */
+    data: Array<BulkReconcileItemInput>;
+    /**
+     * How each item's quantity is applied to its current quantity.
+     *
+     * - `addition`: adds the quantity to the item's current quantity.
+     * - `force`: sets the item's current quantity to exactly the given quantity.
+     */
+    reconcile_type: string;
+}
+export declare namespace Actions {
+    export { type BulkReconcileItemInput as BulkReconcileItemInput, type BulkReconcileItemsRequest as BulkReconcileItemsRequest, type BulkReconcileItemsResponse as BulkReconcileItemsResponse, type ListReconcileErrorResult as ListReconcileErrorResult, type ListReconciledItemResult as ListReconciledItemResult, type ListSkippedItemResult as ListSkippedItemResult, type ReconcileErrorResult as ReconcileErrorResult, type ReconciledItemResult as ReconciledItemResult, type SkippedItemResult as SkippedItemResult, type ActionBulkReconcileParams as ActionBulkReconcileParams, };
+}
+//# sourceMappingURL=actions.d.ts.map

package/resources/catalog/items/actions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"actions.d.ts","sourceRoot":"","sources":["../../../src/resources/catalog/items/actions.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,aAAa,CACX,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;CAG1C;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;;;OAKG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;;OAKG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;;;;OAOG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAEpC;;;;;OAKG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,MAAM,EAAE,wBAAwB,GAAG,IAAI,CAAC;IAExC;;OAEG;IACH,MAAM,EAAE,+BAA+B,CAAC;IAExC;;;OAGG;IACH,gBAAgB,EAAE,wBAAwB,GAAG,IAAI,CAAC;IAElD;;;OAGG;IACH,aAAa,EAAE,qBAAqB,GAAG,IAAI,CAAC;CAC7C;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;IAElC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;;OAQG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;IAElC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;;OAQG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAE/B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;;OAQG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;;;;GAKG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAEpC;;;;;OAKG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}

package/resources/catalog/items/actions.js

@@ -0,0 +1,46 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Actions = void 0;
+const resource_1 = require("../../../core/resource.js");
+/**
+ * List and manage inventory items.
+ */
+class Actions extends resource_1.APIResource {
+    /**
+     * Reconciles inventory for multiple items by SKU in one call, the bulk equivalent
+     * of counting stock and correcting the books.
+     *
+     * `reconcile_type` controls whether each quantity is added to the item's current
+     * quantity (`addition`) or replaces it (`force`). The figure a `force` measures
+     * against is what is on hand net of demand nothing has covered, the same basis the
+     * single-item endpoint uses. The response reports each item as reconciled, skipped
+     * (e.g. unknown SKU), or errored (e.g. unknown unit), so a problem with one item
+     * does not fail the rest of the batch.
+     *
+     * Each correction is written to the item's inventory audit trail as a user
+     * correction, attributed to the caller.
+     *
+     * This endpoint requires the permission: `items:create`.
+     *
+     * @example
+     * ```ts
+     * const bulkReconcileItemsResponse =
+     *   await client.catalog.items.actions.bulkReconcile({
+     *     data: [
+     *       {
+     *         sku: 'ALM-2024-1001',
+     *         unit: 'kg',
+     *         quantity: '10.5',
+     *       },
+     *     ],
+     *     reconcile_type: 'addition',
+     *   });
+     * ```
+     */
+    bulkReconcile(body, options) {
+        return this._client.post('/v1/catalog/items/actions/bulk-reconcile', { body, ...options });
+    }
+}
+exports.Actions = Actions;
+//# sourceMappingURL=actions.js.map

package/resources/catalog/items/actions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"actions.js","sourceRoot":"","sources":["../../../src/resources/catalog/items/actions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAKrD;;GAEG;AACH,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,aAAa,CACX,IAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0CAA0C,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;CACF;AAtCD,0BAsCC"}

package/resources/catalog/items/actions.mjs

@@ -0,0 +1,42 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../../core/resource.mjs";
+/**
+ * List and manage inventory items.
+ */
+export class Actions extends APIResource {
+    /**
+     * Reconciles inventory for multiple items by SKU in one call, the bulk equivalent
+     * of counting stock and correcting the books.
+     *
+     * `reconcile_type` controls whether each quantity is added to the item's current
+     * quantity (`addition`) or replaces it (`force`). The figure a `force` measures
+     * against is what is on hand net of demand nothing has covered, the same basis the
+     * single-item endpoint uses. The response reports each item as reconciled, skipped
+     * (e.g. unknown SKU), or errored (e.g. unknown unit), so a problem with one item
+     * does not fail the rest of the batch.
+     *
+     * Each correction is written to the item's inventory audit trail as a user
+     * correction, attributed to the caller.
+     *
+     * This endpoint requires the permission: `items:create`.
+     *
+     * @example
+     * ```ts
+     * const bulkReconcileItemsResponse =
+     *   await client.catalog.items.actions.bulkReconcile({
+     *     data: [
+     *       {
+     *         sku: 'ALM-2024-1001',
+     *         unit: 'kg',
+     *         quantity: '10.5',
+     *       },
+     *     ],
+     *     reconcile_type: 'addition',
+     *   });
+     * ```
+     */
+    bulkReconcile(body, options) {
+        return this._client.post('/v1/catalog/items/actions/bulk-reconcile', { body, ...options });
+    }
+}
+//# sourceMappingURL=actions.mjs.map

package/resources/catalog/items/actions.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"actions.mjs","sourceRoot":"","sources":["../../../src/resources/catalog/items/actions.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAKtB;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,aAAa,CACX,IAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0CAA0C,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;CACF"}

package/resources/catalog/items/index.d.mts

@@ -1,3 +1,5 @@
+export { Actions, type BulkReconcileItemInput, type BulkReconcileItemsRequest, type BulkReconcileItemsResponse, type ListReconcileErrorResult, type ListReconciledItemResult, type ListSkippedItemResult, type ReconcileErrorResult, type ReconciledItemResult, type SkippedItemResult, type ActionBulkReconcileParams, } from "./actions.mjs";
 export { Attributes, type AttributeUpdateParams, type AttributeDeleteParams } from "./attributes.mjs";
-export { Items, type Item, type ItemCategory, type ItemInventory, type ItemLotDefault, type ListItem, type Quantity, type Rate, type ItemListParams, type ItemRetrieveParams, type ItemRetrieveInventoryParams, type ItemRetrieveLotDefaultParams, type ItemChangeCategoryParams, } from "./items.mjs";
+export { Inventory, type ComputedQuantity, type ItemInventory, type QuantityInput, type UpdateItemInventoryRequest, type InventoryUpdateResponse, type InventoryListParams, type InventoryUpdateParams, } from "./inventory.mjs";
+export { Items, type Item, type ItemCategory, type ItemLotDefault, type ListItem, type Rate, type ItemListParams, type ItemRetrieveParams, type ItemRetrieveLotDefaultParams, type ItemChangeCategoryParams, } from "./items.mjs";
 //# sourceMappingURL=index.d.mts.map

package/resources/catalog/items/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/resources/catalog/items/index.ts"],"names":[],"mappings":"OAEO,EAAE,UAAU,EAAE,KAAK,qBAAqB,EAAE,KAAK,qBAAqB,EAAE;OACtE,EACL,KAAK,EACL,KAAK,IAAI,EACT,KAAK,YAAY,EACjB,KAAK,aAAa,EAClB,KAAK,cAAc,EACnB,KAAK,QAAQ,EACb,KAAK,QAAQ,EACb,KAAK,IAAI,EACT,KAAK,cAAc,EACnB,KAAK,kBAAkB,EACvB,KAAK,2BAA2B,EAChC,KAAK,4BAA4B,EACjC,KAAK,wBAAwB,GAC9B"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/resources/catalog/items/index.ts"],"names":[],"mappings":"OAEO,EACL,OAAO,EACP,KAAK,sBAAsB,EAC3B,KAAK,yBAAyB,EAC9B,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,EAC7B,KAAK,wBAAwB,EAC7B,KAAK,qBAAqB,EAC1B,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,iBAAiB,EACtB,KAAK,yBAAyB,GAC/B;OACM,EAAE,UAAU,EAAE,KAAK,qBAAqB,EAAE,KAAK,qBAAqB,EAAE;OACtE,EACL,SAAS,EACT,KAAK,gBAAgB,EACrB,KAAK,aAAa,EAClB,KAAK,aAAa,EAClB,KAAK,0BAA0B,EAC/B,KAAK,uBAAuB,EAC5B,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,GAC3B;OACM,EACL,KAAK,EACL,KAAK,IAAI,EACT,KAAK,YAAY,EACjB,KAAK,cAAc,EACnB,KAAK,QAAQ,EACb,KAAK,IAAI,EACT,KAAK,cAAc,EACnB,KAAK,kBAAkB,EACvB,KAAK,4BAA4B,EACjC,KAAK,wBAAwB,GAC9B"}

package/resources/catalog/items/index.d.ts

@@ -1,3 +1,5 @@
+export { Actions, type BulkReconcileItemInput, type BulkReconcileItemsRequest, type BulkReconcileItemsResponse, type ListReconcileErrorResult, type ListReconciledItemResult, type ListSkippedItemResult, type ReconcileErrorResult, type ReconciledItemResult, type SkippedItemResult, type ActionBulkReconcileParams, } from "./actions.js";
 export { Attributes, type AttributeUpdateParams, type AttributeDeleteParams } from "./attributes.js";
-export { Items, type Item, type ItemCategory, type ItemInventory, type ItemLotDefault, type ListItem, type Quantity, type Rate, type ItemListParams, type ItemRetrieveParams, type ItemRetrieveInventoryParams, type ItemRetrieveLotDefaultParams, type ItemChangeCategoryParams, } from "./items.js";
+export { Inventory, type ComputedQuantity, type ItemInventory, type QuantityInput, type UpdateItemInventoryRequest, type InventoryUpdateResponse, type InventoryListParams, type InventoryUpdateParams, } from "./inventory.js";
+export { Items, type Item, type ItemCategory, type ItemLotDefault, type ListItem, type Rate, type ItemListParams, type ItemRetrieveParams, type ItemRetrieveLotDefaultParams, type ItemChangeCategoryParams, } from "./items.js";
 //# sourceMappingURL=index.d.ts.map

package/resources/catalog/items/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/resources/catalog/items/index.ts"],"names":[],"mappings":"OAEO,EAAE,UAAU,EAAE,KAAK,qBAAqB,EAAE,KAAK,qBAAqB,EAAE;OACtE,EACL,KAAK,EACL,KAAK,IAAI,EACT,KAAK,YAAY,EACjB,KAAK,aAAa,EAClB,KAAK,cAAc,EACnB,KAAK,QAAQ,EACb,KAAK,QAAQ,EACb,KAAK,IAAI,EACT,KAAK,cAAc,EACnB,KAAK,kBAAkB,EACvB,KAAK,2BAA2B,EAChC,KAAK,4BAA4B,EACjC,KAAK,wBAAwB,GAC9B"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/resources/catalog/items/index.ts"],"names":[],"mappings":"OAEO,EACL,OAAO,EACP,KAAK,sBAAsB,EAC3B,KAAK,yBAAyB,EAC9B,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,EAC7B,KAAK,wBAAwB,EAC7B,KAAK,qBAAqB,EAC1B,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,iBAAiB,EACtB,KAAK,yBAAyB,GAC/B;OACM,EAAE,UAAU,EAAE,KAAK,qBAAqB,EAAE,KAAK,qBAAqB,EAAE;OACtE,EACL,SAAS,EACT,KAAK,gBAAgB,EACrB,KAAK,aAAa,EAClB,KAAK,aAAa,EAClB,KAAK,0BAA0B,EAC/B,KAAK,uBAAuB,EAC5B,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,GAC3B;OACM,EACL,KAAK,EACL,KAAK,IAAI,EACT,KAAK,YAAY,EACjB,KAAK,cAAc,EACnB,KAAK,QAAQ,EACb,KAAK,IAAI,EACT,KAAK,cAAc,EACnB,KAAK,kBAAkB,EACvB,KAAK,4BAA4B,EACjC,KAAK,wBAAwB,GAC9B"}

package/resources/catalog/items/index.js

@@ -1,9 +1,13 @@
 "use strict";
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Items = exports.Attributes = void 0;
+exports.Items = exports.Inventory = exports.Attributes = exports.Actions = void 0;
+var actions_1 = require("./actions.js");
+Object.defineProperty(exports, "Actions", { enumerable: true, get: function () { return actions_1.Actions; } });
 var attributes_1 = require("./attributes.js");
 Object.defineProperty(exports, "Attributes", { enumerable: true, get: function () { return attributes_1.Attributes; } });
+var inventory_1 = require("./inventory.js");
+Object.defineProperty(exports, "Inventory", { enumerable: true, get: function () { return inventory_1.Inventory; } });
 var items_1 = require("./items.js");
 Object.defineProperty(exports, "Items", { enumerable: true, get: function () { return items_1.Items; } });
 //# sourceMappingURL=index.js.map

package/resources/catalog/items/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/resources/catalog/items/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,8CAAkG;AAAzF,wGAAA,UAAU,OAAA;AACnB,oCAciB;AAbf,8FAAA,KAAK,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/resources/catalog/items/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wCAYmB;AAXjB,kGAAA,OAAO,OAAA;AAYT,8CAAkG;AAAzF,wGAAA,UAAU,OAAA;AACnB,4CASqB;AARnB,sGAAA,SAAS,OAAA;AASX,oCAWiB;AAVf,8FAAA,KAAK,OAAA"}

package/resources/catalog/items/index.mjs

@@ -1,4 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export { Actions, } from "./actions.mjs";
 export { Attributes } from "./attributes.mjs";
+export { Inventory, } from "./inventory.mjs";
 export { Items, } from "./items.mjs";
 //# sourceMappingURL=index.mjs.map

package/resources/catalog/items/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../src/resources/catalog/items/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,UAAU,EAA0D;OACtE,EACL,KAAK,GAaN"}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../src/resources/catalog/items/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,OAAO,GAWR;OACM,EAAE,UAAU,EAA0D;OACtE,EACL,SAAS,GAQV;OACM,EACL,KAAK,GAUN"}

package/resources/catalog/items/inventory.d.mts

@@ -0,0 +1,247 @@
+import { APIResource } from "../../../core/resource.mjs";
+import * as UnitsAPI from "../units/units.mjs";
+import { APIPromise } from "../../../core/api-promise.mjs";
+import { RequestOptions } from "../../../internal/request-options.mjs";
+/**
+ * List and manage inventory items.
+ */
+export declare class Inventory extends APIResource {
+    /**
+     * Returns the stock position for an item: what is on hand, what is reserved
+     * against existing orders, what is free to promise, and what is short.
+     *
+     * Stock your account either owns or holds counts toward the on-hand figure, so
+     * customer-supplied material sitting in your facility is included. All four
+     * quantities are reported in the base unit of the item's category.
+     *
+     * This endpoint requires the permission: `items:read`.
+     *
+     * @example
+     * ```ts
+     * const itemInventory =
+     *   await client.catalog.items.inventory.list(
+     *     'it_pej07ckhvu62',
+     *   );
+     * ```
+     */
+    list(id: string, query?: InventoryListParams | null | undefined, options?: RequestOptions): APIPromise<ItemInventory>;
+    /**
+     * Adjusts or reconciles the quantity of an item you hold.
+     *
+     * With `operation` set to `adjust` (the behavior when it is omitted), `quantity`
+     * is added to the current quantity; with `reconcile`, the current quantity is set
+     * to exactly `quantity`. Either way it is the resulting difference that gets
+     * written, so a difference of zero moves no stock.
+     *
+     * The figure a `reconcile` measures against is what is on hand net of demand
+     * nothing has covered — the same figure `available_to_promise` is derived from,
+     * not the raw on-hand total. Reconciling to the quantity already reported
+     * therefore writes nothing.
+     *
+     * Stock that arrives is allocated against unfilled demand for the item, so an
+     * adjustment can settle a shortfall instead of raising the quantity free to
+     * promise. That allocation happens just after the request rather than inside it,
+     * because it walks every open issue for the item. The change is recorded in the
+     * item's inventory audit trail as a user correction attributed to the caller.
+     *
+     * This endpoint requires the permission: `items:update`.
+     *
+     * @example
+     * ```ts
+     * const inventory =
+     *   await client.catalog.items.inventory.update(
+     *     'it_pej07ckhvu62',
+     *     {
+     *       quantity: {
+     *         value: '10.5',
+     *         unit_id: 'un_82bd37dae5po',
+     *       },
+     *       customer_id: 'ac_opnlh43ymyee',
+     *       location_id: 'lc_yonnys0hx3ju',
+     *       operation: 'adjust',
+     *     },
+     *   );
+     * ```
+     */
+    update(id: string, body: InventoryUpdateParams, options?: RequestOptions): APIPromise<InventoryUpdateResponse>;
+}
+/**
+ * An amount calculated on demand rather than stored.
+ *
+ * The same shape as a quantity minus the ID, because nothing was written: it is
+ * derived per request, such as a total rolled up across invoiced lines for one
+ * analysis.
+ */
+export interface ComputedQuantity {
+    /**
+     * Formatted value with unit abbreviation (e.g. "1,200 pr").
+     */
+    display_value: string;
+    /**
+     * Resource type identifier.
+     */
+    object: 'computed_quantity';
+    /**
+     * Unit of measurement used for conversions and product quantities.
+     */
+    unit: UnitsAPI.Unit | null;
+    /**
+     * Raw decimal value, as a string to preserve precision.
+     *
+     * This is the unformatted machine value; see `display_value` for the
+     * human-readable rendering.
+     */
+    value: string;
+}
+/**
+ * The stock position for an item: what is in stock, what is already committed, and
+ * what is still free to sell.
+ *
+ * All four quantities are reported in the same unit — the base unit of the item's
+ * category. Derived figures, not stored rows: each is netted out of the ledger at
+ * read time, so none of them carries a quantity id.
+ */
+export interface ItemInventory {
+    /**
+     * An amount calculated on demand rather than stored.
+     *
+     * The same shape as a quantity minus the ID, because nothing was written: it is
+     * derived per request, such as a total rolled up across invoiced lines for one
+     * analysis.
+     */
+    available_to_promise: ComputedQuantity | null;
+    /**
+     * Resource type identifier.
+     */
+    object: 'item_inventory';
+    /**
+     * An amount calculated on demand rather than stored.
+     *
+     * The same shape as a quantity minus the ID, because nothing was written: it is
+     * derived per request, such as a total rolled up across invoiced lines for one
+     * analysis.
+     */
+    on_hand: ComputedQuantity | null;
+    /**
+     * An amount calculated on demand rather than stored.
+     *
+     * The same shape as a quantity minus the ID, because nothing was written: it is
+     * derived per request, such as a total rolled up across invoiced lines for one
+     * analysis.
+     */
+    reserved: ComputedQuantity | null;
+    /**
+     * An amount calculated on demand rather than stored.
+     *
+     * The same shape as a quantity minus the ID, because nothing was written: it is
+     * derived per request, such as a total rolled up across invoiced lines for one
+     * analysis.
+     */
+    short: ComputedQuantity | null;
+}
+/**
+ * An amount together with the unit it is expressed in.
+ *
+ * The unit may be a currency, so money amounts such as a credit limit are written
+ * the same way as physical amounts like weights or counts.
+ */
+export interface QuantityInput {
+    /**
+     * ID of the unit of measure for the value.
+     */
+    unit_id: string;
+    /**
+     * Decimal value, as a string to preserve precision.
+     */
+    value: string;
+}
+/**
+ * Request to adjust or reconcile inventory for an item.
+ */
+export interface UpdateItemInventoryRequest {
+    /**
+     * An amount together with the unit it is expressed in.
+     *
+     * The unit may be a currency, so money amounts such as a credit limit are written
+     * the same way as physical amounts like weights or counts.
+     */
+    quantity: QuantityInput;
+    /**
+     * ID of the customer account that owns the resulting inventory.
+     *
+     * Use this for stock you hold but do not own, such as customer-supplied material.
+     * It only affects quantity being added: your account stays the holder, the
+     * customer becomes the owner, and the current quantity a `reconcile` measures
+     * against is still your account's. Requires edit access to that customer.
+     */
+    customer_id?: string;
+    /**
+     * ID of the location to record the inventory change against.
+     *
+     * Must be a location in your account.
+     */
+    location_id?: string;
+    /**
+     * Lot number to record the inventory change against.
+     *
+     * The lot is created for the item if it does not already exist.
+     */
+    lot_number?: string;
+    /**
+     * How `quantity` is applied.
+     *
+     * - `adjust`: adds `quantity` to the current quantity.
+     * - `reconcile`: sets the current quantity to exactly `quantity`.
+     */
+    operation?: 'adjust' | 'reconcile';
+}
+export interface InventoryUpdateResponse {
+}
+export interface InventoryListParams {
+    /**
+     * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+     * `null`.
+     */
+    include?: Array<'on_hand' | 'reserved' | 'available_to_promise' | 'short'>;
+}
+export interface InventoryUpdateParams {
+    /**
+     * An amount together with the unit it is expressed in.
+     *
+     * The unit may be a currency, so money amounts such as a credit limit are written
+     * the same way as physical amounts like weights or counts.
+     */
+    quantity: QuantityInput;
+    /**
+     * ID of the customer account that owns the resulting inventory.
+     *
+     * Use this for stock you hold but do not own, such as customer-supplied material.
+     * It only affects quantity being added: your account stays the holder, the
+     * customer becomes the owner, and the current quantity a `reconcile` measures
+     * against is still your account's. Requires edit access to that customer.
+     */
+    customer_id?: string;
+    /**
+     * ID of the location to record the inventory change against.
+     *
+     * Must be a location in your account.
+     */
+    location_id?: string;
+    /**
+     * Lot number to record the inventory change against.
+     *
+     * The lot is created for the item if it does not already exist.
+     */
+    lot_number?: string;
+    /**
+     * How `quantity` is applied.
+     *
+     * - `adjust`: adds `quantity` to the current quantity.
+     * - `reconcile`: sets the current quantity to exactly `quantity`.
+     */
+    operation?: 'adjust' | 'reconcile';
+}
+export declare namespace Inventory {
+    export { type ComputedQuantity as ComputedQuantity, type ItemInventory as ItemInventory, type QuantityInput as QuantityInput, type UpdateItemInventoryRequest as UpdateItemInventoryRequest, type InventoryUpdateResponse as InventoryUpdateResponse, type InventoryListParams as InventoryListParams, type InventoryUpdateParams as InventoryUpdateParams, };
+}
+//# sourceMappingURL=inventory.d.mts.map

package/resources/catalog/items/inventory.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"inventory.d.mts","sourceRoot":"","sources":["../../../src/resources/catalog/items/inventory.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,QAAQ;OACb,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CACF,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC;IAI5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;CAGvC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,MAAM,EAAE,mBAAmB,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC;IAE3B;;;;;OAKG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;;;OAMG;IACH,oBAAoB,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAE9C;;OAEG;IACH,MAAM,EAAE,gBAAgB,CAAC;IAEzB;;;;;;OAMG;IACH,OAAO,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAEjC;;;;;;OAMG;IACH,QAAQ,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAElC;;;;;;OAMG;IACH,KAAK,EAAE,gBAAgB,GAAG,IAAI,CAAC;CAChC;AAED;;;;;GAKG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;;;OAKG;IACH,QAAQ,EAAE,aAAa,CAAC;IAExB;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,QAAQ,GAAG,WAAW,CAAC;CACpC;AAED,MAAM,WAAW,uBAAuB;CAAG;AAE3C,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,UAAU,GAAG,sBAAsB,GAAG,OAAO,CAAC,CAAC;CAC5E;AAED,MAAM,WAAW,qBAAqB;IACpC;;;;;OAKG;IACH,QAAQ,EAAE,aAAa,CAAC;IAExB;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,QAAQ,GAAG,WAAW,CAAC;CACpC;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}