@augno/sdk 0.13.4 → 0.14.0

package/resources/catalog/parts/parts.d.mts

@@ -0,0 +1,362 @@
+import { APIResource } from "../../../core/resource.mjs";
+import * as APIKeysAPI from "../../auth/api-keys/api-keys.mjs";
+import * as ItemsAPI from "../items/items.mjs";
+import * as MaterialsAPI from "../materials/materials.mjs";
+import * as ActionsAPI from "./actions.mjs";
+import { ActionBulkUpsertParams, Actions, BulkUpsertPartsRequest, UpsertPartInput, UpsertPartProperty } from "./actions.mjs";
+import { APIPromise } from "../../../core/api-promise.mjs";
+import { RequestOptions } from "../../../internal/request-options.mjs";
+/**
+ * List and manage parts.
+ */
+export declare class Parts extends APIResource {
+    actions: ActionsAPI.Actions;
+    /**
+     * Returns a paginated list of parts for the current account, most recently created
+     * first.
+     *
+     * The `q` search term matches the part's SKU or description. When it is supplied,
+     * the parts whose SKU matches it most closely are returned first, ordered by
+     * creation time within each level of match.
+     *
+     * This endpoint requires the permissions: `parts:read`, `customers:read`,
+     * `suppliers:read`.
+     *
+     * @example
+     * ```ts
+     * const listPart = await client.catalog.parts.list();
+     * ```
+     */
+    list(query?: PartListParams | null | undefined, options?: RequestOptions): APIPromise<ListPart>;
+    /**
+     * 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(
+     *   'pt_coba9fgvd84c',
+     * );
+     * ```
+     */
+    retrieve(id: string, query?: PartRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<Part>;
+    /**
+     * Creates a part with the specified SKU and category.
+     *
+     * 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_d06g9c6yc9ck',
+     *   sku: 'BRG-6204-2RS',
+     *   attribute_ids: ['at_rf1w295jt5ia'],
+     *   description: 'Deep groove ball bearing, 20x47x14mm',
+     *   notes:
+     *     'OEM-equivalent; verify shielding type before substitution.',
+     *   unit_cost: {
+     *     value: '9.40',
+     *     numerator_unit_id: 'un_82bd37dae5po',
+     *     denominator_unit_id: 'un_82bd37dae5po',
+     *   },
+     *   unit_price: {
+     *     value: '14.99',
+     *     numerator_unit_id: 'un_82bd37dae5po',
+     *     denominator_unit_id: 'un_82bd37dae5po',
+     *   },
+     * });
+     * ```
+     */
+    create(params: PartCreateParams, options?: RequestOptions): APIPromise<Part>;
+    /**
+     * Partially updates a part.
+     *
+     * Fields not provided retain their current values. Only the SKU, description, and
+     * notes are editable here; the part's category and attributes are changed through
+     * the item endpoints.
+     *
+     * This endpoint requires the permissions: `parts:update`, `customers:update`,
+     * `suppliers:update`.
+     *
+     * @example
+     * ```ts
+     * const part = await client.catalog.parts.update(
+     *   'pt_coba9fgvd84c',
+     *   {
+     *     description: 'Deep groove ball bearing, 20x47x14mm',
+     *     notes:
+     *       'Superseded by low-friction variant; keep for legacy assemblies.',
+     *     sku: 'BRG-6204-2RS',
+     *   },
+     * );
+     * ```
+     */
+    update(id: string, params?: PartUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Part>;
+    /**
+     * Deletes a part.
+     *
+     * This is a soft delete: the part is marked deleted and no longer returned by
+     * 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(
+     *   'pt_coba9fgvd84c',
+     * );
+     * ```
+     */
+    delete(id: string, options?: RequestOptions): APIPromise<Part>;
+}
+/**
+ * Request to create a part.
+ */
+export interface CreatePartRequest {
+    /**
+     * ID of the item category to place the part in.
+     *
+     * The category's unit group determines the base unit used for the part's rates
+     * (`unit_value`, `unit_cost`, `burn_rate`).
+     */
+    category_id: string;
+    /**
+     * Stock keeping unit code for the part.
+     *
+     * Must be unique within the account; creating a part with a SKU already used by
+     * another item fails with a conflict error.
+     */
+    sku: string;
+    /**
+     * IDs of existing attributes to link to the part at creation time.
+     */
+    attribute_ids?: Array<string>;
+    /**
+     * Free-form description of the part.
+     */
+    description?: string;
+    /**
+     * Free-form notes about the part.
+     */
+    notes?: 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?: MaterialsAPI.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?: MaterialsAPI.RateInput;
+}
+/**
+ * A single page of resources, together with the metadata needed to page through
+ * the rest of the result set.
+ */
+export interface ListPart {
+    /**
+     * Resources in this page.
+     */
+    data: Array<Part>;
+    /**
+     * 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 part in the account's catalog: a component used in production.
+ *
+ * Part-level data such as the SKU, description, category, pricing, and attributes
+ * lives on the underlying `item`.
+ */
+export interface Part {
+    /**
+     * Part ID.
+     */
+    id: string;
+    /**
+     * Creation timestamp.
+     */
+    created_at: string;
+    /**
+     * An entry in your catalog: something you sell, consume, or build with.
+     */
+    item: ItemsAPI.Item | null;
+    /**
+     * Resource type identifier.
+     */
+    object: 'part';
+    /**
+     * Last updated timestamp.
+     */
+    updated_at: string;
+}
+/**
+ * Request to partially update a part.
+ */
+export interface UpdatePartRequest {
+    /**
+     * New free-form description of the part.
+     */
+    description?: string | null;
+    /**
+     * New free-form notes about the part.
+     */
+    notes?: string | null;
+    /**
+     * New stock keeping unit code for the part.
+     *
+     * Must remain unique within the account; a conflict error is returned if another
+     * item already uses it.
+     */
+    sku?: string;
+}
+export interface PartListParams {
+    /**
+     * Only return parts carrying at least one of these attributes.
+     */
+    attribute_ids?: Array<string>;
+    /**
+     * Only return parts belonging to any of these item 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;
+    /**
+     * Only return parts created at or before this time.
+     */
+    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;
+    /**
+     * Only return parts created at or after this time.
+     */
+    starts_at?: string;
+}
+export interface PartRetrieveParams {
+    /**
+     * 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 PartCreateParams {
+    /**
+     * Body param: ID of the item category to place the part in.
+     *
+     * The category's unit group determines the base unit used for the part's rates
+     * (`unit_value`, `unit_cost`, `burn_rate`).
+     */
+    category_id: string;
+    /**
+     * Body param: Stock keeping unit code for the part.
+     *
+     * Must be unique within the account; creating a part 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.unit_value' | 'item.unit_cost' | 'item.burn_rate' | 'item.attributes'>;
+    /**
+     * Body param: IDs of existing attributes to link to the part at creation time.
+     */
+    attribute_ids?: Array<string>;
+    /**
+     * Body param: Free-form description of the part.
+     */
+    description?: string;
+    /**
+     * Body param: Free-form notes about the part.
+     */
+    notes?: 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?: MaterialsAPI.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?: MaterialsAPI.RateInput;
+}
+export interface PartUpdateParams {
+    /**
+     * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+     * are returned as `null`.
+     */
+    include?: Array<'item' | 'item.category' | 'item.unit_value' | 'item.unit_cost' | 'item.burn_rate' | 'item.attributes'>;
+    /**
+     * Body param: New free-form description of the part.
+     */
+    description?: string | null;
+    /**
+     * Body param: New free-form notes about the part.
+     */
+    notes?: string | null;
+    /**
+     * Body param: New stock keeping unit code for the part.
+     *
+     * Must remain unique within the account; a conflict error is returned if another
+     * item already uses it.
+     */
+    sku?: string;
+}
+export declare namespace Parts {
+    export { type CreatePartRequest as CreatePartRequest, type ListPart as ListPart, type Part as Part, type UpdatePartRequest as UpdatePartRequest, type PartListParams as PartListParams, type PartRetrieveParams as PartRetrieveParams, type PartCreateParams as PartCreateParams, type PartUpdateParams as PartUpdateParams, };
+    export { Actions as Actions, type BulkUpsertPartsRequest as BulkUpsertPartsRequest, type UpsertPartInput as UpsertPartInput, type UpsertPartProperty as UpsertPartProperty, type ActionBulkUpsertParams as ActionBulkUpsertParams, };
+}
+//# sourceMappingURL=parts.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"parts.d.mts","sourceRoot":"","sources":["../../../src/resources/catalog/parts/parts.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,KAAK,QAAQ;OACb,KAAK,YAAY;OACjB,KAAK,UAAU;OACf,EACL,sBAAsB,EACtB,OAAO,EACP,sBAAsB,EACtB,eAAe,EACf,kBAAkB,EACnB;OACM,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IAEnE;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CAAC,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAInG;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;IAInB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,MAAM,CAAC,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAK5E;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;IAKnB;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAG/D;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;;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,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC;IAEnC;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC;CACrC;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;;OAQG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;;;;GAKG;AACH,MAAM,WAAW,IAAI;IACnB;;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;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;;;;OAKG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,cAAc;IAC7B;;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,kBAAkB;IACjC;;;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,gBAAgB;IAC/B;;;;;OAKG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACb,MAAM,GAAG,eAAe,GAAG,iBAAiB,GAAG,gBAAgB,GAAG,gBAAgB,GAAG,iBAAiB,CACvG,CAAC;IAEF;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE9B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC;IAEnC;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC;CACrC;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACb,MAAM,GAAG,eAAe,GAAG,iBAAiB,GAAG,gBAAgB,GAAG,gBAAgB,GAAG,iBAAiB,CACvG,CAAC;IAEF;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;;;;OAKG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAID,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,IAAI,IAAI,IAAI,EACjB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;IAEF,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}