@augno/sdk 0.12.6 → 0.13.0

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

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../../../core/resource';
 import * as UnitsAPI from '../units';
+import * as CoreAPI from '../../core/core';
 import * as APIKeysAPI from '../../auth/api-keys/api-keys';
 import * as AttributesAPI from './attributes';
 import { AttributeDeleteParams, AttributeUpdateParams, Attributes } from './attributes';
@@ -73,6 +74,40 @@ export class Items extends APIResource {
     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.
+   *
+   * A lot is a doff, a pallet, a batch: the quantity production is issued in. The
+   * unit is what makes it meaningful, since 60 pairs and 60 eaches are different
+   * lots, so `quantity` should never be read without `unit`.
+   *
+   * Resolved through the same chain the production schedule uses, most specific
+   * first: a per-item override, then the item's own product line, then the product
+   * lines of the finished goods it becomes, then the account-wide default. `source`
+   * names which rule applied. Intermediate items like greige are not sold and have
+   * no product line of their own, which is why they inherit from what they become.
+   *
+   * `quantity` is `0` when nothing in the chain supplies a lot. That means the item
+   * has no lot convention, not that its lot is zero.
+   *
+   * This endpoint requires the permission: `items:read`.
+   *
+   * @example
+   * ```ts
+   * const itemLotDefault =
+   *   await client.catalog.items.retrieveLotDefault(
+   *     'it_0131e386ac683e8c29a71f6f1f',
+   *   );
+   * ```
+   */
+  retrieveLotDefault(
+    id: string,
+    query: ItemRetrieveLotDefaultParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ItemLotDefault> {
+    return this._client.get(path`/v1/catalog/items/${id}/lot-default`, { query, ...options });
+  }
+
   /**
    * Moves an item to a different category.
    *
@@ -275,6 +310,53 @@ export interface ItemInventory {
   short: Quantity | null;
 }
 
+/**
+ * The lot an item is made in — how many, counted in what.
+ *
+ * A lot is the quantity production is issued in: a doff, a pallet, a batch. The
+ * unit is what makes it meaningful, since 60 pairs and 60 eaches are different
+ * lots.
+ */
+export interface ItemLotDefault {
+  /**
+   * Entity is a polymorphic reference to any resource in the system.
+   */
+  item: CoreAPI.Entity | null;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'item_lot_default';
+
+  /**
+   * Entity is a polymorphic reference to any resource in the system.
+   */
+  product_line: CoreAPI.Entity | null;
+
+  /**
+   * Units in one lot.
+   *
+   * `0` means the item has no lot convention, not that its lot is zero.
+   */
+  quantity: number;
+
+  /**
+   * Which rule in the chain produced this lot.
+   *
+   * - `item_override`: a lot size set on the item itself.
+   * - `product_line`: the convention of the line the item sells under.
+   * - `downstream_product_line`: inherited from the finished goods this item
+   *   becomes, for intermediates that are not themselves sold.
+   * - `account_default`: the account-wide fallback.
+   */
+  source: 'item_override' | 'product_line' | 'downstream_product_line' | 'account_default' | '';
+
+  /**
+   * Unit of measurement used for conversions and product quantities.
+   */
+  unit: UnitsAPI.Unit | null;
+}
+
 /**
  * List represents a paginated list of resources.
  */
@@ -494,6 +576,14 @@ export interface ItemRetrieveInventoryParams {
   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
+   * `null`.
+   */
+  include?: Array<'unit'>;
+}
+
 export interface ItemChangeCategoryParams {
   /**
    * Path param: Item ID.
@@ -525,12 +615,14 @@ export declare namespace Items {
     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,
   };
 

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

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../../core/resource';
 import * as APIKeysAPI from '../auth/api-keys/api-keys';
+import * as ItemsAPI from './items/items';
 import * as UnitGroupsAPI from './unit-groups/unit-groups';
 import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
@@ -42,7 +43,7 @@ export class ProductLines extends APIResource {
    * ```ts
    * const productLine =
    *   await client.catalog.productLines.retrieve(
-   *     'pl_01996357326a0d3f7b129542ea',
+   *     'pdln_01996357326a0d3f7b129542ea',
    *   );
    * ```
    */
@@ -87,7 +88,7 @@ export class ProductLines extends APIResource {
    * ```ts
    * const productLine =
    *   await client.catalog.productLines.update(
-   *     'pl_01996357326a0d3f7b129542ea',
+   *     'pdln_01996357326a0d3f7b129542ea',
    *     {
    *       commission_policy: 'commission_applied',
    *       freight_policy: 'billed_freight',
@@ -122,7 +123,7 @@ export class ProductLines extends APIResource {
    * ```ts
    * const productLine =
    *   await client.catalog.productLines.delete(
-   *     'pl_01996357326a0d3f7b129542ea',
+   *     'pdln_01996357326a0d3f7b129542ea',
    *   );
    * ```
    */
@@ -168,6 +169,11 @@ export interface CreateProductLineRequest {
    * line.
    */
   unit_group_id: string;
+
+  /**
+   * A value with an associated unit, used in create and update requests.
+   */
+  default_lot?: QuantityInput;
 }
 
 /**
@@ -216,6 +222,11 @@ export interface ProductLine {
    */
   created_at: string;
 
+  /**
+   * Value with an associated unit.
+   */
+  default_lot: ItemsAPI.Quantity | null;
+
   /**
    * Free-form description of the product line.
    */
@@ -262,6 +273,21 @@ export interface ProductLine {
   updated_at: string;
 }
 
+/**
+ * A value with an associated unit, used in create and update requests.
+ */
+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 partially update a product line.
  */
@@ -275,6 +301,11 @@ export interface UpdateProductLineRequest {
    */
   commission_policy?: 'commission_applied' | 'commission_exempt';
 
+  /**
+   * A value with an associated unit, used in create and update requests.
+   */
+  default_lot?: QuantityInput | null;
+
   /**
    * Default freight policy for products in this product line.
    *
@@ -317,7 +348,7 @@ export interface ProductLineListParams {
    * Sub-objects to expand in the response. When omitted, sub-objects are returned as
    * `null`.
    */
-  include?: Array<'owner' | 'owner.account' | 'unit_group'>;
+  include?: Array<'owner' | 'owner.account' | 'unit_group' | 'default_lot' | 'default_lot.unit'>;
 
   /**
    * Maximum number of results to return in a single page.
@@ -337,7 +368,7 @@ export interface ProductLineRetrieveParams {
    * Sub-objects to expand in the response. When omitted, sub-objects are returned as
    * `null`.
    */
-  include?: Array<'owner' | 'owner.account' | 'unit_group'>;
+  include?: Array<'owner' | 'owner.account' | 'unit_group' | 'default_lot' | 'default_lot.unit'>;
 }
 
 export interface ProductLineCreateParams {
@@ -379,7 +410,12 @@ export interface ProductLineCreateParams {
    * Query param: Sub-objects to expand in the response. When omitted, sub-objects
    * are returned as `null`.
    */
-  include?: Array<'owner' | 'owner.account' | 'unit_group'>;
+  include?: Array<'owner' | 'owner.account' | 'unit_group' | 'default_lot' | 'default_lot.unit'>;
+
+  /**
+   * Body param: A value with an associated unit, used in create and update requests.
+   */
+  default_lot?: QuantityInput;
 }
 
 export interface ProductLineUpdateParams {
@@ -387,7 +423,7 @@ export interface ProductLineUpdateParams {
    * Query param: Sub-objects to expand in the response. When omitted, sub-objects
    * are returned as `null`.
    */
-  include?: Array<'owner' | 'owner.account' | 'unit_group'>;
+  include?: Array<'owner' | 'owner.account' | 'unit_group' | 'default_lot' | 'default_lot.unit'>;
 
   /**
    * Body param: Default commission policy for products in this product line.
@@ -398,6 +434,11 @@ export interface ProductLineUpdateParams {
    */
   commission_policy?: 'commission_applied' | 'commission_exempt';
 
+  /**
+   * Body param: A value with an associated unit, used in create and update requests.
+   */
+  default_lot?: QuantityInput | null;
+
   /**
    * Body param: Default freight policy for products in this product line.
    *
@@ -429,6 +470,7 @@ export declare namespace ProductLines {
     type CreateProductLineRequest as CreateProductLineRequest,
     type ListProductLine as ListProductLine,
     type ProductLine as ProductLine,
+    type QuantityInput as QuantityInput,
     type UpdateProductLineRequest as UpdateProductLineRequest,
     type ProductLineDeleteResponse as ProductLineDeleteResponse,
     type ProductLineListParams as ProductLineListParams,

package/src/resources/catalog/products.ts

@@ -70,7 +70,7 @@ export class Products extends APIResource {
    *   notes:
    *     'Ships with a 2-year warranty; register for extended coverage.',
    *   portal_visibility: 'visible',
-   *   product_line_id: 'pl_01996357326a0d3f7b129542ea',
+   *   product_line_id: 'pdln_01996357326a0d3f7b129542ea',
    *   unit_cost: {
    *     value: '112.00',
    *     numerator_unit_id: 'un_01966263f74a5a0cae356000a1',
@@ -153,7 +153,7 @@ export class Products extends APIResource {
    * ```ts
    * const product =
    *   await client.catalog.products.changeProductLine(
-   *     'pl_01996357326a0d3f7b129542ea',
+   *     'pdln_01996357326a0d3f7b129542ea',
    *     { id: 'pd_013c29ab3f1518d0004094c316' },
    *   );
    * ```