@augno/sdk 0.1.9 → 0.7.1

package/resources/catalog/items/items.js

@@ -15,9 +15,24 @@ class Items extends resource_1.APIResource {
         super(...arguments);
         this.attributes = new AttributesAPI.Attributes(this._client);
     }
+    /**
+     * Returns a paginated list of items.
+     *
+     * This endpoint requires the permission: `items:read`.
+     *
+     * @example
+     * ```ts
+     * const listItem = await client.catalog.items.list();
+     * ```
+     */
+    list(query = {}, options) {
+        return this._client.get('/v1/catalog/items', { query, ...options });
+    }
     /**
      * Returns an item by ID.
      *
+     * This endpoint requires the permission: `items:read`.
+     *
      * @example
      * ```ts
      * const item = await client.catalog.items.retrieve(
@@ -29,19 +44,30 @@ class Items extends resource_1.APIResource {
         return this._client.get((0, path_1.path) `/v1/catalog/items/${id}`, { query, ...options });
     }
     /**
-     * Returns a paginated list of items.
+     * 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 listItem = await client.catalog.items.list();
+     * const itemInventory =
+     *   await client.catalog.items.retrieveInventory(
+     *     'it_0131e386ac683e8c29a71f6f1f',
+     *   );
      * ```
      */
-    list(query = {}, options) {
-        return this._client.get('/v1/catalog/items', { query, ...options });
+    retrieveInventory(id, query = {}, options) {
+        return this._client.get((0, path_1.path) `/v1/catalog/items/${id}/inventory`, { 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.
+     * Moves an item to a different category.
+     *
+     * The item's rate units (unit value, unit cost, burn rate) and any related
+     * 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
@@ -58,21 +84,6 @@ class Items extends resource_1.APIResource {
             ...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, query = {}, options) {
-        return this._client.get((0, path_1.path) `/v1/catalog/items/${id}/inventory`, { query, ...options });
-    }
 }
 exports.Items = Items;
 Items.Attributes = attributes_1.Attributes;

package/resources/catalog/items/items.js.map

@@ -1 +1 @@
-{"version":3,"file":"items.js","sourceRoot":"","sources":["../../../src/resources/catalog/items/items.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,wDAAqD;AAGrD,uEAA8C;AAC9C,gDAAwF;AAKxF,0DAAoD;AAEpD;;GAEG;AACH,MAAa,KAAM,SAAQ,sBAAW;IAAtC;;QACE,eAAU,GAA6B,IAAI,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA2EpF,CAAC;IAzEC;;;;;;;;;OASG;IACH,QAAQ,CACN,EAAU,EACV,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,qBAAqB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CAAC,QAA2C,EAAE,EAAE,OAAwB;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,UAAkB,EAClB,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,qBAAqB,EAAE,aAAa,UAAU,EAAE,EAAE;YAC5E,KAAK,EAAE,EAAE,OAAO,EAAE;YAClB,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,iBAAiB,CACf,EAAU,EACV,QAAwD,EAAE,EAC1D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,qBAAqB,EAAE,YAAY,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;CACF;AA5ED,sBA4EC;AAgYD,KAAK,CAAC,UAAU,GAAG,uBAAU,CAAC"}
+{"version":3,"file":"items.js","sourceRoot":"","sources":["../../../src/resources/catalog/items/items.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,wDAAqD;AAGrD,uEAA8C;AAC9C,gDAAwF;AAKxF,0DAAoD;AAEpD;;GAEG;AACH,MAAa,KAAM,SAAQ,sBAAW;IAAtC;;QACE,eAAU,GAA6B,IAAI,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAsFpF,CAAC;IApFC;;;;;;;;;OASG;IACH,IAAI,CAAC,QAA2C,EAAE,EAAE,OAAwB;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,EAAU,EACV,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,qBAAqB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,iBAAiB,CACf,EAAU,EACV,QAAwD,EAAE,EAC1D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,qBAAqB,EAAE,YAAY,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,cAAc,CACZ,UAAkB,EAClB,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,qBAAqB,EAAE,aAAa,UAAU,EAAE,EAAE;YAC5E,KAAK,EAAE,EAAE,OAAO,EAAE;YAClB,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAvFD,sBAuFC;AAiaD,KAAK,CAAC,UAAU,GAAG,uBAAU,CAAC"}

package/resources/catalog/items/items.mjs

@@ -11,9 +11,24 @@ export class Items extends APIResource {
         super(...arguments);
         this.attributes = new AttributesAPI.Attributes(this._client);
     }
+    /**
+     * Returns a paginated list of items.
+     *
+     * This endpoint requires the permission: `items:read`.
+     *
+     * @example
+     * ```ts
+     * const listItem = await client.catalog.items.list();
+     * ```
+     */
+    list(query = {}, options) {
+        return this._client.get('/v1/catalog/items', { query, ...options });
+    }
     /**
      * Returns an item by ID.
      *
+     * This endpoint requires the permission: `items:read`.
+     *
      * @example
      * ```ts
      * const item = await client.catalog.items.retrieve(
@@ -25,19 +40,30 @@ export class Items extends APIResource {
         return this._client.get(path `/v1/catalog/items/${id}`, { query, ...options });
     }
     /**
-     * Returns a paginated list of items.
+     * 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 listItem = await client.catalog.items.list();
+     * const itemInventory =
+     *   await client.catalog.items.retrieveInventory(
+     *     'it_0131e386ac683e8c29a71f6f1f',
+     *   );
      * ```
      */
-    list(query = {}, options) {
-        return this._client.get('/v1/catalog/items', { query, ...options });
+    retrieveInventory(id, query = {}, options) {
+        return this._client.get(path `/v1/catalog/items/${id}/inventory`, { 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.
+     * Moves an item to a different category.
+     *
+     * The item's rate units (unit value, unit cost, burn rate) and any related
+     * 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
@@ -54,21 +80,6 @@ export class Items extends APIResource {
             ...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, query = {}, options) {
-        return this._client.get(path `/v1/catalog/items/${id}/inventory`, { query, ...options });
-    }
 }
 Items.Attributes = Attributes;
 //# sourceMappingURL=items.mjs.map

package/resources/catalog/items/items.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"items.mjs","sourceRoot":"","sources":["../../../src/resources/catalog/items/items.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,mCAA+B;AAGrD,OAAO,KAAK,aAAa,yBAAqB;AAC9C,OAAO,EAAgD,UAAU,EAAE,yBAAqB;AAKxF,OAAO,EAAE,IAAI,EAAE,yCAAqC;AAEpD;;GAEG;AACH,MAAM,OAAO,KAAM,SAAQ,WAAW;IAAtC;;QACE,eAAU,GAA6B,IAAI,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA2EpF,CAAC;IAzEC;;;;;;;;;OASG;IACH,QAAQ,CACN,EAAU,EACV,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,qBAAqB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CAAC,QAA2C,EAAE,EAAE,OAAwB;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,UAAkB,EAClB,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,qBAAqB,EAAE,aAAa,UAAU,EAAE,EAAE;YAC5E,KAAK,EAAE,EAAE,OAAO,EAAE;YAClB,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,iBAAiB,CACf,EAAU,EACV,QAAwD,EAAE,EAC1D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,qBAAqB,EAAE,YAAY,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;CACF;AAgYD,KAAK,CAAC,UAAU,GAAG,UAAU,CAAC"}
+{"version":3,"file":"items.mjs","sourceRoot":"","sources":["../../../src/resources/catalog/items/items.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,KAAK,aAAa;OAClB,EAAgD,UAAU,EAAE;OAK5D,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,KAAM,SAAQ,WAAW;IAAtC;;QACE,eAAU,GAA6B,IAAI,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAsFpF,CAAC;IApFC;;;;;;;;;OASG;IACH,IAAI,CAAC,QAA2C,EAAE,EAAE,OAAwB;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,EAAU,EACV,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,qBAAqB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,iBAAiB,CACf,EAAU,EACV,QAAwD,EAAE,EAC1D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,qBAAqB,EAAE,YAAY,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,cAAc,CACZ,UAAkB,EAClB,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,qBAAqB,EAAE,aAAa,UAAU,EAAE,EAAE;YAC5E,KAAK,EAAE,EAAE,OAAO,EAAE;YAClB,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAiaD,KAAK,CAAC,UAAU,GAAG,UAAU,CAAC"}

package/resources/catalog/items.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"items.d.mts","sourceRoot":"","sources":["../../src/resources/catalog/items.ts"],"names":[],"mappings":"AAEA,kCAA8B"}
+{"version":3,"file":"items.d.mts","sourceRoot":"","sources":["../../src/resources/catalog/items.ts"],"names":[],"mappings":""}

package/resources/catalog/items.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"items.d.ts","sourceRoot":"","sources":["../../src/resources/catalog/items.ts"],"names":[],"mappings":"AAEA,iCAA8B"}
+{"version":3,"file":"items.d.ts","sourceRoot":"","sources":["../../src/resources/catalog/items.ts"],"names":[],"mappings":""}

package/resources/catalog/items.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"items.mjs","sourceRoot":"","sources":["../../src/resources/catalog/items.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,kCAA8B"}
+{"version":3,"file":"items.mjs","sourceRoot":"","sources":["../../src/resources/catalog/items.ts"],"names":[],"mappings":"AAAA,sFAAsF"}

package/resources/catalog/materials.d.mts

@@ -8,20 +8,23 @@ import { RequestOptions } from "../../internal/request-options.mjs";
  */
 export declare class Materials extends APIResource {
     /**
-     * Creates a material.
+     * Returns a paginated list of materials.
+     *
+     * This endpoint requires the permissions: `materials:read`, `customers:read`,
+     * `suppliers:read`.
      *
      * @example
      * ```ts
-     * const material = await client.catalog.materials.create({
-     *   category_id: 'ic_01ae7bd7bfd21ca0ab81e1357e',
-     *   sku: 'MAT-001',
-     * });
+     * const listMaterial = await client.catalog.materials.list();
      * ```
      */
-    create(params: MaterialCreateParams, options?: RequestOptions): APIPromise<Material>;
+    list(query?: MaterialListParams | null | undefined, options?: RequestOptions): APIPromise<ListMaterial>;
     /**
      * 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(
@@ -31,27 +34,49 @@ export declare class Materials extends APIResource {
      */
     retrieve(id: string, query?: MaterialRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<Material>;
     /**
-     * Partially updates a material.
+     * Creates a material with the specified SKU and category.
+     *
+     * 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.update(
-     *   'ml_014613b8f7959a091d8cc0cef4',
-     * );
+     * const material = await client.catalog.materials.create({
+     *   category_id: 'ic_01ae7bd7bfd21ca0ab81e1357e',
+     *   sku: 'MAT-001',
+     * });
      * ```
      */
-    update(id: string, params?: MaterialUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Material>;
+    create(params: MaterialCreateParams, options?: RequestOptions): APIPromise<Material>;
     /**
-     * Returns a paginated list of materials.
+     * Partially updates a material.
+     *
+     * Fields not provided retain their current values.
+     *
+     * This endpoint requires the permissions: `materials:update`, `customers:update`,
+     * `suppliers:update`.
      *
      * @example
      * ```ts
-     * const listMaterial = await client.catalog.materials.list();
+     * const material = await client.catalog.materials.update(
+     *   'ml_014613b8f7959a091d8cc0cef4',
+     *   { sku: 'MAT-001-UPDATED' },
+     * );
      * ```
      */
-    list(query?: MaterialListParams | null | undefined, options?: RequestOptions): APIPromise<ListMaterial>;
+    update(id: string, params?: MaterialUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Material>;
     /**
-     * Deletes a material by ID.
+     * Deletes a material.
+     *
+     * This is a soft delete: the material is marked deleted and no longer returned by
+     * 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
@@ -67,39 +92,47 @@ export declare class Materials extends APIResource {
  */
 export interface CreateMaterialRequest {
     /**
-     * Category ID.
+     * ID of the item category to place the material in.
+     *
+     * The category's unit group determines the base unit used for the material's rates
+     * (`unit_value`, `unit_cost`, `burn_rate`).
      */
     category_id: string;
     /**
-     * SKU code.
+     * Stock keeping unit code for the material.
+     *
+     * Must be unique within the account; creating a material with a SKU already used
+     * by another item fails with a conflict error.
      */
     sku: string;
     /**
-     * Attribute IDs to connect to the material at creation time.
+     * IDs of existing attributes to link to the material at creation time.
      */
     attribute_ids?: Array<string>;
     /**
-     * Description.
+     * Free-form description of the material.
      */
     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;
     /**
-     * Notes.
+     * Free-form notes about the material.
      */
     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;
     /**
-     * RateInput represents the input for creating or updating a rate.
+     * A rate value with its numerator and denominator units, used in create and update
+     * requests.
      */
     unit_cost?: RateInput;
     /**
-     * RateInput represents the input for creating or updating a rate.
+     * A rate value with its numerator and denominator units, used in create and update
+     * requests.
      */
     unit_price?: RateInput;
 }
@@ -121,7 +154,12 @@ export interface ListMaterial {
     page_info: APIKeysAPI.PageInfo;
 }
 /**
- * Material with order point and lead time.
+ * A material in the account's catalog: a raw material or component consumed in
+ * production.
+ *
+ * Material-level data such as the SKU, description, category, pricing, and
+ * attributes lives on the underlying `item`; the material record adds the
+ * reordering fields `order_point` and `lead_time`.
  */
 export interface Material {
     /**
@@ -154,32 +192,34 @@ export interface Material {
     updated_at: string;
 }
 /**
- * QuantityInputRequest is a quantity value and unit.
+ * A quantity, given as a decimal value and the unit it is measured in.
  */
 export interface QuantityInputRequest {
     /**
-     * Unit ID.
+     * ID of the unit the value is expressed in.
      */
     unit_id: string;
     /**
-     * Quantity value.
+     * Decimal value of the quantity.
      */
     value: string;
 }
 /**
- * RateInput represents the input for creating or updating a rate.
+ * A rate value with its numerator and denominator units, used in create and update
+ * requests.
  */
 export interface RateInput {
     /**
-     * Denominator unit ID.
+     * ID of the unit for the rate's denominator (the per-unit basis).
      */
     denominator_unit_id: string;
     /**
-     * Numerator unit ID.
+     * ID of the unit for the rate's numerator (e.g. the currency of a price).
      */
     numerator_unit_id: string;
     /**
-     * Decimal value of the rate.
+     * Decimal value of the rate, expressed as the amount of the numerator unit per one
+     * denominator unit.
      */
     value: string;
 }
@@ -188,72 +228,74 @@ export interface RateInput {
  */
 export interface UpdateMaterialRequest {
     /**
-     * Description.
+     * New description for the material.
      */
     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;
     /**
-     * Notes.
+     * New notes for the material.
      */
     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;
     /**
-     * SKU code.
+     * New stock keeping unit code for the material.
+     *
+     * Must remain unique within the account; a conflict error is returned if another
+     * item already uses it.
      */
     sku?: string;
     /**
-     * RateInput represents the input for creating or updating a rate.
+     * A rate value with its numerator and denominator units, used in create and update
+     * requests.
      */
     unit_cost?: RateInput;
 }
-export interface MaterialCreateParams {
-    /**
-     * Body param: Category ID.
-     */
-    category_id: string;
-    /**
-     * Body param: SKU code.
-     */
-    sku: string;
+export interface MaterialListParams {
     /**
-     * Query param: Sub-objects to expand in the response. When omitted, sub-objects
-     * are returned as `null`.
+     * Filter by attribute IDs.
      */
-    include?: Array<'item' | 'item.category' | 'item.category.properties' | 'item.category.unit_group' | 'item.unit_value' | 'item.unit_cost' | 'item.burn_rate' | 'item.attributes'>;
+    attribute_ids?: Array<string>;
     /**
-     * Body param: Attribute IDs to connect to the material at creation time.
+     * Filter by category IDs.
      */
-    attribute_ids?: Array<string>;
+    category_ids?: Array<string>;
     /**
-     * Body param: Description.
+     * 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.
      */
-    description?: string;
+    cursor?: string;
     /**
-     * Body param: QuantityInputRequest is a quantity value and unit.
+     * Filter to materials created on or before this date.
      */
-    lead_time?: QuantityInputRequest;
+    end_date?: string;
     /**
-     * Body param: Notes.
+     * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+     * `null`.
      */
-    notes?: string;
+    include?: Array<'item' | 'item.category' | 'item.category.properties' | 'item.category.unit_group' | 'item.unit_value' | 'item.unit_cost' | 'item.burn_rate' | 'item.attributes'>;
     /**
-     * Body param: QuantityInputRequest is a quantity value and unit.
+     * Maximum number of results to return in a single page.
      */
-    order_point?: QuantityInputRequest;
+    limit?: number;
     /**
-     * Body param: RateInput represents the input for creating or updating a rate.
+     * Free-text search term used to filter results.
+     *
+     * Which fields are matched against the term varies by endpoint.
      */
-    unit_cost?: RateInput;
+    q?: string;
     /**
-     * Body param: RateInput represents the input for creating or updating a rate.
+     * Filter to materials created on or after this date.
      */
-    unit_price?: RateInput;
+    start_date?: string;
 }
 export interface MaterialRetrieveParams {
     /**
@@ -262,73 +304,93 @@ export interface MaterialRetrieveParams {
      */
     include?: Array<'item' | 'item.category' | 'item.category.properties' | 'item.category.unit_group' | 'item.unit_value' | 'item.unit_cost' | 'item.burn_rate' | 'item.attributes'>;
 }
-export interface MaterialUpdateParams {
+export interface MaterialCreateParams {
+    /**
+     * Body param: ID of the item category to place the material in.
+     *
+     * The category's unit group determines the base unit used for the material's rates
+     * (`unit_value`, `unit_cost`, `burn_rate`).
+     */
+    category_id: string;
+    /**
+     * Body param: Stock keeping unit code for the material.
+     *
+     * Must be unique within the account; creating a material with a SKU already used
+     * by another item fails with a conflict error.
+     */
+    sku: string;
     /**
      * Query param: Sub-objects to expand in the response. When omitted, sub-objects
      * are returned as `null`.
      */
     include?: Array<'item' | 'item.category' | 'item.category.properties' | 'item.category.unit_group' | 'item.unit_value' | 'item.unit_cost' | 'item.burn_rate' | 'item.attributes'>;
     /**
-     * Body param: Description.
+     * Body param: IDs of existing attributes to link to the material at creation time.
+     */
+    attribute_ids?: Array<string>;
+    /**
+     * Body param: Free-form description of the material.
      */
     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;
     /**
-     * Body param: Notes.
+     * Body param: Free-form notes about the material.
      */
     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;
     /**
-     * Body param: SKU code.
-     */
-    sku?: string;
-    /**
-     * Body param: RateInput represents the input for creating or updating a rate.
+     * Body param: A rate value with its numerator and denominator units, used in
+     * create and update requests.
      */
     unit_cost?: RateInput;
-}
-export interface MaterialListParams {
     /**
-     * Filter by attribute IDs.
+     * Body param: A rate value with its numerator and denominator units, used in
+     * create and update requests.
      */
-    attribute_ids?: Array<string>;
+    unit_price?: RateInput;
+}
+export interface MaterialUpdateParams {
     /**
-     * Filter by category IDs.
+     * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+     * are returned as `null`.
      */
-    category_ids?: Array<string>;
+    include?: Array<'item' | 'item.category' | 'item.category.properties' | 'item.category.unit_group' | 'item.unit_value' | 'item.unit_cost' | 'item.burn_rate' | 'item.attributes'>;
     /**
-     * Cursor token used to retrieve the next or previous page of results.
+     * Body param: New description for the material.
      */
-    cursor?: string;
+    description?: string;
     /**
-     * Filter to materials created on or before this date.
+     * Body param: A quantity, given as a decimal value and the unit it is measured in.
      */
-    end_date?: string;
+    lead_time?: QuantityInputRequest;
     /**
-     * Sub-objects to expand in the response. When omitted, sub-objects are returned as
-     * `null`.
+     * Body param: New notes for the material.
      */
-    include?: Array<'item' | 'item.category' | 'item.category.properties' | 'item.category.unit_group' | 'item.unit_value' | 'item.unit_cost' | 'item.burn_rate' | 'item.attributes'>;
+    notes?: string;
     /**
-     * Maximum number of results per page (default: 100, max: 1000).
+     * Body param: A quantity, given as a decimal value and the unit it is measured in.
      */
-    limit?: number;
+    order_point?: QuantityInputRequest;
     /**
-     * Search query used to filter results.
+     * Body param: New stock keeping unit code for the material.
+     *
+     * Must remain unique within the account; a conflict error is returned if another
+     * item already uses it.
      */
-    q?: string;
+    sku?: string;
     /**
-     * Filter to materials created on or after this date.
+     * Body param: A rate value with its numerator and denominator units, used in
+     * create and update requests.
      */
-    start_date?: string;
+    unit_cost?: RateInput;
 }
 export declare namespace Materials {
-    export { type CreateMaterialRequest as CreateMaterialRequest, type ListMaterial as ListMaterial, type Material as Material, type QuantityInputRequest as QuantityInputRequest, type RateInput as RateInput, type UpdateMaterialRequest as UpdateMaterialRequest, type MaterialCreateParams as MaterialCreateParams, type MaterialRetrieveParams as MaterialRetrieveParams, type MaterialUpdateParams as MaterialUpdateParams, type MaterialListParams as MaterialListParams, };
+    export { type CreateMaterialRequest as CreateMaterialRequest, type ListMaterial as ListMaterial, type Material as Material, type QuantityInputRequest as QuantityInputRequest, type RateInput as RateInput, type UpdateMaterialRequest as UpdateMaterialRequest, type MaterialListParams as MaterialListParams, type MaterialRetrieveParams as MaterialRetrieveParams, type MaterialCreateParams as MaterialCreateParams, type MaterialUpdateParams as MaterialUpdateParams, };
 }
 //# sourceMappingURL=materials.d.mts.map