@augno/sdk 0.1.9 → 0.7.1

package/resources/catalog/parts.d.ts

@@ -9,20 +9,23 @@ import { RequestOptions } from "../../internal/request-options.js";
  */
 export declare class Parts extends APIResource {
     /**
-     * Creates a part with the specified SKU and category.
+     * Returns a paginated list of parts for the current account.
+     *
+     * This endpoint requires the permissions: `parts:read`, `customers:read`,
+     * `suppliers:read`.
      *
      * @example
      * ```ts
-     * const part = await client.catalog.parts.create({
-     *   category_id: 'ic_01ae7bd7bfd21ca0ab81e1357e',
-     *   sku: 'BRG-6204-2RS',
-     * });
+     * const listPart = await client.catalog.parts.list();
      * ```
      */
-    create(params: PartCreateParams, options?: RequestOptions): APIPromise<Part>;
+    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(
@@ -32,27 +35,53 @@ export declare class Parts extends APIResource {
      */
     retrieve(id: string, query?: PartRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<Part>;
     /**
-     * Partially updates a part. Fields not provided retain their current values.
+     * 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.update(
-     *   'pt_018d7bab53e864351f4c693a21',
-     * );
+     * const part = await client.catalog.parts.create({
+     *   category_id: 'ic_01ae7bd7bfd21ca0ab81e1357e',
+     *   sku: 'BRG-6204-2RS',
+     *   description: 'Deep groove ball bearing, 20x47x14mm',
+     * });
      * ```
      */
-    update(id: string, params?: PartUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Part>;
+    create(params: PartCreateParams, options?: RequestOptions): APIPromise<Part>;
     /**
-     * Returns a paginated list of parts for the current account.
+     * Partially updates a part.
+     *
+     * Fields not provided retain their current values.
+     *
+     * This endpoint requires the permissions: `parts:update`, `customers:update`,
+     * `suppliers:update`.
      *
      * @example
      * ```ts
-     * const listPart = await client.catalog.parts.list();
+     * const part = await client.catalog.parts.update(
+     *   'pt_018d7bab53e864351f4c693a21',
+     *   {
+     *     description: 'Deep groove ball bearing, 20x47x14mm',
+     *     sku: 'BRG-6204-2RS',
+     *   },
+     * );
      * ```
      */
-    list(query?: PartListParams | null | undefined, options?: RequestOptions): APIPromise<ListPart>;
+    update(id: string, params?: PartUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Part>;
     /**
-     * Deletes a part. Sets the deleted_at timestamp rather than removing the record.
+     * 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
@@ -68,31 +97,39 @@ export declare class Parts extends APIResource {
  */
 export interface CreatePartRequest {
     /**
-     * Category ID.
+     * 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;
     /**
-     * SKU.
+     * 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;
     /**
-     * Attribute IDs to connect to the part at creation time.
+     * IDs of existing attributes to link to the part at creation time.
      */
     attribute_ids?: Array<string>;
     /**
-     * Description.
+     * Free-form description of the part.
      */
     description?: string;
     /**
-     * Notes.
+     * Free-form notes about the part.
      */
     notes?: 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?: MaterialsAPI.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?: MaterialsAPI.RateInput;
 }
@@ -114,7 +151,10 @@ export interface ListPart {
     page_info: APIKeysAPI.PageInfo;
 }
 /**
- * Part resource.
+ * 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 {
     /**
@@ -143,52 +183,65 @@ export interface Part {
  */
 export interface UpdatePartRequest {
     /**
-     * Description.
+     * New description for the part.
+     *
+     * Set to a string to replace the current description, or `null` to clear it.
      */
     description?: string | null;
     /**
-     * Notes.
+     * New notes for the part.
+     *
+     * Set to a string to replace the current notes, or `null` to clear them.
      */
     notes?: string | null;
     /**
-     * SKU.
+     * 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 PartCreateParams {
+export interface PartListParams {
     /**
-     * Body param: Category ID.
+     * Filter by attribute IDs.
      */
-    category_id: string;
+    attribute_ids?: Array<string>;
     /**
-     * Body param: SKU.
+     * Filter by category IDs.
      */
-    sku: string;
+    category_ids?: Array<string>;
     /**
-     * Query param: Sub-objects to expand in the response. When omitted, sub-objects
-     * are returned as `null`.
+     * 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.
      */
-    include?: Array<'item' | 'item.category' | 'item.unit_value' | 'item.unit_cost' | 'item.burn_rate' | 'item.attributes'>;
+    cursor?: string;
     /**
-     * Body param: Attribute IDs to connect to the part at creation time.
+     * Filter parts created on or before this date.
      */
-    attribute_ids?: Array<string>;
+    end_date?: string;
     /**
-     * Body param: Description.
+     * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+     * `null`.
      */
-    description?: 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: Notes.
+     * Maximum number of results to return in a single page.
      */
-    notes?: string;
+    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?: MaterialsAPI.RateInput;
+    q?: string;
     /**
-     * Body param: RateInput represents the input for creating or updating a rate.
+     * Filter parts created on or after this date.
      */
-    unit_price?: MaterialsAPI.RateInput;
+    start_date?: string;
 }
 export interface PartRetrieveParams {
     /**
@@ -197,61 +250,76 @@ export interface PartRetrieveParams {
      */
     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 PartUpdateParams {
+export interface PartCreateParams {
     /**
-     * Query param: Sub-objects to expand in the response. When omitted, sub-objects
-     * are returned as `null`.
+     * 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`).
      */
-    include?: Array<'item' | 'item.category' | 'item.unit_value' | 'item.unit_cost' | 'item.burn_rate' | 'item.attributes'>;
+    category_id: string;
     /**
-     * Body param: Description.
+     * 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.
      */
-    description?: string | null;
+    sku: string;
     /**
-     * Body param: Notes.
+     * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+     * are returned as `null`.
      */
-    notes?: string | null;
+    include?: Array<'item' | 'item.category' | 'item.unit_value' | 'item.unit_cost' | 'item.burn_rate' | 'item.attributes'>;
     /**
-     * Body param: SKU.
+     * Body param: IDs of existing attributes to link to the part at creation time.
      */
-    sku?: string;
-}
-export interface PartListParams {
+    attribute_ids?: Array<string>;
     /**
-     * Filter by attribute IDs.
+     * Body param: Free-form description of the part.
      */
-    attribute_ids?: Array<string>;
+    description?: string;
     /**
-     * Filter by category IDs.
+     * Body param: Free-form notes about the part.
      */
-    category_ids?: Array<string>;
+    notes?: string;
     /**
-     * Cursor token used to retrieve the next or previous page of results.
+     * Body param: A rate value with its numerator and denominator units, used in
+     * create and update requests.
      */
-    cursor?: string;
+    unit_cost?: MaterialsAPI.RateInput;
     /**
-     * Filter parts created on or before this date.
+     * Body param: A rate value with its numerator and denominator units, used in
+     * create and update requests.
      */
-    end_date?: string;
+    unit_price?: MaterialsAPI.RateInput;
+}
+export interface PartUpdateParams {
     /**
-     * Sub-objects to expand in the response. When omitted, sub-objects are returned as
-     * `null`.
+     * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+     * are returned as `null`.
      */
-    include?: Array<'item' | 'item.category' | 'item.category.properties' | 'item.category.unit_group' | 'item.unit_value' | 'item.unit_cost' | 'item.burn_rate' | 'item.attributes'>;
+    include?: Array<'item' | 'item.category' | 'item.unit_value' | 'item.unit_cost' | 'item.burn_rate' | 'item.attributes'>;
     /**
-     * Maximum number of results per page (default: 100, max: 1000).
+     * Body param: New description for the part.
+     *
+     * Set to a string to replace the current description, or `null` to clear it.
      */
-    limit?: number;
+    description?: string | null;
     /**
-     * Search query used to filter results.
+     * Body param: New notes for the part.
+     *
+     * Set to a string to replace the current notes, or `null` to clear them.
      */
-    q?: string;
+    notes?: string | null;
     /**
-     * Filter parts created on or after this date.
+     * 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.
      */
-    start_date?: string;
+    sku?: string;
 }
 export declare namespace Parts {
-    export { type CreatePartRequest as CreatePartRequest, type ListPart as ListPart, type Part as Part, type UpdatePartRequest as UpdatePartRequest, type PartCreateParams as PartCreateParams, type PartRetrieveParams as PartRetrieveParams, type PartUpdateParams as PartUpdateParams, type PartListParams as PartListParams, };
+    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, };
 }
 //# sourceMappingURL=parts.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"parts.d.ts","sourceRoot":"","sources":["../../src/resources/catalog/parts.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,YAAY,uBAAoB;AAC5C,OAAO,KAAK,UAAU,qCAAkC;AACxD,OAAO,KAAK,QAAQ,yBAAsB;AAC1C,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAK5E;;;;;;;;;OASG;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;;;;;;;;;OASG;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;;;;;;;OAOG;IACH,IAAI,CAAC,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAInG;;;;;;;;;OASG;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;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;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;;OAEG;IACH,SAAS,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC;IAEnC;;OAEG;IACH,UAAU,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;GAEG;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;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;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;;OAEG;IACH,SAAS,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC;IAEnC;;OAEG;IACH,UAAU,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC;CACrC;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;;;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;;OAEG;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;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;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;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,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,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,cAAc,IAAI,cAAc,GACtC,CAAC;CACH"}
+{"version":3,"file":"parts.d.ts","sourceRoot":"","sources":["../../src/resources/catalog/parts.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,YAAY;OACjB,KAAK,UAAU;OACf,KAAK,QAAQ;OACb,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;OAUG;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;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAK5E;;;;;;;;;;;;;;;;;;OAkBG;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;;;OAGG;IACH,SAAS,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC;IAEnC;;;OAGG;IACH,UAAU,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;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;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;;OAIG;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,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;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,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;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;;;OAGG;IACH,SAAS,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC;IAEnC;;;OAGG;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;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;;;;OAKG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,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;CACH"}

package/resources/catalog/parts.js

@@ -9,23 +9,25 @@ const path_1 = require("../../internal/utils/path.js");
  */
 class Parts extends resource_1.APIResource {
     /**
-     * Creates a part with the specified SKU and category.
+     * Returns a paginated list of parts for the current account.
+     *
+     * This endpoint requires the permissions: `parts:read`, `customers:read`,
+     * `suppliers:read`.
      *
      * @example
      * ```ts
-     * const part = await client.catalog.parts.create({
-     *   category_id: 'ic_01ae7bd7bfd21ca0ab81e1357e',
-     *   sku: 'BRG-6204-2RS',
-     * });
+     * const listPart = await client.catalog.parts.list();
      * ```
      */
-    create(params, options) {
-        const { include, ...body } = params;
-        return this._client.post('/v1/catalog/parts', { query: { include }, body, ...options });
+    list(query = {}, options) {
+        return this._client.get('/v1/catalog/parts', { query, ...options });
     }
     /**
      * 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(
@@ -37,32 +39,59 @@ class Parts extends resource_1.APIResource {
         return this._client.get((0, path_1.path) `/v1/catalog/parts/${id}`, { query, ...options });
     }
     /**
-     * Partially updates a part. Fields not provided retain their current values.
+     * 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.update(
-     *   'pt_018d7bab53e864351f4c693a21',
-     * );
+     * const part = await client.catalog.parts.create({
+     *   category_id: 'ic_01ae7bd7bfd21ca0ab81e1357e',
+     *   sku: 'BRG-6204-2RS',
+     *   description: 'Deep groove ball bearing, 20x47x14mm',
+     * });
      * ```
      */
-    update(id, params = {}, options) {
-        const { include, ...body } = params ?? {};
-        return this._client.patch((0, path_1.path) `/v1/catalog/parts/${id}`, { query: { include }, body, ...options });
+    create(params, options) {
+        const { include, ...body } = params;
+        return this._client.post('/v1/catalog/parts', { query: { include }, body, ...options });
     }
     /**
-     * Returns a paginated list of parts for the current account.
+     * Partially updates a part.
+     *
+     * Fields not provided retain their current values.
+     *
+     * This endpoint requires the permissions: `parts:update`, `customers:update`,
+     * `suppliers:update`.
      *
      * @example
      * ```ts
-     * const listPart = await client.catalog.parts.list();
+     * const part = await client.catalog.parts.update(
+     *   'pt_018d7bab53e864351f4c693a21',
+     *   {
+     *     description: 'Deep groove ball bearing, 20x47x14mm',
+     *     sku: 'BRG-6204-2RS',
+     *   },
+     * );
      * ```
      */
-    list(query = {}, options) {
-        return this._client.get('/v1/catalog/parts', { query, ...options });
+    update(id, params = {}, options) {
+        const { include, ...body } = params ?? {};
+        return this._client.patch((0, path_1.path) `/v1/catalog/parts/${id}`, { query: { include }, body, ...options });
     }
     /**
-     * Deletes a part. Sets the deleted_at timestamp rather than removing the record.
+     * 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

package/resources/catalog/parts.js.map

@@ -1 +1 @@
-{"version":3,"file":"parts.js","sourceRoot":"","sources":["../../src/resources/catalog/parts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAMlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,MAAwB,EAAE,OAAwB;QACvD,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;;;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;;;;;;;;;OASG;IACH,MAAM,CACJ,EAAU,EACV,SAA8C,EAAE,EAChD,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,qBAAqB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,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;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,qBAAqB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;CACF;AA/ED,sBA+EC"}
+{"version":3,"file":"parts.js","sourceRoot":"","sources":["../../src/resources/catalog/parts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAMlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;;;;;;;;OAUG;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;;;;;;;;;;;;OAYG;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;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,MAAwB,EAAE,OAAwB;QACvD,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CACJ,EAAU,EACV,SAA8C,EAAE,EAChD,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,qBAAqB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,qBAAqB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;CACF;AA5GD,sBA4GC"}

package/resources/catalog/parts.mjs

@@ -6,23 +6,25 @@ import { path } from "../../internal/utils/path.mjs";
  */
 export class Parts extends APIResource {
     /**
-     * Creates a part with the specified SKU and category.
+     * Returns a paginated list of parts for the current account.
+     *
+     * This endpoint requires the permissions: `parts:read`, `customers:read`,
+     * `suppliers:read`.
      *
      * @example
      * ```ts
-     * const part = await client.catalog.parts.create({
-     *   category_id: 'ic_01ae7bd7bfd21ca0ab81e1357e',
-     *   sku: 'BRG-6204-2RS',
-     * });
+     * const listPart = await client.catalog.parts.list();
      * ```
      */
-    create(params, options) {
-        const { include, ...body } = params;
-        return this._client.post('/v1/catalog/parts', { query: { include }, body, ...options });
+    list(query = {}, options) {
+        return this._client.get('/v1/catalog/parts', { query, ...options });
     }
     /**
      * 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(
@@ -34,32 +36,59 @@ export class Parts extends APIResource {
         return this._client.get(path `/v1/catalog/parts/${id}`, { query, ...options });
     }
     /**
-     * Partially updates a part. Fields not provided retain their current values.
+     * 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.update(
-     *   'pt_018d7bab53e864351f4c693a21',
-     * );
+     * const part = await client.catalog.parts.create({
+     *   category_id: 'ic_01ae7bd7bfd21ca0ab81e1357e',
+     *   sku: 'BRG-6204-2RS',
+     *   description: 'Deep groove ball bearing, 20x47x14mm',
+     * });
      * ```
      */
-    update(id, params = {}, options) {
-        const { include, ...body } = params ?? {};
-        return this._client.patch(path `/v1/catalog/parts/${id}`, { query: { include }, body, ...options });
+    create(params, options) {
+        const { include, ...body } = params;
+        return this._client.post('/v1/catalog/parts', { query: { include }, body, ...options });
     }
     /**
-     * Returns a paginated list of parts for the current account.
+     * Partially updates a part.
+     *
+     * Fields not provided retain their current values.
+     *
+     * This endpoint requires the permissions: `parts:update`, `customers:update`,
+     * `suppliers:update`.
      *
      * @example
      * ```ts
-     * const listPart = await client.catalog.parts.list();
+     * const part = await client.catalog.parts.update(
+     *   'pt_018d7bab53e864351f4c693a21',
+     *   {
+     *     description: 'Deep groove ball bearing, 20x47x14mm',
+     *     sku: 'BRG-6204-2RS',
+     *   },
+     * );
      * ```
      */
-    list(query = {}, options) {
-        return this._client.get('/v1/catalog/parts', { query, ...options });
+    update(id, params = {}, options) {
+        const { include, ...body } = params ?? {};
+        return this._client.patch(path `/v1/catalog/parts/${id}`, { query: { include }, body, ...options });
     }
     /**
-     * Deletes a part. Sets the deleted_at timestamp rather than removing the record.
+     * 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

package/resources/catalog/parts.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"parts.mjs","sourceRoot":"","sources":["../../src/resources/catalog/parts.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAMlD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,MAAwB,EAAE,OAAwB;QACvD,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;;;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;;;;;;;;;OASG;IACH,MAAM,CACJ,EAAU,EACV,SAA8C,EAAE,EAChD,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,qBAAqB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,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;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,qBAAqB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;CACF"}
+{"version":3,"file":"parts.mjs","sourceRoot":"","sources":["../../src/resources/catalog/parts.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAMf,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;OAUG;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;;;;;;;;;;;;OAYG;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;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,MAAwB,EAAE,OAAwB;QACvD,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CACJ,EAAU,EACV,SAA8C,EAAE,EAChD,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,qBAAqB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,qBAAqB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;CACF"}