@augno/sdk 0.13.4 → 0.14.0

package/resources/catalog/materials/materials.d.ts

@@ -0,0 +1,483 @@
+import { APIResource } from "../../../core/resource.js";
+import * as APIKeysAPI from "../../auth/api-keys/api-keys.js";
+import * as ItemsAPI from "../items/items.js";
+import * as ActionsAPI from "./actions.js";
+import { ActionBulkUpsertParams, Actions, BulkUpsertMaterialsRequest, UpsertMaterialInput, UpsertMaterialProperty } from "./actions.js";
+import { APIPromise } from "../../../core/api-promise.js";
+import { RequestOptions } from "../../../internal/request-options.js";
+/**
+ * List and manage materials.
+ */
+export declare class Materials extends APIResource {
+    actions: ActionsAPI.Actions;
+    /**
+     * Returns a paginated list of materials, newest first.
+     *
+     * `q` matches against SKU and description, with closer SKU matches ranked first.
+     *
+     * This endpoint requires the permissions: `materials:read`, `customers:read`,
+     * `suppliers:read`.
+     *
+     * @example
+     * ```ts
+     * const listMaterial = await client.catalog.materials.list();
+     * ```
+     */
+    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(
+     *   'ml_ow202v78slbl',
+     * );
+     * ```
+     */
+    retrieve(id: string, query?: MaterialRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<Material>;
+    /**
+     * Creates a material together with the catalog item that carries its SKU,
+     * description, category, pricing, and attributes.
+     *
+     * Inventory tracking for the new material starts at a zero on-hand quantity in the
+     * category's base unit. The item's consumption rate (`burn_rate`) also starts at
+     * zero and cannot be supplied here — it is derived from recorded consumption as
+     * production happens.
+     *
+     * This endpoint requires the permissions: `materials:create`, `customers:update`,
+     * `suppliers:update`.
+     *
+     * @example
+     * ```ts
+     * const material = await client.catalog.materials.create({
+     *   category_id: 'ic_d06g9c6yc9ck',
+     *   sku: 'MAT-001',
+     *   attribute_ids: ['at_rf1w295jt5ia'],
+     *   description:
+     *     'Cold-rolled 304 stainless steel sheet, 1.5mm',
+     *   lead_time: { value: '7.00', unit_id: 'un_82bd37dae5po' },
+     *   notes:
+     *     'Store flat in a dry area to avoid surface oxidation.',
+     *   order_point: {
+     *     value: '100.00',
+     *     unit_id: 'un_82bd37dae5po',
+     *   },
+     *   unit_cost: {
+     *     value: '8.25',
+     *     numerator_unit_id: 'un_82bd37dae5po',
+     *     denominator_unit_id: 'un_82bd37dae5po',
+     *   },
+     *   unit_price: {
+     *     value: '12.50',
+     *     numerator_unit_id: 'un_82bd37dae5po',
+     *     denominator_unit_id: 'un_82bd37dae5po',
+     *   },
+     * });
+     * ```
+     */
+    create(params: MaterialCreateParams, options?: RequestOptions): APIPromise<Material>;
+    /**
+     * Partially updates a material.
+     *
+     * Fields not provided retain their current values. Only the cost side of pricing
+     * can be changed here; the selling price set at creation is not editable through
+     * this endpoint. Use the Change Item Category endpoint to move the material to a
+     * different category.
+     *
+     * This endpoint requires the permissions: `materials:update`, `customers:update`,
+     * `suppliers:update`.
+     *
+     * @example
+     * ```ts
+     * const material = await client.catalog.materials.update(
+     *   'ml_ow202v78slbl',
+     *   {
+     *     description:
+     *       'Cold-rolled 304 stainless steel sheet, 2.0mm',
+     *     lead_time: {
+     *       value: '10.00',
+     *       unit_id: 'un_82bd37dae5po',
+     *     },
+     *     notes: 'Reorder point raised after Q2 demand spike.',
+     *     order_point: {
+     *       value: '150.00',
+     *       unit_id: 'un_82bd37dae5po',
+     *     },
+     *     sku: 'MAT-001-UPDATED',
+     *     unit_cost: {
+     *       value: '9.10',
+     *       numerator_unit_id: 'un_82bd37dae5po',
+     *       denominator_unit_id: 'un_82bd37dae5po',
+     *     },
+     *   },
+     * );
+     * ```
+     */
+    update(id: string, params?: MaterialUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Material>;
+    /**
+     * Deletes a material.
+     *
+     * This is a soft delete: the material and the catalog item behind it stop being
+     * returned by other endpoints, but the records are retained. The response is the
+     * material as it stood immediately before deletion, and 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(
+     *   'ml_ow202v78slbl',
+     * );
+     * ```
+     */
+    delete(id: string, options?: RequestOptions): APIPromise<Material>;
+}
+/**
+ * Request to create a material.
+ */
+export interface CreateMaterialRequest {
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * IDs of existing attributes to link to the material at creation time.
+     */
+    attribute_ids?: Array<string>;
+    /**
+     * Free-form description of the material.
+     */
+    description?: string;
+    /**
+     * A quantity, given as a decimal value and the unit it is measured in.
+     */
+    lead_time?: QuantityInputRequest;
+    /**
+     * Free-form notes about the material.
+     */
+    notes?: string;
+    /**
+     * A quantity, given as a decimal value and the unit it is measured in.
+     */
+    order_point?: QuantityInputRequest;
+    /**
+     * A value expressed as a ratio of two units, supplied on create and update
+     * requests.
+     *
+     * A unit price, for example, has a currency as its numerator unit and the unit the
+     * product is bought or sold by as its denominator.
+     */
+    unit_cost?: RateInput;
+    /**
+     * A value expressed as a ratio of two units, supplied on create and update
+     * requests.
+     *
+     * A unit price, for example, has a currency as its numerator unit and the unit the
+     * product is bought or sold by as its denominator.
+     */
+    unit_price?: RateInput;
+}
+/**
+ * A single page of resources, together with the metadata needed to page through
+ * the rest of the result set.
+ */
+export interface ListMaterial {
+    /**
+     * Resources in this page.
+     */
+    data: Array<Material>;
+    /**
+     * Resource type identifier.
+     */
+    object: 'list';
+    /**
+     * PageInfo describes where the current page sits within a paginated result set and
+     * how to move to the adjacent pages.
+     *
+     * Page a list by following the URLs below rather than assembling cursors yourself.
+     * For a top-level list endpoint the URL repeats the original request's query
+     * string with only the cursor swapped, so following it preserves the same filters,
+     * search term, and page size.
+     */
+    page_info: APIKeysAPI.PageInfo;
+}
+/**
+ * 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 {
+    /**
+     * Material ID.
+     */
+    id: string;
+    /**
+     * Creation timestamp.
+     */
+    created_at: string;
+    /**
+     * An entry in your catalog: something you sell, consume, or build with.
+     */
+    item: ItemsAPI.Item | null;
+    /**
+     * A measured amount: a numeric value together with the unit it is expressed in.
+     *
+     * Quantities are shared building blocks rather than standalone records — other
+     * resources point at them to report stock levels, ordered and packed amounts,
+     * money, weights, and durations.
+     */
+    lead_time: ItemsAPI.Quantity | null;
+    /**
+     * Resource type identifier.
+     */
+    object: 'material';
+    /**
+     * A measured amount: a numeric value together with the unit it is expressed in.
+     *
+     * Quantities are shared building blocks rather than standalone records — other
+     * resources point at them to report stock levels, ordered and packed amounts,
+     * money, weights, and durations.
+     */
+    order_point: ItemsAPI.Quantity | null;
+    /**
+     * Last updated timestamp.
+     */
+    updated_at: string;
+}
+/**
+ * A quantity, given as a decimal value and the unit it is measured in.
+ */
+export interface QuantityInputRequest {
+    /**
+     * ID of the unit the value is expressed in.
+     */
+    unit_id: string;
+    /**
+     * Decimal value of the quantity.
+     */
+    value: string;
+}
+/**
+ * A value expressed as a ratio of two units, supplied on create and update
+ * requests.
+ *
+ * A unit price, for example, has a currency as its numerator unit and the unit the
+ * product is bought or sold by as its denominator.
+ */
+export interface RateInput {
+    /**
+     * ID of the unit for the rate's denominator (the per-unit basis).
+     */
+    denominator_unit_id: string;
+    /**
+     * 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, expressed as the amount of the numerator unit per one
+     * denominator unit.
+     */
+    value: string;
+}
+/**
+ * Request to update a material.
+ */
+export interface UpdateMaterialRequest {
+    /**
+     * New description for the material.
+     */
+    description?: string;
+    /**
+     * A quantity, given as a decimal value and the unit it is measured in.
+     */
+    lead_time?: QuantityInputRequest;
+    /**
+     * New notes for the material.
+     */
+    notes?: string;
+    /**
+     * A quantity, given as a decimal value and the unit it is measured in.
+     */
+    order_point?: QuantityInputRequest;
+    /**
+     * 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;
+    /**
+     * A value expressed as a ratio of two units, supplied on create and update
+     * requests.
+     *
+     * A unit price, for example, has a currency as its numerator unit and the unit the
+     * product is bought or sold by as its denominator.
+     */
+    unit_cost?: RateInput;
+}
+export interface MaterialListParams {
+    /**
+     * Filter to materials carrying any of these attributes.
+     */
+    attribute_ids?: Array<string>;
+    /**
+     * Filter to materials in any of these categories.
+     */
+    category_ids?: Array<string>;
+    /**
+     * 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.
+     */
+    cursor?: string;
+    /**
+     * Filter to materials created on or before this date.
+     */
+    ends_at?: string;
+    /**
+     * 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'>;
+    /**
+     * 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 to materials created on or after this date.
+     */
+    starts_at?: string;
+}
+export interface MaterialRetrieveParams {
+    /**
+     * 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'>;
+}
+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: 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: A quantity, given as a decimal value and the unit it is measured in.
+     */
+    lead_time?: QuantityInputRequest;
+    /**
+     * Body param: Free-form notes about the material.
+     */
+    notes?: string;
+    /**
+     * Body param: A quantity, given as a decimal value and the unit it is measured in.
+     */
+    order_point?: QuantityInputRequest;
+    /**
+     * Body param: A value expressed as a ratio of two units, supplied on create and
+     * update requests.
+     *
+     * A unit price, for example, has a currency as its numerator unit and the unit the
+     * product is bought or sold by as its denominator.
+     */
+    unit_cost?: RateInput;
+    /**
+     * Body param: A value expressed as a ratio of two units, supplied on create and
+     * update requests.
+     *
+     * A unit price, for example, has a currency as its numerator unit and the unit the
+     * product is bought or sold by as its denominator.
+     */
+    unit_price?: RateInput;
+}
+export interface MaterialUpdateParams {
+    /**
+     * 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: New description for the material.
+     */
+    description?: string;
+    /**
+     * Body param: A quantity, given as a decimal value and the unit it is measured in.
+     */
+    lead_time?: QuantityInputRequest;
+    /**
+     * Body param: New notes for the material.
+     */
+    notes?: string;
+    /**
+     * Body param: A quantity, given as a decimal value and the unit it is measured in.
+     */
+    order_point?: QuantityInputRequest;
+    /**
+     * 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.
+     */
+    sku?: string;
+    /**
+     * Body param: A value expressed as a ratio of two units, supplied on create and
+     * update requests.
+     *
+     * A unit price, for example, has a currency as its numerator unit and the unit the
+     * product is bought or sold by as its denominator.
+     */
+    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 MaterialListParams as MaterialListParams, type MaterialRetrieveParams as MaterialRetrieveParams, type MaterialCreateParams as MaterialCreateParams, type MaterialUpdateParams as MaterialUpdateParams, };
+    export { Actions as Actions, type BulkUpsertMaterialsRequest as BulkUpsertMaterialsRequest, type UpsertMaterialInput as UpsertMaterialInput, type UpsertMaterialProperty as UpsertMaterialProperty, type ActionBulkUpsertParams as ActionBulkUpsertParams, };
+}
+//# sourceMappingURL=materials.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"materials.d.ts","sourceRoot":"","sources":["../../../src/resources/catalog/materials/materials.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,KAAK,QAAQ;OACb,KAAK,UAAU;OACf,EACL,sBAAsB,EACtB,OAAO,EACP,0BAA0B,EAC1B,mBAAmB,EACnB,sBAAsB,EACvB;OACM,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,SAAU,SAAQ,WAAW;IACxC,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IAEnE;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC;IAI3B;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,QAAQ,CAAC;IAIvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACH,MAAM,CAAC,MAAM,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAKpF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,QAAQ,CAAC;IAKvB;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;CAGnE;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;;;OAKG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE9B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,CAAC,EAAE,oBAAoB,CAAC;IAEjC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,CAAC,EAAE,oBAAoB,CAAC;IAEnC;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,SAAS,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IAEtB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;;OAQG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC;IAE3B;;;;;;OAMG;IACH,SAAS,EAAE,QAAQ,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,MAAM,EAAE,UAAU,CAAC;IAEnB;;;;;;OAMG;IACH,WAAW,EAAE,QAAQ,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;;GAMG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,CAAC,EAAE,oBAAoB,CAAC;IAEjC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,CAAC,EAAE,oBAAoB,CAAC;IAEnC;;;;;OAKG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE9B;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE7B;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,MAAM,GACN,eAAe,GACf,0BAA0B,GAC1B,0BAA0B,GAC1B,iBAAiB,GACjB,gBAAgB,GAChB,gBAAgB,GAChB,iBAAiB,CACpB,CAAC;IAEF;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,MAAM,GACN,eAAe,GACf,0BAA0B,GAC1B,0BAA0B,GAC1B,iBAAiB,GACjB,gBAAgB,GAChB,gBAAgB,GAChB,iBAAiB,CACpB,CAAC;CACH;AAED,MAAM,WAAW,oBAAoB;IACnC;;;;;OAKG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,MAAM,GACN,eAAe,GACf,0BAA0B,GAC1B,0BAA0B,GAC1B,iBAAiB,GACjB,gBAAgB,GAChB,gBAAgB,GAChB,iBAAiB,CACpB,CAAC;IAEF;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE9B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,CAAC,EAAE,oBAAoB,CAAC;IAEjC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,CAAC,EAAE,oBAAoB,CAAC;IAEnC;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,SAAS,CAAC;CACxB;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,MAAM,GACN,eAAe,GACf,0BAA0B,GAC1B,0BAA0B,GAC1B,iBAAiB,GACjB,gBAAgB,GAChB,gBAAgB,GAChB,iBAAiB,CACpB,CAAC;IAEF;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,CAAC,EAAE,oBAAoB,CAAC;IAEjC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,CAAC,EAAE,oBAAoB,CAAC;IAEnC;;;;;OAKG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB;AAID,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;IAEF,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}

package/resources/catalog/materials/materials.js

@@ -0,0 +1,159 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Materials = void 0;
+const tslib_1 = require("../../../internal/tslib.js");
+const resource_1 = require("../../../core/resource.js");
+const ActionsAPI = tslib_1.__importStar(require("./actions.js"));
+const actions_1 = require("./actions.js");
+const path_1 = require("../../../internal/utils/path.js");
+/**
+ * List and manage materials.
+ */
+class Materials extends resource_1.APIResource {
+    constructor() {
+        super(...arguments);
+        this.actions = new ActionsAPI.Actions(this._client);
+    }
+    /**
+     * Returns a paginated list of materials, newest first.
+     *
+     * `q` matches against SKU and description, with closer SKU matches ranked first.
+     *
+     * This endpoint requires the permissions: `materials:read`, `customers:read`,
+     * `suppliers:read`.
+     *
+     * @example
+     * ```ts
+     * const listMaterial = await client.catalog.materials.list();
+     * ```
+     */
+    list(query = {}, options) {
+        return this._client.get('/v1/catalog/materials', { query, ...options });
+    }
+    /**
+     * 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(
+     *   'ml_ow202v78slbl',
+     * );
+     * ```
+     */
+    retrieve(id, query = {}, options) {
+        return this._client.get((0, path_1.path) `/v1/catalog/materials/${id}`, { query, ...options });
+    }
+    /**
+     * Creates a material together with the catalog item that carries its SKU,
+     * description, category, pricing, and attributes.
+     *
+     * Inventory tracking for the new material starts at a zero on-hand quantity in the
+     * category's base unit. The item's consumption rate (`burn_rate`) also starts at
+     * zero and cannot be supplied here — it is derived from recorded consumption as
+     * production happens.
+     *
+     * This endpoint requires the permissions: `materials:create`, `customers:update`,
+     * `suppliers:update`.
+     *
+     * @example
+     * ```ts
+     * const material = await client.catalog.materials.create({
+     *   category_id: 'ic_d06g9c6yc9ck',
+     *   sku: 'MAT-001',
+     *   attribute_ids: ['at_rf1w295jt5ia'],
+     *   description:
+     *     'Cold-rolled 304 stainless steel sheet, 1.5mm',
+     *   lead_time: { value: '7.00', unit_id: 'un_82bd37dae5po' },
+     *   notes:
+     *     'Store flat in a dry area to avoid surface oxidation.',
+     *   order_point: {
+     *     value: '100.00',
+     *     unit_id: 'un_82bd37dae5po',
+     *   },
+     *   unit_cost: {
+     *     value: '8.25',
+     *     numerator_unit_id: 'un_82bd37dae5po',
+     *     denominator_unit_id: 'un_82bd37dae5po',
+     *   },
+     *   unit_price: {
+     *     value: '12.50',
+     *     numerator_unit_id: 'un_82bd37dae5po',
+     *     denominator_unit_id: 'un_82bd37dae5po',
+     *   },
+     * });
+     * ```
+     */
+    create(params, options) {
+        const { include, ...body } = params;
+        return this._client.post('/v1/catalog/materials', { query: { include }, body, ...options });
+    }
+    /**
+     * Partially updates a material.
+     *
+     * Fields not provided retain their current values. Only the cost side of pricing
+     * can be changed here; the selling price set at creation is not editable through
+     * this endpoint. Use the Change Item Category endpoint to move the material to a
+     * different category.
+     *
+     * This endpoint requires the permissions: `materials:update`, `customers:update`,
+     * `suppliers:update`.
+     *
+     * @example
+     * ```ts
+     * const material = await client.catalog.materials.update(
+     *   'ml_ow202v78slbl',
+     *   {
+     *     description:
+     *       'Cold-rolled 304 stainless steel sheet, 2.0mm',
+     *     lead_time: {
+     *       value: '10.00',
+     *       unit_id: 'un_82bd37dae5po',
+     *     },
+     *     notes: 'Reorder point raised after Q2 demand spike.',
+     *     order_point: {
+     *       value: '150.00',
+     *       unit_id: 'un_82bd37dae5po',
+     *     },
+     *     sku: 'MAT-001-UPDATED',
+     *     unit_cost: {
+     *       value: '9.10',
+     *       numerator_unit_id: 'un_82bd37dae5po',
+     *       denominator_unit_id: 'un_82bd37dae5po',
+     *     },
+     *   },
+     * );
+     * ```
+     */
+    update(id, params = {}, options) {
+        const { include, ...body } = params ?? {};
+        return this._client.patch((0, path_1.path) `/v1/catalog/materials/${id}`, { query: { include }, body, ...options });
+    }
+    /**
+     * Deletes a material.
+     *
+     * This is a soft delete: the material and the catalog item behind it stop being
+     * returned by other endpoints, but the records are retained. The response is the
+     * material as it stood immediately before deletion, and 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(
+     *   'ml_ow202v78slbl',
+     * );
+     * ```
+     */
+    delete(id, options) {
+        return this._client.delete((0, path_1.path) `/v1/catalog/materials/${id}`, options);
+    }
+}
+exports.Materials = Materials;
+Materials.Actions = actions_1.Actions;
+//# sourceMappingURL=materials.js.map

package/resources/catalog/materials/materials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"materials.js","sourceRoot":"","sources":["../../../src/resources/catalog/materials/materials.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,wDAAqD;AAGrD,iEAAwC;AACxC,0CAMmB;AAGnB,0DAAoD;AAEpD;;GAEG;AACH,MAAa,SAAU,SAAQ,sBAAW;IAA1C;;QACE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA2JrE,CAAC;IAzJC;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,EAAU,EACV,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,yBAAyB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACH,MAAM,CAAC,MAA4B,EAAE,OAAwB;QAC3D,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,MAAM,CACJ,EAAU,EACV,SAAkD,EAAE,EACpD,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,yBAAyB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzG,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,yBAAyB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;CACF;AA5JD,8BA4JC;AAibD,SAAS,CAAC,OAAO,GAAG,iBAAO,CAAC"}