@augno/sdk 0.1.6

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

@@ -0,0 +1,498 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as UnitsAPI from '../units';
+import * as APIKeysAPI from '../../auth/api-keys/api-keys';
+import * as AttributesAPI from './attributes';
+import { AttributeDeleteParams, AttributeUpdateParams, Attributes } from './attributes';
+import * as PropertiesAPI from '../properties/properties';
+import * as UnitGroupsAPI from '../unit-groups/unit-groups';
+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 Items extends APIResource {
+  attributes: AttributesAPI.Attributes = new AttributesAPI.Attributes(this._client);
+
+  /**
+   * Returns an item by ID.
+   *
+   * @example
+   * ```ts
+   * const item = await client.catalog.items.retrieve(
+   *   'it_0131e386ac683e8c29a71f6f1f',
+   * );
+   * ```
+   */
+  retrieve(
+    id: string,
+    query: ItemRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Item> {
+    return this._client.get(path`/v1/catalog/items/${id}`, { query, ...options });
+  }
+
+  /**
+   * Returns a paginated list of items.
+   *
+   * @example
+   * ```ts
+   * const listItem = await client.catalog.items.list();
+   * ```
+   */
+  list(query: ItemListParams | null | undefined = {}, options?: RequestOptions): APIPromise<ListItem> {
+    return this._client.get('/v1/catalog/items', { query, ...options });
+  }
+
+  /**
+   * Changes the category of an item. When the category changes, the item's rate
+   * units are updated to the new category's base unit.
+   *
+   * @example
+   * ```ts
+   * const item = await client.catalog.items.changeCategory(
+   *   'ic_01ae7bd7bfd21ca0ab81e1357e',
+   *   { id: 'it_0131e386ac683e8c29a71f6f1f' },
+   * );
+   * ```
+   */
+  changeCategory(
+    categoryID: string,
+    params: ItemChangeCategoryParams,
+    options?: RequestOptions,
+  ): APIPromise<Item> {
+    const { id, include } = params;
+    return this._client.put(path`/v1/catalog/items/${id}/category/${categoryID}`, {
+      query: { include },
+      ...options,
+    });
+  }
+
+  /**
+   * Returns inventory quantities for an item, including on-hand, reserved,
+   * available-to-promise, and short amounts.
+   *
+   * @example
+   * ```ts
+   * const itemInventory =
+   *   await client.catalog.items.retrieveInventory(
+   *     'it_0131e386ac683e8c29a71f6f1f',
+   *   );
+   * ```
+   */
+  retrieveInventory(
+    id: string,
+    query: ItemRetrieveInventoryParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ItemInventory> {
+    return this._client.get(path`/v1/catalog/items/${id}/inventory`, { query, ...options });
+  }
+}
+
+/**
+ * Item is an inventory item (product, material, or part).
+ */
+export interface Item {
+  /**
+   * Item ID.
+   */
+  id: string;
+
+  /**
+   * List represents a paginated list of resources.
+   */
+  attributes: PropertiesAPI.ListAttribute | null;
+
+  /**
+   * Rate resource.
+   */
+  burn_rate: Rate | null;
+
+  /**
+   * ItemCategory resource.
+   */
+  category: ItemCategory | null;
+
+  /**
+   * Creation timestamp.
+   */
+  created_at: string;
+
+  /**
+   * Item description.
+   */
+  description: string | null;
+
+  /**
+   * Notes.
+   */
+  notes: string | null;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'item';
+
+  /**
+   * Stock keeping unit code.
+   */
+  sku: string;
+
+  /**
+   * Item type code.
+   */
+  type: 'product' | 'material' | 'part';
+
+  /**
+   * Rate resource.
+   */
+  unit_cost: Rate | null;
+
+  /**
+   * Rate resource.
+   */
+  unit_value: Rate | null;
+
+  /**
+   * Last updated timestamp.
+   */
+  updated_at: string;
+}
+
+/**
+ * ItemCategory resource.
+ */
+export interface ItemCategory {
+  /**
+   * Item category ID.
+   */
+  id: string;
+
+  /**
+   * Creation timestamp.
+   */
+  created_at: string;
+
+  /**
+   * Display name.
+   */
+  name: string;
+
+  /**
+   * Notes.
+   */
+  notes: string | null;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'item_category';
+
+  /**
+   * Owner describes the provenance of a resource.
+   */
+  owner: APIKeysAPI.Owner | null;
+
+  /**
+   * List represents a paginated list of resources.
+   */
+  properties: PropertiesAPI.ListProperty | null;
+
+  /**
+   * Item category type.
+   */
+  type: 'material_category' | 'product_category';
+
+  /**
+   * UnitGroup is a unit group resource.
+   */
+  unit_group: UnitGroupsAPI.UnitGroup | null;
+
+  /**
+   * Last updated timestamp.
+   */
+  updated_at: string;
+}
+
+/**
+ * ItemInventory contains inventory quantities for an item.
+ */
+export interface ItemInventory {
+  /**
+   * Value with an associated unit.
+   */
+  available_to_promise: Quantity | null;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'item_inventory';
+
+  /**
+   * Value with an associated unit.
+   */
+  on_hand: Quantity | null;
+
+  /**
+   * Value with an associated unit.
+   */
+  reserved: Quantity | null;
+
+  /**
+   * Value with an associated unit.
+   */
+  short: Quantity | null;
+}
+
+/**
+ * List represents a paginated list of resources.
+ */
+export interface ListItem {
+  /**
+   * Resources in this page.
+   */
+  data: Array<Item>;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'list';
+
+  /**
+   * PageInfo contains URL-based pagination metadata.
+   */
+  page_info: APIKeysAPI.PageInfo;
+}
+
+/**
+ * Value with an associated unit.
+ */
+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;
+
+  /**
+   * Decimal value.
+   */
+  value: string;
+}
+
+/**
+ * Rate resource.
+ */
+export interface Rate {
+  /**
+   * Rate ID.
+   */
+  id: string;
+
+  /**
+   * Creation timestamp.
+   */
+  created_at: string;
+
+  /**
+   * Unit of measurement used for conversions and product quantities.
+   */
+  denominator_unit: UnitsAPI.Unit | null;
+
+  /**
+   * Human-readable formatted value (e.g. "$25.50 / kg" or "100 kg / hr").
+   */
+  display_value: string;
+
+  /**
+   * Unit of measurement used for conversions and product quantities.
+   */
+  numerator_unit: UnitsAPI.Unit | null;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'rate';
+
+  /**
+   * Last updated timestamp.
+   */
+  updated_at: string;
+
+  /**
+   * Rate value as a decimal string.
+   */
+  value: string;
+}
+
+export interface ItemRetrieveParams {
+  /**
+   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+   * `null`.
+   */
+  include?: Array<
+    | 'category'
+    | 'unit_value'
+    | 'unit_cost'
+    | 'burn_rate'
+    | 'attributes'
+    | 'category.unit_group'
+    | 'category.properties'
+    | 'category.unit_group.base_unit'
+    | 'category.unit_group.associated_units'
+    | 'category.unit_group.associated_units.unit'
+  >;
+}
+
+export interface ItemListParams {
+  /**
+   * Filter by attribute IDs.
+   */
+  attribute_ids?: Array<string>;
+
+  /**
+   * Filter by category IDs.
+   */
+  category_ids?: Array<string>;
+
+  /**
+   * Cursor token used to retrieve the next or previous page of results.
+   */
+  cursor?: string;
+
+  /**
+   * Filter by customer account IDs (only items whose product line is accessible to
+   * any of these customers).
+   */
+  customer_ids?: Array<string>;
+
+  /**
+   * Filter items created on or before this date.
+   */
+  end_date?: string;
+
+  /**
+   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+   * `null`.
+   */
+  include?: Array<
+    | 'category'
+    | 'unit_value'
+    | 'unit_cost'
+    | 'burn_rate'
+    | 'attributes'
+    | 'category.unit_group'
+    | 'category.properties'
+    | 'category.unit_group.base_unit'
+    | 'category.unit_group.associated_units'
+    | 'category.unit_group.associated_units.unit'
+  >;
+
+  /**
+   * Maximum number of results per page (default: 100, max: 1000).
+   */
+  limit?: number;
+
+  /**
+   * Filter by product line IDs (only items whose product belongs to one of these
+   * lines).
+   */
+  product_line_ids?: Array<string>;
+
+  /**
+   * Search query used to filter results.
+   */
+  q?: string;
+
+  /**
+   * Filter items created on or after this date.
+   */
+  start_date?: string;
+
+  /**
+   * Which subassemblies to include when listing (default: all).
+   */
+  subassembly_filter?: 'all' | 'initial_only';
+
+  /**
+   * Filter by supplier ID.
+   */
+  supplier_id?: string;
+
+  /**
+   * Filter by item type codes.
+   */
+  types?: Array<string>;
+}
+
+export interface ItemChangeCategoryParams {
+  /**
+   * Path param: Item ID.
+   */
+  id: string;
+
+  /**
+   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+   * are returned as `null`.
+   */
+  include?: Array<
+    | 'category'
+    | 'unit_value'
+    | 'unit_cost'
+    | 'burn_rate'
+    | 'attributes'
+    | 'category.unit_group'
+    | 'category.properties'
+    | 'category.unit_group.base_unit'
+    | 'category.unit_group.associated_units'
+    | 'category.unit_group.associated_units.unit'
+  >;
+}
+
+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'>;
+}
+
+Items.Attributes = Attributes;
+
+export declare namespace Items {
+  export {
+    type Item as Item,
+    type ItemCategory as ItemCategory,
+    type ItemInventory as ItemInventory,
+    type ListItem as ListItem,
+    type Quantity as Quantity,
+    type Rate as Rate,
+    type ItemRetrieveParams as ItemRetrieveParams,
+    type ItemListParams as ItemListParams,
+    type ItemChangeCategoryParams as ItemChangeCategoryParams,
+    type ItemRetrieveInventoryParams as ItemRetrieveInventoryParams,
+  };
+
+  export {
+    Attributes as Attributes,
+    type AttributeUpdateParams as AttributeUpdateParams,
+    type AttributeDeleteParams as AttributeDeleteParams,
+  };
+}

package/src/resources/catalog/items.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './items/index';