@augno/sdk 0.1.6 → 0.7.0

package/src/resources/catalog/item-categories/index.ts

@@ -7,10 +7,10 @@ export {
   type UpdateItemCategoryRequest,
   type ItemCategoryDeleteResponse,
   type ItemCategoryChangeUnitGroupResponse,
-  type ItemCategoryCreateParams,
+  type ItemCategoryListParams,
   type ItemCategoryRetrieveParams,
+  type ItemCategoryCreateParams,
   type ItemCategoryUpdateParams,
-  type ItemCategoryListParams,
   type ItemCategoryChangeUnitGroupParams,
 } from './item-categories';
 export {

package/src/resources/catalog/item-categories/item-categories.ts

@@ -22,26 +22,26 @@ export class ItemCategories extends APIResource {
   properties: PropertiesAPI.Properties = new PropertiesAPI.Properties(this._client);
 
   /**
-   * Creates an account-owned item category.
+   * Returns a paginated list of item categories for the current account, including
+   * account-specific and global system categories.
    *
    * @example
    * ```ts
-   * const itemCategory =
-   *   await client.catalog.itemCategories.create({
-   *     name: 'Electronics',
-   *     type: 'material_category',
-   *     unit_group_id: 'ug_01aad07abb8e41fd392d2d7013',
-   *   });
+   * const listItemCategory =
+   *   await client.catalog.itemCategories.list();
    * ```
    */
-  create(params: ItemCategoryCreateParams, options?: RequestOptions): APIPromise<ItemsAPI.ItemCategory> {
-    const { include, ...body } = params;
-    return this._client.post('/v1/catalog/item-categories', { query: { include }, body, ...options });
+  list(
+    query: ItemCategoryListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ListItemCategory> {
+    return this._client.get('/v1/catalog/item-categories', { query, ...options });
   }
 
   /**
-   * Returns an item category by ID. Includes account-specific and global system
-   * categories.
+   * Returns an item category by ID.
+   *
+   * Both account-owned categories and global system categories can be retrieved.
    *
    * @example
    * ```ts
@@ -60,8 +60,28 @@ export class ItemCategories extends APIResource {
   }
 
   /**
-   * Partially updates an account-owned item category. Default system categories
-   * cannot be updated.
+   * Creates an account-owned item category.
+   *
+   * @example
+   * ```ts
+   * const itemCategory =
+   *   await client.catalog.itemCategories.create({
+   *     name: 'Electronics',
+   *     type: 'material_category',
+   *     unit_group_id: 'ug_01aad07abb8e41fd392d2d7013',
+   *   });
+   * ```
+   */
+  create(params: ItemCategoryCreateParams, options?: RequestOptions): APIPromise<ItemsAPI.ItemCategory> {
+    const { include, ...body } = params;
+    return this._client.post('/v1/catalog/item-categories', { query: { include }, body, ...options });
+  }
+
+  /**
+   * Partially updates an account-owned item category.
+   *
+   * Only the fields provided in the request body are changed. Default system
+   * categories cannot be updated.
    *
    * @example
    * ```ts
@@ -86,25 +106,9 @@ export class ItemCategories extends APIResource {
   }
 
   /**
-   * Returns a paginated list of item categories for the current account, including
-   * account-specific and global system categories.
+   * Deletes an account-owned item category.
    *
-   * @example
-   * ```ts
-   * const listItemCategory =
-   *   await client.catalog.itemCategories.list();
-   * ```
-   */
-  list(
-    query: ItemCategoryListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<ListItemCategory> {
-    return this._client.get('/v1/catalog/item-categories', { query, ...options });
-  }
-
-  /**
-   * Deletes an account-owned item category. Default system categories cannot be
-   * deleted.
+   * Default system categories cannot be deleted.
    *
    * @example
    * ```ts
@@ -119,8 +123,11 @@ export class ItemCategories extends APIResource {
   }
 
   /**
-   * Changes the unit group associated with an item category. All items in the
-   * category are updated to use the new base unit asynchronously.
+   * Changes the unit group associated with an item category.
+   *
+   * The new unit group must have the same unit type as the current one — for
+   * example, a category measured in `mass` units can only switch to another `mass`
+   * unit group. Default system categories cannot be modified.
    *
    * @example
    * ```ts
@@ -146,18 +153,26 @@ export class ItemCategories extends APIResource {
  */
 export interface CreateItemCategoryRequest {
   /**
-   * Display name.
+   * Display name of the item category.
    */
   name: string;
 
   /**
-   * Item category type. Material categories are used to group materials, while
-   * product categories are used to group products and parts.
+   * What kind of items this category groups.
+   *
+   * - `material_category`: groups raw materials and components (items of type
+   *   `material`).
+   * - `product_category`: groups finished products and parts (items of type
+   *   `product` or `part`).
    */
   type: 'material_category' | 'product_category';
 
   /**
-   * Unit group ID.
+   * ID of the unit group that determines the units of measure available to items in
+   * this category.
+   *
+   * After creation, the unit group can only be replaced by another unit group of the
+   * same unit type via the Change Item Category Unit Group endpoint.
    */
   unit_group_id: string;
 }
@@ -187,12 +202,12 @@ export interface ListItemCategory {
  */
 export interface UpdateItemCategoryRequest {
   /**
-   * Display name.
+   * Display name of the item category.
    */
   name?: string;
 
   /**
-   * Notes.
+   * Free-form notes about the item category.
    */
   notes?: string;
 }
@@ -201,26 +216,19 @@ export interface ItemCategoryDeleteResponse {}
 
 export interface ItemCategoryChangeUnitGroupResponse {}
 
-export interface ItemCategoryCreateParams {
-  /**
-   * Body param: Display name.
-   */
-  name: string;
-
-  /**
-   * Body param: Item category type. Material categories are used to group materials,
-   * while product categories are used to group products and parts.
-   */
-  type: 'material_category' | 'product_category';
-
+export interface ItemCategoryListParams {
   /**
-   * Body param: Unit group ID.
+   * Opaque cursor token identifying where the page of results starts.
+   *
+   * Use the `cursor` value embedded in a previous response's `next_page_url` or
+   * `previous_page_url` to fetch the adjacent page. Omit to start from the first
+   * page.
    */
-  unit_group_id: string;
+  cursor?: string;
 
   /**
-   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
-   * are returned as `null`.
+   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+   * `null`.
    */
   include?: Array<
     | 'owner'
@@ -231,6 +239,23 @@ export interface ItemCategoryCreateParams {
     | 'unit_group.associated_units'
     | 'unit_group.associated_units.unit'
   >;
+
+  /**
+   * Maximum number of results to return in a single page.
+   */
+  limit?: number;
+
+  /**
+   * Free-text search term used to filter results.
+   *
+   * Which fields are matched against the term varies by endpoint.
+   */
+  q?: string;
+
+  /**
+   * Filter by item category type.
+   */
+  type?: 'material_category' | 'product_category';
 }
 
 export interface ItemCategoryRetrieveParams {
@@ -249,7 +274,31 @@ export interface ItemCategoryRetrieveParams {
   >;
 }
 
-export interface ItemCategoryUpdateParams {
+export interface ItemCategoryCreateParams {
+  /**
+   * Body param: Display name of the item category.
+   */
+  name: string;
+
+  /**
+   * Body param: What kind of items this category groups.
+   *
+   * - `material_category`: groups raw materials and components (items of type
+   *   `material`).
+   * - `product_category`: groups finished products and parts (items of type
+   *   `product` or `part`).
+   */
+  type: 'material_category' | 'product_category';
+
+  /**
+   * Body param: ID of the unit group that determines the units of measure available
+   * to items in this category.
+   *
+   * After creation, the unit group can only be replaced by another unit group of the
+   * same unit type via the Change Item Category Unit Group endpoint.
+   */
+  unit_group_id: string;
+
   /**
    * Query param: Sub-objects to expand in the response. When omitted, sub-objects
    * are returned as `null`.
@@ -263,27 +312,12 @@ export interface ItemCategoryUpdateParams {
     | 'unit_group.associated_units'
     | 'unit_group.associated_units.unit'
   >;
-
-  /**
-   * Body param: Display name.
-   */
-  name?: string;
-
-  /**
-   * Body param: Notes.
-   */
-  notes?: string;
 }
 
-export interface ItemCategoryListParams {
-  /**
-   * Cursor token used to retrieve the next or previous page of results.
-   */
-  cursor?: string;
-
+export interface ItemCategoryUpdateParams {
   /**
-   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
-   * `null`.
+   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+   * are returned as `null`.
    */
   include?: Array<
     | 'owner'
@@ -296,19 +330,14 @@ export interface ItemCategoryListParams {
   >;
 
   /**
-   * Maximum number of results per page (default: 100, max: 1000).
+   * Body param: Display name of the item category.
    */
-  limit?: number;
-
-  /**
-   * Search query used to filter results.
-   */
-  q?: string;
+  name?: string;
 
   /**
-   * Filter by item category type.
+   * Body param: Free-form notes about the item category.
    */
-  type?: 'material_category' | 'product_category';
+  notes?: string;
 }
 
 export interface ItemCategoryChangeUnitGroupParams {
@@ -327,10 +356,10 @@ export declare namespace ItemCategories {
     type UpdateItemCategoryRequest as UpdateItemCategoryRequest,
     type ItemCategoryDeleteResponse as ItemCategoryDeleteResponse,
     type ItemCategoryChangeUnitGroupResponse as ItemCategoryChangeUnitGroupResponse,
-    type ItemCategoryCreateParams as ItemCategoryCreateParams,
+    type ItemCategoryListParams as ItemCategoryListParams,
     type ItemCategoryRetrieveParams as ItemCategoryRetrieveParams,
+    type ItemCategoryCreateParams as ItemCategoryCreateParams,
     type ItemCategoryUpdateParams as ItemCategoryUpdateParams,
-    type ItemCategoryListParams as ItemCategoryListParams,
     type ItemCategoryChangeUnitGroupParams as ItemCategoryChangeUnitGroupParams,
   };
 

package/src/resources/catalog/item-categories/properties.ts

@@ -10,8 +10,12 @@ import { path } from '../../../internal/utils/path';
  */
 export class Properties extends APIResource {
   /**
-   * Adds a property to an item category. Default system categories cannot be
-   * modified.
+   * Adds a property to an item category, making the property available to items in
+   * that category.
+   *
+   * Each property name can appear only once per category; adding a property whose
+   * name duplicates one already in the category returns a conflict error. Default
+   * system categories cannot be modified.
    *
    * @example
    * ```ts
@@ -32,8 +36,9 @@ export class Properties extends APIResource {
   }
 
   /**
-   * Removes a property from an item category. Default system categories cannot be
-   * modified.
+   * Removes a property from an item category.
+   *
+   * Default system categories cannot be modified.
    *
    * @example
    * ```ts

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

@@ -11,8 +11,9 @@ import { path } from '../../../internal/utils/path';
  */
 export class Attributes extends APIResource {
   /**
-   * Adds an attribute to an item. If the attribute is already associated with the
-   * item, this is a no-op.
+   * Adds an attribute to an item and returns the updated item.
+   *
+   * If the attribute is already associated with the item, this is a no-op.
    *
    * @example
    * ```ts

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

@@ -9,8 +9,8 @@ export {
   type ListItem,
   type Quantity,
   type Rate,
-  type ItemRetrieveParams,
   type ItemListParams,
-  type ItemChangeCategoryParams,
+  type ItemRetrieveParams,
   type ItemRetrieveInventoryParams,
+  type ItemChangeCategoryParams,
 } from './items';