@augno/sdk 0.18.2 → 0.19.0

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

@@ -1,18 +1,38 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+export {
+  Actions,
+  type BulkReconcileItemInput,
+  type BulkReconcileItemsRequest,
+  type BulkReconcileItemsResponse,
+  type ListReconcileErrorResult,
+  type ListReconciledItemResult,
+  type ListSkippedItemResult,
+  type ReconcileErrorResult,
+  type ReconciledItemResult,
+  type SkippedItemResult,
+  type ActionBulkReconcileParams,
+} from './actions';
 export { Attributes, type AttributeUpdateParams, type AttributeDeleteParams } from './attributes';
+export {
+  Inventory,
+  type ComputedQuantity,
+  type ItemInventory,
+  type QuantityInput,
+  type UpdateItemInventoryRequest,
+  type InventoryUpdateResponse,
+  type InventoryListParams,
+  type InventoryUpdateParams,
+} from './inventory';
 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';

package/src/resources/catalog/items/inventory.ts

@@ -0,0 +1,294 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as UnitsAPI from '../units/units';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+/**
+ * List and manage inventory items.
+ */
+export 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> {
+    return this._client.get(path`/v1/catalog/items/${id}/inventory`, { query, ...options });
+  }
+
+  /**
+   * 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> {
+    return this._client.patch(path`/v1/catalog/items/${id}/inventory`, { body, ...options });
+  }
+}
+
+/**
+ * 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,
+  };
+}

package/src/resources/catalog/items/items.ts

@@ -3,8 +3,33 @@
 import { APIResource } from '../../../core/resource';
 import * as CoreAPI from '../../core/core';
 import * as APIKeysAPI from '../../auth/api-keys/api-keys';
+import * as ActionsAPI from './actions';
+import {
+  ActionBulkReconcileParams,
+  Actions,
+  BulkReconcileItemInput,
+  BulkReconcileItemsRequest,
+  BulkReconcileItemsResponse,
+  ListReconcileErrorResult,
+  ListReconciledItemResult,
+  ListSkippedItemResult,
+  ReconcileErrorResult,
+  ReconciledItemResult,
+  SkippedItemResult,
+} from './actions';
 import * as AttributesAPI from './attributes';
 import { AttributeDeleteParams, AttributeUpdateParams, Attributes } from './attributes';
+import * as InventoryAPI from './inventory';
+import {
+  ComputedQuantity,
+  Inventory,
+  InventoryListParams,
+  InventoryUpdateParams,
+  InventoryUpdateResponse,
+  ItemInventory,
+  QuantityInput,
+  UpdateItemInventoryRequest,
+} from './inventory';
 import * as PropertiesAPI from '../properties/properties';
 import * as UnitGroupsAPI from '../unit-groups/unit-groups';
 import * as UnitsAPI from '../units/units';
@@ -16,7 +41,9 @@ import { path } from '../../../internal/utils/path';
  * List and manage inventory items.
  */
 export class Items extends APIResource {
+  inventory: InventoryAPI.Inventory = new InventoryAPI.Inventory(this._client);
   attributes: AttributesAPI.Attributes = new AttributesAPI.Attributes(this._client);
+  actions: ActionsAPI.Actions = new ActionsAPI.Actions(this._client);
 
   /**
    * Returns a paginated list of items, newest first.
@@ -57,32 +84,6 @@ export class Items extends APIResource {
     return this._client.get(path`/v1/catalog/items/${id}`, { query, ...options });
   }
 
-  /**
-   * 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.retrieveInventory(
-   *     'it_pej07ckhvu62',
-   *   );
-   * ```
-   */
-  retrieveInventory(
-    id: string,
-    query: ItemRetrieveInventoryParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<ItemInventory> {
-    return this._client.get(path`/v1/catalog/items/${id}/inventory`, { query, ...options });
-  }
-
   /**
    * Returns the lot this item is made in — how many, counted in what.
    *
@@ -300,56 +301,6 @@ export interface ItemCategory {
   updated_at: 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.
- */
-export interface ItemInventory {
-  /**
-   * A measured amount: a numeric value together with the unit it is expressed in.
-   *
-   * Quantities are shared building blocks rather than standalone records — other
-   * resources point at them to report stock levels, ordered and packed amounts,
-   * money, weights, and durations.
-   */
-  available_to_promise: Quantity | null;
-
-  /**
-   * Resource type identifier.
-   */
-  object: 'item_inventory';
-
-  /**
-   * A measured amount: a numeric value together with the unit it is expressed in.
-   *
-   * Quantities are shared building blocks rather than standalone records — other
-   * resources point at them to report stock levels, ordered and packed amounts,
-   * money, weights, and durations.
-   */
-  on_hand: Quantity | null;
-
-  /**
-   * A measured amount: a numeric value together with the unit it is expressed in.
-   *
-   * Quantities are shared building blocks rather than standalone records — other
-   * resources point at them to report stock levels, ordered and packed amounts,
-   * money, weights, and durations.
-   */
-  reserved: Quantity | null;
-
-  /**
-   * A measured amount: a numeric value together with the unit it is expressed in.
-   *
-   * Quantities are shared building blocks rather than standalone records — other
-   * resources point at them to report stock levels, ordered and packed amounts,
-   * money, weights, and durations.
-   */
-  short: Quantity | null;
-}
-
 /**
  * The lot an item is made in — how many, counted in what.
  *
@@ -427,43 +378,6 @@ export interface ListItem {
   page_info: APIKeysAPI.PageInfo;
 }
 
-/**
- * A measured amount: a numeric value together with the unit it is expressed in.
- *
- * Quantities are shared building blocks rather than standalone records — other
- * resources point at them to report stock levels, ordered and packed amounts,
- * money, weights, and durations.
- */
-export interface Quantity {
-  /**
-   * Quantity ID.
-   */
-  id: string;
-
-  /**
-   * Formatted value with unit abbreviation (e.g. "$1,234.56" or "100 kg").
-   */
-  display_value: string;
-
-  /**
-   * Resource type identifier.
-   */
-  object: 'quantity';
-
-  /**
-   * Unit of measurement used for conversions and product quantities.
-   */
-  unit: UnitsAPI.Unit | null;
-
-  /**
-   * Raw decimal value of the quantity, as a string to preserve precision.
-   *
-   * This is the unformatted machine value; see `display_value` for the
-   * human-readable rendering with unit and thousands separators.
-   */
-  value: string;
-}
-
 /**
  * Value expressed as a ratio of two units, such as a price per kilogram or a
  * throughput per hour.
@@ -627,14 +541,6 @@ export interface ItemRetrieveParams {
   >;
 }
 
-export interface ItemRetrieveInventoryParams {
-  /**
-   * 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 ItemRetrieveLotDefaultParams {
   /**
    * Sub-objects to expand in the response. When omitted, sub-objects are returned as
@@ -667,27 +573,51 @@ export interface ItemChangeCategoryParams {
   >;
 }
 
+Items.Inventory = Inventory;
 Items.Attributes = Attributes;
+Items.Actions = Actions;
 
 export declare namespace Items {
   export {
     type Item as Item,
     type ItemCategory as ItemCategory,
-    type ItemInventory as ItemInventory,
     type ItemLotDefault as ItemLotDefault,
     type ListItem as ListItem,
-    type Quantity as Quantity,
     type Rate as Rate,
     type ItemListParams as ItemListParams,
     type ItemRetrieveParams as ItemRetrieveParams,
-    type ItemRetrieveInventoryParams as ItemRetrieveInventoryParams,
     type ItemRetrieveLotDefaultParams as ItemRetrieveLotDefaultParams,
     type ItemChangeCategoryParams as ItemChangeCategoryParams,
   };
 
+  export {
+    Inventory as Inventory,
+    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,
+  };
+
   export {
     Attributes as Attributes,
     type AttributeUpdateParams as AttributeUpdateParams,
     type AttributeDeleteParams as AttributeDeleteParams,
   };
+
+  export {
+    Actions as Actions,
+    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,
+  };
 }

package/src/resources/catalog/materials/index.ts

@@ -12,6 +12,7 @@ export {
   type CreateMaterialRequest,
   type ListMaterial,
   type Material,
+  type Quantity,
   type QuantityInputRequest,
   type RateInput,
   type UpdateMaterialRequest,

package/src/resources/catalog/materials/materials.ts

@@ -11,6 +11,7 @@ import {
   UpsertMaterialInput,
   UpsertMaterialProperty,
 } from './actions';
+import * as UnitsAPI from '../units/units';
 import { APIPromise } from '../../../core/api-promise';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
@@ -301,7 +302,7 @@ export interface Material {
    * resources point at them to report stock levels, ordered and packed amounts,
    * money, weights, and durations.
    */
-  lead_time: ItemsAPI.Quantity | null;
+  lead_time: Quantity | null;
 
   /**
    * Resource type identifier.
@@ -315,7 +316,7 @@ export interface Material {
    * resources point at them to report stock levels, ordered and packed amounts,
    * money, weights, and durations.
    */
-  order_point: ItemsAPI.Quantity | null;
+  order_point: Quantity | null;
 
   /**
    * Last updated timestamp.
@@ -323,6 +324,43 @@ export interface Material {
   updated_at: string;
 }
 
+/**
+ * A measured amount: a numeric value together with the unit it is expressed in.
+ *
+ * Quantities are shared building blocks rather than standalone records — other
+ * resources point at them to report stock levels, ordered and packed amounts,
+ * money, weights, and durations.
+ */
+export interface Quantity {
+  /**
+   * Quantity ID.
+   */
+  id: string;
+
+  /**
+   * Formatted value with unit abbreviation (e.g. "$1,234.56" or "100 kg").
+   */
+  display_value: string;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'quantity';
+
+  /**
+   * Unit of measurement used for conversions and product quantities.
+   */
+  unit: UnitsAPI.Unit | null;
+
+  /**
+   * Raw decimal value of the quantity, as a string to preserve precision.
+   *
+   * This is the unformatted machine value; see `display_value` for the
+   * human-readable rendering with unit and thousands separators.
+   */
+  value: string;
+}
+
 /**
  * A quantity, given as a decimal value and the unit it is measured in.
  */
@@ -620,6 +658,7 @@ export declare namespace Materials {
     type CreateMaterialRequest as CreateMaterialRequest,
     type ListMaterial as ListMaterial,
     type Material as Material,
+    type Quantity as Quantity,
     type QuantityInputRequest as QuantityInputRequest,
     type RateInput as RateInput,
     type UpdateMaterialRequest as UpdateMaterialRequest,

package/src/resources/catalog/product-lines/index.ts

@@ -11,7 +11,6 @@ export {
   type CreateProductLineRequest,
   type ListProductLine,
   type ProductLine,
-  type QuantityInput,
   type UpdateProductLineRequest,
   type ProductLineDeleteResponse,
   type ProductLineListParams,