@augno/sdk 0.7.0 → 0.9.0

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

@@ -25,6 +25,8 @@ export class ItemCategories extends APIResource {
    * Returns a paginated list of item categories for the current account, including
    * account-specific and global system categories.
    *
+   * This endpoint requires the permission: `item_categories:read`.
+   *
    * @example
    * ```ts
    * const listItemCategory =
@@ -43,6 +45,8 @@ export class ItemCategories extends APIResource {
    *
    * Both account-owned categories and global system categories can be retrieved.
    *
+   * This endpoint requires the permission: `item_categories:read`.
+   *
    * @example
    * ```ts
    * const itemCategory =
@@ -62,6 +66,8 @@ export class ItemCategories extends APIResource {
   /**
    * Creates an account-owned item category.
    *
+   * This endpoint requires the permission: `item_categories:create`.
+   *
    * @example
    * ```ts
    * const itemCategory =
@@ -83,12 +89,18 @@ export class ItemCategories extends APIResource {
    * Only the fields provided in the request body are changed. Default system
    * categories cannot be updated.
    *
+   * This endpoint requires the permission: `item_categories:update`.
+   *
    * @example
    * ```ts
    * const itemCategory =
    *   await client.catalog.itemCategories.update(
    *     'ic_01ae7bd7bfd21ca0ab81e1357e',
-   *     { name: 'Electronic Components' },
+   *     {
+   *       name: 'Electronic Components',
+   *       notes:
+   *         'Covers passive and active components; excludes assemblies.',
+   *     },
    *   );
    * ```
    */
@@ -110,6 +122,8 @@ export class ItemCategories extends APIResource {
    *
    * Default system categories cannot be deleted.
    *
+   * This endpoint requires the permission: `item_categories:delete`.
+   *
    * @example
    * ```ts
    * const itemCategory =
@@ -129,6 +143,8 @@ export class ItemCategories extends APIResource {
    * example, a category measured in `mass` units can only switch to another `mass`
    * unit group. Default system categories cannot be modified.
    *
+   * This endpoint requires the permission: `item_categories:update`.
+   *
    * @example
    * ```ts
    * const response =

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

@@ -17,6 +17,8 @@ export class Properties extends APIResource {
    * name duplicates one already in the category returns a conflict error. Default
    * system categories cannot be modified.
    *
+   * This endpoint requires the permission: `item_categories:update`.
+   *
    * @example
    * ```ts
    * const property =
@@ -40,6 +42,8 @@ export class Properties extends APIResource {
    *
    * Default system categories cannot be modified.
    *
+   * This endpoint requires the permission: `item_categories:update`.
+   *
    * @example
    * ```ts
    * const property =

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

@@ -15,6 +15,8 @@ export class Attributes extends APIResource {
    *
    * If the attribute is already associated with the item, this is a no-op.
    *
+   * This endpoint requires the permission: `items:update`.
+   *
    * @example
    * ```ts
    * const item = await client.catalog.items.attributes.update(
@@ -38,6 +40,8 @@ export class Attributes extends APIResource {
   /**
    * Removes an attribute from an item.
    *
+   * This endpoint requires the permission: `items:update`.
+   *
    * @example
    * ```ts
    * const item = await client.catalog.items.attributes.delete(

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

@@ -20,6 +20,8 @@ export class Items extends APIResource {
   /**
    * Returns a paginated list of items.
    *
+   * This endpoint requires the permission: `items:read`.
+   *
    * @example
    * ```ts
    * const listItem = await client.catalog.items.list();
@@ -32,6 +34,8 @@ export class Items extends APIResource {
   /**
    * Returns an item by ID.
    *
+   * This endpoint requires the permission: `items:read`.
+   *
    * @example
    * ```ts
    * const item = await client.catalog.items.retrieve(
@@ -51,6 +55,8 @@ export class Items extends APIResource {
    * Returns inventory quantities for an item, including on-hand, reserved,
    * available-to-promise, and short amounts.
    *
+   * This endpoint requires the permission: `items:read`.
+   *
    * @example
    * ```ts
    * const itemInventory =
@@ -74,6 +80,8 @@ export class Items extends APIResource {
    * order-point, consumption, and production quantity units are updated to the new
    * category's base unit. Re-assigning the item's current category is a no-op.
    *
+   * This endpoint requires the permission: `items:update`.
+   *
    * @example
    * ```ts
    * const item = await client.catalog.items.changeCategory(

package/src/resources/catalog/materials.ts

@@ -14,6 +14,9 @@ export class Materials extends APIResource {
   /**
    * Returns a paginated list of materials.
    *
+   * This endpoint requires the permissions: `materials:read`, `customers:read`,
+   * `suppliers:read`.
+   *
    * @example
    * ```ts
    * const listMaterial = await client.catalog.materials.list();
@@ -29,6 +32,9 @@ export class Materials extends APIResource {
   /**
    * Returns a material by ID.
    *
+   * This endpoint requires the permissions: `materials:read`, `customers:read`,
+   * `suppliers:read`.
+   *
    * @example
    * ```ts
    * const material = await client.catalog.materials.retrieve(
@@ -50,11 +56,37 @@ export class Materials extends APIResource {
    * Inventory tracking for the new material starts at a zero on-hand quantity in the
    * category's base unit.
    *
+   * This endpoint requires the permissions: `materials:create`, `customers:update`,
+   * `suppliers:update`.
+   *
    * @example
    * ```ts
    * const material = await client.catalog.materials.create({
    *   category_id: 'ic_01ae7bd7bfd21ca0ab81e1357e',
    *   sku: 'MAT-001',
+   *   attribute_ids: ['at_01c9493ec0c46bb0ed12708ae4'],
+   *   description:
+   *     'Cold-rolled 304 stainless steel sheet, 1.5mm',
+   *   lead_time: {
+   *     value: '7.00',
+   *     unit_id: 'un_01966263f74a5a0cae356000a1',
+   *   },
+   *   notes:
+   *     'Store flat in a dry area to avoid surface oxidation.',
+   *   order_point: {
+   *     value: '100.00',
+   *     unit_id: 'un_01966263f74a5a0cae356000a1',
+   *   },
+   *   unit_cost: {
+   *     value: '8.25',
+   *     numerator_unit_id: 'un_01966263f74a5a0cae356000a1',
+   *     denominator_unit_id: 'un_01966263f74a5a0cae356000a1',
+   *   },
+   *   unit_price: {
+   *     value: '12.50',
+   *     numerator_unit_id: 'un_01966263f74a5a0cae356000a1',
+   *     denominator_unit_id: 'un_01966263f74a5a0cae356000a1',
+   *   },
    * });
    * ```
    */
@@ -68,11 +100,32 @@ export class Materials extends APIResource {
    *
    * Fields not provided retain their current values.
    *
+   * This endpoint requires the permissions: `materials:update`, `customers:update`,
+   * `suppliers:update`.
+   *
    * @example
    * ```ts
    * const material = await client.catalog.materials.update(
    *   'ml_014613b8f7959a091d8cc0cef4',
-   *   { sku: 'MAT-001-UPDATED' },
+   *   {
+   *     description:
+   *       'Cold-rolled 304 stainless steel sheet, 2.0mm',
+   *     lead_time: {
+   *       value: '10.00',
+   *       unit_id: 'un_01966263f74a5a0cae356000a1',
+   *     },
+   *     notes: 'Reorder point raised after Q2 demand spike.',
+   *     order_point: {
+   *       value: '150.00',
+   *       unit_id: 'un_01966263f74a5a0cae356000a1',
+   *     },
+   *     sku: 'MAT-001-UPDATED',
+   *     unit_cost: {
+   *       value: '9.10',
+   *       numerator_unit_id: 'un_01966263f74a5a0cae356000a1',
+   *       denominator_unit_id: 'un_01966263f74a5a0cae356000a1',
+   *     },
+   *   },
    * );
    * ```
    */
@@ -92,6 +145,9 @@ export class Materials extends APIResource {
    * other endpoints, but the record is retained. Deleting an already-deleted
    * material returns an error.
    *
+   * This endpoint requires the permissions: `materials:delete`, `customers:update`,
+   * `suppliers:update`.
+   *
    * @example
    * ```ts
    * const material = await client.catalog.materials.delete(
@@ -135,7 +191,7 @@ export interface CreateMaterialRequest {
   description?: string;
 
   /**
-   * QuantityInputRequest is a quantity value and unit.
+   * A quantity, given as a decimal value and the unit it is measured in.
    */
   lead_time?: QuantityInputRequest;
 
@@ -145,7 +201,7 @@ export interface CreateMaterialRequest {
   notes?: string;
 
   /**
-   * QuantityInputRequest is a quantity value and unit.
+   * A quantity, given as a decimal value and the unit it is measured in.
    */
   order_point?: QuantityInputRequest;
 
@@ -228,7 +284,7 @@ export interface Material {
 }
 
 /**
- * QuantityInputRequest is a quantity value and unit.
+ * A quantity, given as a decimal value and the unit it is measured in.
  */
 export interface QuantityInputRequest {
   /**
@@ -274,7 +330,7 @@ export interface UpdateMaterialRequest {
   description?: string;
 
   /**
-   * QuantityInputRequest is a quantity value and unit.
+   * A quantity, given as a decimal value and the unit it is measured in.
    */
   lead_time?: QuantityInputRequest;
 
@@ -284,7 +340,7 @@ export interface UpdateMaterialRequest {
   notes?: string;
 
   /**
-   * QuantityInputRequest is a quantity value and unit.
+   * A quantity, given as a decimal value and the unit it is measured in.
    */
   order_point?: QuantityInputRequest;
 
@@ -421,7 +477,7 @@ export interface MaterialCreateParams {
   description?: string;
 
   /**
-   * Body param: QuantityInputRequest is a quantity value and unit.
+   * Body param: A quantity, given as a decimal value and the unit it is measured in.
    */
   lead_time?: QuantityInputRequest;
 
@@ -431,7 +487,7 @@ export interface MaterialCreateParams {
   notes?: string;
 
   /**
-   * Body param: QuantityInputRequest is a quantity value and unit.
+   * Body param: A quantity, given as a decimal value and the unit it is measured in.
    */
   order_point?: QuantityInputRequest;
 
@@ -470,7 +526,7 @@ export interface MaterialUpdateParams {
   description?: string;
 
   /**
-   * Body param: QuantityInputRequest is a quantity value and unit.
+   * Body param: A quantity, given as a decimal value and the unit it is measured in.
    */
   lead_time?: QuantityInputRequest;
 
@@ -480,7 +536,7 @@ export interface MaterialUpdateParams {
   notes?: string;
 
   /**
-   * Body param: QuantityInputRequest is a quantity value and unit.
+   * Body param: A quantity, given as a decimal value and the unit it is measured in.
    */
   order_point?: QuantityInputRequest;
 

package/src/resources/catalog/parts.ts

@@ -15,6 +15,9 @@ export class Parts extends APIResource {
   /**
    * Returns a paginated list of parts for the current account.
    *
+   * This endpoint requires the permissions: `parts:read`, `customers:read`,
+   * `suppliers:read`.
+   *
    * @example
    * ```ts
    * const listPart = await client.catalog.parts.list();
@@ -27,6 +30,9 @@ export class Parts extends APIResource {
   /**
    * Returns a part by ID.
    *
+   * This endpoint requires the permissions: `parts:read`, `customers:read`,
+   * `suppliers:read`.
+   *
    * @example
    * ```ts
    * const part = await client.catalog.parts.retrieve(
@@ -48,12 +54,28 @@ export class Parts extends APIResource {
    * Inventory tracking for the new part starts at a zero on-hand quantity in the
    * category's base unit.
    *
+   * This endpoint requires the permissions: `parts:create`, `customers:update`,
+   * `suppliers:update`.
+   *
    * @example
    * ```ts
    * const part = await client.catalog.parts.create({
    *   category_id: 'ic_01ae7bd7bfd21ca0ab81e1357e',
    *   sku: 'BRG-6204-2RS',
+   *   attribute_ids: ['at_01c9493ec0c46bb0ed12708ae4'],
    *   description: 'Deep groove ball bearing, 20x47x14mm',
+   *   notes:
+   *     'OEM-equivalent; verify shielding type before substitution.',
+   *   unit_cost: {
+   *     value: '9.40',
+   *     numerator_unit_id: 'un_01966263f74a5a0cae356000a1',
+   *     denominator_unit_id: 'un_01966263f74a5a0cae356000a1',
+   *   },
+   *   unit_price: {
+   *     value: '14.99',
+   *     numerator_unit_id: 'un_01966263f74a5a0cae356000a1',
+   *     denominator_unit_id: 'un_01966263f74a5a0cae356000a1',
+   *   },
    * });
    * ```
    */
@@ -67,12 +89,17 @@ export class Parts extends APIResource {
    *
    * Fields not provided retain their current values.
    *
+   * This endpoint requires the permissions: `parts:update`, `customers:update`,
+   * `suppliers:update`.
+   *
    * @example
    * ```ts
    * const part = await client.catalog.parts.update(
    *   'pt_018d7bab53e864351f4c693a21',
    *   {
    *     description: 'Deep groove ball bearing, 20x47x14mm',
+   *     notes:
+   *       'Superseded by low-friction variant; keep for legacy assemblies.',
    *     sku: 'BRG-6204-2RS',
    *   },
    * );
@@ -94,6 +121,9 @@ export class Parts extends APIResource {
    * other endpoints, but the record is retained. Deleting an already-deleted part
    * returns an error.
    *
+   * This endpoint requires the permissions: `parts:delete`, `customers:update`,
+   * `suppliers:update`.
+   *
    * @example
    * ```ts
    * const part = await client.catalog.parts.delete(

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

@@ -15,6 +15,9 @@ export class ProductLines extends APIResource {
    * Returns a paginated list of product lines, including account-owned and system
    * product lines.
    *
+   * This endpoint requires the permissions: `product_lines:read`, `customers:read`,
+   * `suppliers:read`.
+   *
    * @example
    * ```ts
    * const listProductLine =
@@ -32,6 +35,9 @@ export class ProductLines extends APIResource {
    * Returns a product line by ID, including system-owned product lines accessible to
    * the account.
    *
+   * This endpoint requires the permissions: `product_lines:read`, `customers:read`,
+   * `suppliers:read`.
+   *
    * @example
    * ```ts
    * const productLine =
@@ -51,6 +57,8 @@ export class ProductLines extends APIResource {
   /**
    * Creates an account-owned product line.
    *
+   * This endpoint requires the permission: `product_lines:create`.
+   *
    * @example
    * ```ts
    * const productLine =
@@ -73,12 +81,19 @@ export class ProductLines extends APIResource {
    * Only the provided fields are changed. The reserved default product lines
    * (shipping, service, credit, tax) cannot be updated.
    *
+   * This endpoint requires the permission: `product_lines:update`.
+   *
    * @example
    * ```ts
    * const productLine =
    *   await client.catalog.productLines.update(
    *     'pl_01996357326a0d3f7b129542ea',
-   *     { name: 'Updated Product Line' },
+   *     {
+   *       commission_policy: 'commission_applied',
+   *       freight_policy: 'billed_freight',
+   *       name: 'Updated Product Line',
+   *       unit_group_id: 'ug_01aad07abb8e41fd392d2d7013',
+   *     },
    *   );
    * ```
    */
@@ -101,6 +116,8 @@ export class ProductLines extends APIResource {
    * The reserved default product lines (shipping, service, credit, tax) cannot be
    * deleted.
    *
+   * This endpoint requires the permission: `product_lines:delete`.
+   *
    * @example
    * ```ts
    * const productLine =

package/src/resources/catalog/products.ts

@@ -16,6 +16,9 @@ export class Products extends APIResource {
   /**
    * Returns a paginated list of products for the target account.
    *
+   * This endpoint requires the permissions: `items:read`, `customers:read`,
+   * `suppliers:read`.
+   *
    * @example
    * ```ts
    * const listProduct = await client.catalog.products.list();
@@ -28,6 +31,9 @@ export class Products extends APIResource {
   /**
    * Returns a product by ID.
    *
+   * This endpoint requires the permissions: `items:read`, `customers:read`,
+   * `suppliers:read`.
+   *
    * @example
    * ```ts
    * const product = await client.catalog.products.retrieve(
@@ -50,12 +56,31 @@ export class Products extends APIResource {
    * zero rates in the category's base unit unless `unit_price` or `unit_cost` is
    * provided.
    *
+   * This endpoint requires the permission: `items:create`.
+   *
    * @example
    * ```ts
    * const product = await client.catalog.products.create({
    *   category_id: 'ic_01ae7bd7bfd21ca0ab81e1357e',
    *   sku: 'ALM-2024-1001',
    *   type: 'sale',
+   *   attribute_ids: ['at_01c9493ec0c46bb0ed12708ae4'],
+   *   description:
+   *     'Wireless barcode scanner with charging cradle',
+   *   notes:
+   *     'Ships with a 2-year warranty; register for extended coverage.',
+   *   portal_visibility: 'visible',
+   *   product_line_id: 'pl_01996357326a0d3f7b129542ea',
+   *   unit_cost: {
+   *     value: '112.00',
+   *     numerator_unit_id: 'un_01966263f74a5a0cae356000a1',
+   *     denominator_unit_id: 'un_01966263f74a5a0cae356000a1',
+   *   },
+   *   unit_price: {
+   *     value: '199.00',
+   *     numerator_unit_id: 'un_01966263f74a5a0cae356000a1',
+   *     denominator_unit_id: 'un_01966263f74a5a0cae356000a1',
+   *   },
    * });
    * ```
    */
@@ -67,11 +92,25 @@ export class Products extends APIResource {
   /**
    * Partially updates a product.
    *
+   * This endpoint requires the permission: `items:update`.
+   *
    * @example
    * ```ts
    * const product = await client.catalog.products.update(
    *   'pd_013c29ab3f1518d0004094c316',
-   *   { sku: 'SKU-002' },
+   *   {
+   *     description:
+   *       'Wireless barcode scanner with charging cradle (v2)',
+   *     notes:
+   *       'Firmware 2.1 improves Bluetooth pairing reliability.',
+   *     portal_visibility: 'visible',
+   *     sku: 'SKU-002',
+   *     unit_price: {
+   *       value: '219.00',
+   *       numerator_unit_id: 'un_01966263f74a5a0cae356000a1',
+   *       denominator_unit_id: 'un_01966263f74a5a0cae356000a1',
+   *     },
+   *   },
    * );
    * ```
    */
@@ -87,6 +126,8 @@ export class Products extends APIResource {
   /**
    * Soft-deletes a product and returns the deleted product.
    *
+   * This endpoint requires the permission: `items:delete`.
+   *
    * @example
    * ```ts
    * const product = await client.catalog.products.delete(
@@ -106,6 +147,8 @@ export class Products extends APIResource {
   /**
    * Changes the product line assignment for a product.
    *
+   * This endpoint requires the permission: `items:update`.
+   *
    * @example
    * ```ts
    * const product =
@@ -167,12 +210,12 @@ export interface CreateProductRequest {
   attribute_ids?: Array<string>;
 
   /**
-   * Description.
+   * Free-form description of the product.
    */
   description?: string;
 
   /**
-   * Notes.
+   * Free-form notes about the product.
    */
   notes?: string;
 
@@ -292,14 +335,14 @@ export interface Product {
  */
 export interface UpdateProductRequest {
   /**
-   * Description.
+   * Free-form description of the product.
    *
    * Send `null` to clear.
    */
   description?: string | null;
 
   /**
-   * Notes.
+   * Free-form notes about the product.
    *
    * Send `null` to clear.
    */
@@ -494,12 +537,12 @@ export interface ProductCreateParams {
   attribute_ids?: Array<string>;
 
   /**
-   * Body param: Description.
+   * Body param: Free-form description of the product.
    */
   description?: string;
 
   /**
-   * Body param: Notes.
+   * Body param: Free-form notes about the product.
    */
   notes?: string;
 
@@ -558,14 +601,14 @@ export interface ProductUpdateParams {
   >;
 
   /**
-   * Body param: Description.
+   * Body param: Free-form description of the product.
    *
    * Send `null` to clear.
    */
   description?: string | null;
 
   /**
-   * Body param: Notes.
+   * Body param: Free-form notes about the product.
    *
    * Send `null` to clear.
    */

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

@@ -13,6 +13,8 @@ export class Attributes extends APIResource {
   /**
    * Returns a paginated list of attributes for a property.
    *
+   * This endpoint requires the permission: `properties:read`.
+   *
    * @example
    * ```ts
    * const listAttribute =
@@ -32,6 +34,8 @@ export class Attributes extends APIResource {
   /**
    * Returns an attribute by ID within a property.
    *
+   * This endpoint requires the permission: `properties:read`.
+   *
    * @example
    * ```ts
    * const attribute =
@@ -53,6 +57,8 @@ export class Attributes extends APIResource {
   /**
    * Creates an attribute under a property.
    *
+   * This endpoint requires the permission: `properties:create`.
+   *
    * @example
    * ```ts
    * const attribute =
@@ -77,6 +83,8 @@ export class Attributes extends APIResource {
   /**
    * Partially updates an attribute.
    *
+   * This endpoint requires the permission: `properties:update`.
+   *
    * @example
    * ```ts
    * const attribute =
@@ -84,6 +92,8 @@ export class Attributes extends APIResource {
    *     'at_01c9493ec0c46bb0ed12708ae4',
    *     {
    *       property_id: 'pp_01e21344878064372f69e67093',
+   *       color: 'blue',
+   *       sort_order: 2,
    *       value: 'Blue',
    *     },
    *   );
@@ -107,6 +117,8 @@ export class Attributes extends APIResource {
    * Remaining attributes in the property are shifted so their sort orders stay
    * contiguous.
    *
+   * This endpoint requires the permission: `properties:delete`.
+   *
    * @example
    * ```ts
    * const attribute =

package/src/resources/catalog/properties/properties.ts

@@ -27,6 +27,8 @@ export class Properties extends APIResource {
   /**
    * Returns a paginated list of properties for the target account.
    *
+   * This endpoint requires the permission: `properties:read`.
+   *
    * @example
    * ```ts
    * const listProperty = await client.catalog.properties.list();
@@ -42,6 +44,8 @@ export class Properties extends APIResource {
   /**
    * Returns a property by ID.
    *
+   * This endpoint requires the permission: `properties:read`.
+   *
    * @example
    * ```ts
    * const property = await client.catalog.properties.retrieve(
@@ -60,6 +64,8 @@ export class Properties extends APIResource {
   /**
    * Creates a property.
    *
+   * This endpoint requires the permission: `properties:create`.
+   *
    * @example
    * ```ts
    * const property = await client.catalog.properties.create({
@@ -75,6 +81,8 @@ export class Properties extends APIResource {
   /**
    * Partially updates a property.
    *
+   * This endpoint requires the permission: `properties:update`.
+   *
    * @example
    * ```ts
    * const property = await client.catalog.properties.update(
@@ -95,6 +103,8 @@ export class Properties extends APIResource {
   /**
    * Deletes a property and all associated attributes.
    *
+   * This endpoint requires the permission: `properties:delete`.
+   *
    * @example
    * ```ts
    * const property = await client.catalog.properties.delete(