@augno/sdk 0.1.9 → 0.7.1

package/resources/catalog/products.d.ts

@@ -10,21 +10,23 @@ import { RequestOptions } from "../../internal/request-options.js";
  */
 export declare class Products extends APIResource {
     /**
-     * Creates a product.
+     * Returns a paginated list of products for the target account.
+     *
+     * This endpoint requires the permissions: `items:read`, `customers:read`,
+     * `suppliers:read`.
      *
      * @example
      * ```ts
-     * const product = await client.catalog.products.create({
-     *   category_id: 'ic_01ae7bd7bfd21ca0ab81e1357e',
-     *   sku: 'ALM-2024-1001',
-     *   type: 'sale',
-     * });
+     * const listProduct = await client.catalog.products.list();
      * ```
      */
-    create(params: ProductCreateParams, options?: RequestOptions): APIPromise<Product>;
+    list(query?: ProductListParams | null | undefined, options?: RequestOptions): APIPromise<ListProduct>;
     /**
      * Returns a product by ID.
      *
+     * This endpoint requires the permissions: `items:read`, `customers:read`,
+     * `suppliers:read`.
+     *
      * @example
      * ```ts
      * const product = await client.catalog.products.retrieve(
@@ -34,28 +36,43 @@ export declare class Products extends APIResource {
      */
     retrieve(id: string, query?: ProductRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<Product>;
     /**
-     * Partially updates a product.
+     * Creates a product and its backing inventory item.
+     *
+     * The new item starts with zero on-hand inventory, and its pricing defaults to
+     * zero rates in the category's base unit unless `unit_price` or `unit_cost` is
+     * provided.
+     *
+     * This endpoint requires the permission: `items:create`.
      *
      * @example
      * ```ts
-     * const product = await client.catalog.products.update(
-     *   'pd_013c29ab3f1518d0004094c316',
-     * );
+     * const product = await client.catalog.products.create({
+     *   category_id: 'ic_01ae7bd7bfd21ca0ab81e1357e',
+     *   sku: 'ALM-2024-1001',
+     *   type: 'sale',
+     * });
      * ```
      */
-    update(id: string, params?: ProductUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Product>;
+    create(params: ProductCreateParams, options?: RequestOptions): APIPromise<Product>;
     /**
-     * Returns a paginated list of products for the target account.
+     * Partially updates a product.
+     *
+     * This endpoint requires the permission: `items:update`.
      *
      * @example
      * ```ts
-     * const listProduct = await client.catalog.products.list();
+     * const product = await client.catalog.products.update(
+     *   'pd_013c29ab3f1518d0004094c316',
+     *   { sku: 'SKU-002' },
+     * );
      * ```
      */
-    list(query?: ProductListParams | null | undefined, options?: RequestOptions): APIPromise<ListProduct>;
+    update(id: string, params?: ProductUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Product>;
     /**
      * Soft-deletes a product and returns the deleted product.
      *
+     * This endpoint requires the permission: `items:delete`.
+     *
      * @example
      * ```ts
      * const product = await client.catalog.products.delete(
@@ -67,6 +84,8 @@ export declare class Products extends APIResource {
     /**
      * Changes the product line assignment for a product.
      *
+     * This endpoint requires the permission: `items:update`.
+     *
      * @example
      * ```ts
      * const product =
@@ -83,15 +102,29 @@ export declare class Products extends APIResource {
  */
 export interface CreateProductRequest {
     /**
-     * Category ID.
+     * ID of the item category for the product's item.
+     *
+     * The category's unit group determines the default units used for the product's
+     * pricing rates and inventory tracking.
      */
     category_id: string;
     /**
-     * SKU.
+     * Stock keeping unit code for the product's item.
+     *
+     * Must be unique within the account; creation fails with a conflict error if
+     * another item already uses it.
      */
     sku: string;
     /**
-     * Product type code (e.g. sale, sample).
+     * Product type code, which determines how the product behaves on orders and
+     * invoices.
+     *
+     * - `sale`: a standard sellable product.
+     * - `service`: a non-physical service line, such as labor or installation.
+     * - `shipping`: a shipping charge applied to an order.
+     * - `credit`: a credit applied against an order or invoice.
+     * - `return`: a returned product (RMA).
+     * - `tax`: a tax line.
      */
     type: 'sale' | 'service' | 'shipping' | 'credit' | 'return' | 'tax';
     /**
@@ -99,27 +132,36 @@ export interface CreateProductRequest {
      */
     attribute_ids?: Array<string>;
     /**
-     * Description.
+     * Free-form description of the product.
      */
     description?: string;
     /**
-     * Notes.
+     * Free-form notes about the product.
      */
     notes?: string;
     /**
-     * Whether visible in the customer portal.
+     * Whether the product is shown to buyers in the customer portal.
+     *
+     * - `visible`: buyers can see and order the product in the portal.
+     * - `hidden`: the product is concealed from the portal but remains usable
+     *   internally.
+     *
+     * When omitted, the product is created hidden, so it must be set to `visible`
+     * before buyers can see it.
      */
     portal_visibility?: 'visible' | 'hidden';
     /**
-     * Product line ID.
+     * ID of the product line to assign the product to.
      */
     product_line_id?: 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;
 }
@@ -141,7 +183,8 @@ export interface ListProduct {
     page_info: APIKeysAPI.PageInfo;
 }
 /**
- * Product with expandable item, product line, and product type.
+ * Product pairs an inventory item with how it is sold: its product type, optional
+ * product line, and customer portal visibility.
  */
 export interface Product {
     /**
@@ -161,15 +204,30 @@ export interface Product {
      */
     object: 'product';
     /**
-     * Product portal visibility.
+     * Whether the product is shown to buyers in the customer portal.
+     *
+     * - `visible`: buyers can see and order the product in the portal.
+     * - `hidden`: the product is concealed from the portal but remains usable
+     *   internally.
      */
     portal_visibility: 'visible' | 'hidden';
     /**
      * Product line resource.
+     *
+     * A product line groups related products in your catalog and carries the default
+     * commission policy, freight policy, and unit group for those products.
      */
     product_line: ProductLinesAPI.ProductLine | null;
     /**
-     * Product type code.
+     * Product type code, which determines how the product behaves on orders and
+     * invoices.
+     *
+     * - `sale`: a standard sellable product.
+     * - `service`: a non-physical service line, such as labor or installation.
+     * - `shipping`: a shipping charge applied to an order.
+     * - `credit`: a credit applied against an order or invoice.
+     * - `return`: a returned product (RMA).
+     * - `tax`: a tax line.
      */
     type: 'sale' | 'service' | 'shipping' | 'credit' | 'return' | 'tax';
     /**
@@ -182,72 +240,90 @@ export interface Product {
  */
 export interface UpdateProductRequest {
     /**
-     * Description.
+     * Free-form description of the product.
+     *
+     * Send `null` to clear.
      */
     description?: string | null;
     /**
-     * Notes.
+     * Free-form notes about the product.
+     *
+     * Send `null` to clear.
      */
     notes?: string | null;
     /**
-     * Whether visible in the customer portal.
+     * Whether the product is shown to buyers in the customer portal.
+     *
+     * - `visible`: buyers can see and order the product in the portal.
+     * - `hidden`: the product is concealed from the portal but remains usable
+     *   internally.
      */
     portal_visibility?: 'visible' | 'hidden';
     /**
-     * SKU.
+     * New stock keeping unit code for the product's item.
+     *
+     * Must be unique within the account; the update fails with a conflict error 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_price?: MaterialsAPI.RateInput;
 }
-export interface ProductCreateParams {
+export interface ProductListParams {
     /**
-     * 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>;
     /**
-     * Body param: Product type code (e.g. sale, sample).
+     * 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.
      */
-    type: 'sale' | 'service' | 'shipping' | 'credit' | 'return' | 'tax';
+    cursor?: string;
     /**
-     * Query param: Sub-objects to expand in the response. When omitted, sub-objects
-     * are returned as `null`.
+     * Filter by customer IDs.
      */
-    include?: Array<'product_line' | 'product_line.unit_group' | 'product_line.unit_group.base_unit' | 'product_line.unit_group.associated_units' | 'product_line.unit_group.associated_units.unit' | 'item' | 'item.category' | 'item.category.properties' | 'item.category.unit_group' | 'item.category.unit_group.base_unit' | 'item.category.unit_group.associated_units' | 'item.category.unit_group.associated_units.unit' | 'item.unit_value' | 'item.unit_cost' | 'item.burn_rate' | 'item.attributes'>;
+    customer_ids?: Array<string>;
     /**
-     * Body param: Attribute IDs to connect to the product at creation time.
+     * End of creation date range.
      */
-    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<'product_line' | 'product_line.unit_group' | 'product_line.unit_group.base_unit' | 'product_line.unit_group.associated_units' | 'product_line.unit_group.associated_units.unit' | 'item' | 'item.category' | 'item.category.properties' | 'item.category.unit_group' | 'item.category.unit_group.base_unit' | 'item.category.unit_group.associated_units' | 'item.category.unit_group.associated_units.unit' | '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: Whether visible in the customer portal.
+     * Filter by customer portal visibility.
      */
     portal_visibility?: 'visible' | 'hidden';
     /**
-     * Body param: Product line ID.
+     * Filter by product line IDs.
      */
-    product_line_id?: string;
+    product_line_ids?: Array<string>;
     /**
-     * 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.
+     * Start of creation date range.
      */
-    unit_price?: MaterialsAPI.RateInput;
+    start_date?: string;
 }
 export interface ProductRetrieveParams {
     /**
@@ -256,79 +332,114 @@ export interface ProductRetrieveParams {
      */
     include?: Array<'product_line' | 'product_line.unit_group' | 'product_line.unit_group.base_unit' | 'product_line.unit_group.associated_units' | 'product_line.unit_group.associated_units.unit' | 'item' | 'item.category' | 'item.category.properties' | 'item.category.unit_group' | 'item.category.unit_group.base_unit' | 'item.category.unit_group.associated_units' | 'item.category.unit_group.associated_units.unit' | 'item.unit_value' | 'item.unit_cost' | 'item.burn_rate' | 'item.attributes'>;
 }
-export interface ProductUpdateParams {
+export interface ProductCreateParams {
     /**
-     * Query param: Sub-objects to expand in the response. When omitted, sub-objects
-     * are returned as `null`.
+     * Body param: ID of the item category for the product's item.
+     *
+     * The category's unit group determines the default units used for the product's
+     * pricing rates and inventory tracking.
      */
-    include?: Array<'product_line' | 'product_line.unit_group' | 'product_line.unit_group.base_unit' | 'product_line.unit_group.associated_units' | 'product_line.unit_group.associated_units.unit' | 'item' | 'item.category' | 'item.category.properties' | 'item.category.unit_group' | 'item.category.unit_group.base_unit' | 'item.category.unit_group.associated_units' | 'item.category.unit_group.associated_units.unit' | '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 product's item.
+     *
+     * Must be unique within the account; creation fails with a conflict error if
+     * another item already uses it.
      */
-    description?: string | null;
+    sku: string;
     /**
-     * Body param: Notes.
+     * Body param: Product type code, which determines how the product behaves on
+     * orders and invoices.
+     *
+     * - `sale`: a standard sellable product.
+     * - `service`: a non-physical service line, such as labor or installation.
+     * - `shipping`: a shipping charge applied to an order.
+     * - `credit`: a credit applied against an order or invoice.
+     * - `return`: a returned product (RMA).
+     * - `tax`: a tax line.
      */
-    notes?: string | null;
+    type: 'sale' | 'service' | 'shipping' | 'credit' | 'return' | 'tax';
     /**
-     * Body param: Whether visible in the customer portal.
+     * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+     * are returned as `null`.
      */
-    portal_visibility?: 'visible' | 'hidden';
+    include?: Array<'product_line' | 'product_line.unit_group' | 'product_line.unit_group.base_unit' | 'product_line.unit_group.associated_units' | 'product_line.unit_group.associated_units.unit' | 'item' | 'item.category' | 'item.category.properties' | 'item.category.unit_group' | 'item.category.unit_group.base_unit' | 'item.category.unit_group.associated_units' | 'item.category.unit_group.associated_units.unit' | 'item.unit_value' | 'item.unit_cost' | 'item.burn_rate' | 'item.attributes'>;
     /**
-     * Body param: SKU.
+     * Body param: Attribute IDs to connect to the product at creation time.
      */
-    sku?: string;
+    attribute_ids?: Array<string>;
     /**
-     * Body param: RateInput represents the input for creating or updating a rate.
+     * Body param: Free-form description of the product.
      */
-    unit_price?: MaterialsAPI.RateInput;
-}
-export interface ProductListParams {
+    description?: string;
     /**
-     * Filter by attribute IDs.
+     * Body param: Free-form notes about the product.
      */
-    attribute_ids?: Array<string>;
+    notes?: string;
     /**
-     * Filter by category IDs.
+     * Body param: Whether the product is shown to buyers in the customer portal.
+     *
+     * - `visible`: buyers can see and order the product in the portal.
+     * - `hidden`: the product is concealed from the portal but remains usable
+     *   internally.
+     *
+     * When omitted, the product is created hidden, so it must be set to `visible`
+     * before buyers can see it.
      */
-    category_ids?: Array<string>;
+    portal_visibility?: 'visible' | 'hidden';
     /**
-     * Cursor token used to retrieve the next or previous page of results.
+     * Body param: ID of the product line to assign the product to.
      */
-    cursor?: string;
+    product_line_id?: string;
     /**
-     * Filter by customer IDs.
+     * Body param: A rate value with its numerator and denominator units, used in
+     * create and update requests.
      */
-    customer_ids?: Array<string>;
+    unit_cost?: MaterialsAPI.RateInput;
     /**
-     * End of creation date range.
+     * 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 ProductUpdateParams {
     /**
-     * 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<'product_line' | 'product_line.unit_group' | 'product_line.unit_group.base_unit' | 'product_line.unit_group.associated_units' | 'product_line.unit_group.associated_units.unit' | 'item' | 'item.category' | 'item.category.properties' | 'item.category.unit_group' | 'item.category.unit_group.base_unit' | 'item.category.unit_group.associated_units' | 'item.category.unit_group.associated_units.unit' | 'item.unit_value' | 'item.unit_cost' | 'item.burn_rate' | 'item.attributes'>;
     /**
-     * Maximum number of results per page (default: 100, max: 1000).
+     * Body param: Free-form description of the product.
+     *
+     * Send `null` to clear.
      */
-    limit?: number;
+    description?: string | null;
     /**
-     * Filter by customer portal visibility.
+     * Body param: Free-form notes about the product.
+     *
+     * Send `null` to clear.
      */
-    portal_visibility?: 'visible' | 'hidden';
+    notes?: string | null;
     /**
-     * Filter by product line IDs.
+     * Body param: Whether the product is shown to buyers in the customer portal.
+     *
+     * - `visible`: buyers can see and order the product in the portal.
+     * - `hidden`: the product is concealed from the portal but remains usable
+     *   internally.
      */
-    product_line_ids?: Array<string>;
+    portal_visibility?: 'visible' | 'hidden';
     /**
-     * Search query used to filter results.
+     * Body param: New stock keeping unit code for the product's item.
+     *
+     * Must be unique within the account; the update fails with a conflict error if
+     * another item already uses it.
      */
-    q?: string;
+    sku?: string;
     /**
-     * Start of creation date range.
+     * Body param: A rate value with its numerator and denominator units, used in
+     * create and update requests.
      */
-    start_date?: string;
+    unit_price?: MaterialsAPI.RateInput;
 }
 export interface ProductDeleteParams {
     /**
@@ -349,6 +460,6 @@ export interface ProductChangeProductLineParams {
     include?: Array<'product_line' | 'product_line.unit_group' | 'product_line.unit_group.base_unit' | 'product_line.unit_group.associated_units' | 'product_line.unit_group.associated_units.unit' | 'item' | 'item.category' | 'item.category.properties' | 'item.category.unit_group' | 'item.category.unit_group.base_unit' | 'item.category.unit_group.associated_units' | 'item.category.unit_group.associated_units.unit' | 'item.unit_value' | 'item.unit_cost' | 'item.burn_rate' | 'item.attributes'>;
 }
 export declare namespace Products {
-    export { type CreateProductRequest as CreateProductRequest, type ListProduct as ListProduct, type Product as Product, type UpdateProductRequest as UpdateProductRequest, type ProductCreateParams as ProductCreateParams, type ProductRetrieveParams as ProductRetrieveParams, type ProductUpdateParams as ProductUpdateParams, type ProductListParams as ProductListParams, type ProductDeleteParams as ProductDeleteParams, type ProductChangeProductLineParams as ProductChangeProductLineParams, };
+    export { type CreateProductRequest as CreateProductRequest, type ListProduct as ListProduct, type Product as Product, type UpdateProductRequest as UpdateProductRequest, type ProductListParams as ProductListParams, type ProductRetrieveParams as ProductRetrieveParams, type ProductCreateParams as ProductCreateParams, type ProductUpdateParams as ProductUpdateParams, type ProductDeleteParams as ProductDeleteParams, type ProductChangeProductLineParams as ProductChangeProductLineParams, };
 }
 //# sourceMappingURL=products.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"products.d.ts","sourceRoot":"","sources":["../../src/resources/catalog/products.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,YAAY,uBAAoB;AAC5C,OAAO,KAAK,eAAe,2BAAwB;AACnD,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,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,MAAM,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAKlF;;;;;;;;;OASG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC;IAItB;;;;;;;;;OASG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC;IAKtB;;;;;;;OAOG;IACH,IAAI,CAAC,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,WAAW,CAAC;IAIzG;;;;;;;;;OASG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC;IAKtB;;;;;;;;;;;OAWG;IACH,iBAAiB,CACf,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,8BAA8B,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC;CAOvB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,UAAU,GAAG,QAAQ,GAAG,QAAQ,GAAG,KAAK,CAAC;IAEpE;;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,iBAAiB,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC;IAEzC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;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,WAAW;IAC1B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;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,SAAS,CAAC;IAElB;;OAEG;IACH,iBAAiB,EAAE,SAAS,GAAG,QAAQ,CAAC;IAExC;;OAEG;IACH,YAAY,EAAE,eAAe,CAAC,WAAW,GAAG,IAAI,CAAC;IAEjD;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,UAAU,GAAG,QAAQ,GAAG,QAAQ,GAAG,KAAK,CAAC;IAEpE;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,iBAAiB,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC;IAEzC;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC;CACrC;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,UAAU,GAAG,QAAQ,GAAG,QAAQ,GAAG,KAAK,CAAC;IAEpE;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,cAAc,GACd,yBAAyB,GACzB,mCAAmC,GACnC,0CAA0C,GAC1C,+CAA+C,GAC/C,MAAM,GACN,eAAe,GACf,0BAA0B,GAC1B,0BAA0B,GAC1B,oCAAoC,GACpC,2CAA2C,GAC3C,gDAAgD,GAChD,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,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,iBAAiB,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC;IAEzC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,SAAS,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC;IAEnC;;OAEG;IACH,UAAU,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC;CACrC;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,cAAc,GACd,yBAAyB,GACzB,mCAAmC,GACnC,0CAA0C,GAC1C,+CAA+C,GAC/C,MAAM,GACN,eAAe,GACf,0BAA0B,GAC1B,0BAA0B,GAC1B,oCAAoC,GACpC,2CAA2C,GAC3C,gDAAgD,GAChD,iBAAiB,GACjB,gBAAgB,GAChB,gBAAgB,GAChB,iBAAiB,CACpB,CAAC;CACH;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,cAAc,GACd,yBAAyB,GACzB,mCAAmC,GACnC,0CAA0C,GAC1C,+CAA+C,GAC/C,MAAM,GACN,eAAe,GACf,0BAA0B,GAC1B,0BAA0B,GAC1B,oCAAoC,GACpC,2CAA2C,GAC3C,gDAAgD,GAChD,iBAAiB,GACjB,gBAAgB,GAChB,gBAAgB,GAChB,iBAAiB,CACpB,CAAC;IAEF;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,iBAAiB,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC;IAEzC;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC;CACrC;AAED,MAAM,WAAW,iBAAiB;IAChC;;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,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,cAAc,GACd,yBAAyB,GACzB,mCAAmC,GACnC,0CAA0C,GAC1C,+CAA+C,GAC/C,MAAM,GACN,eAAe,GACf,0BAA0B,GAC1B,0BAA0B,GAC1B,oCAAoC,GACpC,2CAA2C,GAC3C,gDAAgD,GAChD,iBAAiB,GACjB,gBAAgB,GAChB,gBAAgB,GAChB,iBAAiB,CACpB,CAAC;IAEF;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,iBAAiB,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC;IAEzC;;OAEG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEjC;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,cAAc,GACd,yBAAyB,GACzB,mCAAmC,GACnC,0CAA0C,GAC1C,+CAA+C,GAC/C,MAAM,GACN,eAAe,GACf,0BAA0B,GAC1B,0BAA0B,GAC1B,oCAAoC,GACpC,2CAA2C,GAC3C,gDAAgD,GAChD,iBAAiB,GACjB,gBAAgB,GAChB,gBAAgB,GAChB,iBAAiB,CACpB,CAAC;CACH;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,cAAc,GACd,yBAAyB,GACzB,mCAAmC,GACnC,0CAA0C,GAC1C,+CAA+C,GAC/C,MAAM,GACN,eAAe,GACf,0BAA0B,GAC1B,0BAA0B,GAC1B,oCAAoC,GACpC,2CAA2C,GAC3C,gDAAgD,GAChD,iBAAiB,GACjB,gBAAgB,GAChB,gBAAgB,GAChB,iBAAiB,CACpB,CAAC;CACH;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;CACH"}
+{"version":3,"file":"products.d.ts","sourceRoot":"","sources":["../../src/resources/catalog/products.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,YAAY;OACjB,KAAK,eAAe;OACpB,KAAK,UAAU;OACf,KAAK,QAAQ;OACb,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;OAUG;IACH,IAAI,CAAC,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,WAAW,CAAC;IAIzG;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC;IAItB;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,MAAM,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAKlF;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC;IAKtB;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC;IAKtB;;;;;;;;;;;;;OAaG;IACH,iBAAiB,CACf,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,8BAA8B,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC;CAOvB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;;OAKG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;;;;;;;OAUG;IACH,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,UAAU,GAAG,QAAQ,GAAG,QAAQ,GAAG,KAAK,CAAC;IAEpE;;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;;;;;;;;;OASG;IACH,iBAAiB,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC;IAEzC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;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,WAAW;IAC1B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;;GAGG;AACH,MAAM,WAAW,OAAO;IACtB;;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,SAAS,CAAC;IAElB;;;;;;OAMG;IACH,iBAAiB,EAAE,SAAS,GAAG,QAAQ,CAAC;IAExC;;;;;OAKG;IACH,YAAY,EAAE,eAAe,CAAC,WAAW,GAAG,IAAI,CAAC;IAEjD;;;;;;;;;;OAUG;IACH,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,UAAU,GAAG,QAAQ,GAAG,QAAQ,GAAG,KAAK,CAAC;IAEpE;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC;IAEzC;;;;;OAKG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,UAAU,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC;CACrC;AAED,MAAM,WAAW,iBAAiB;IAChC;;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,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,cAAc,GACd,yBAAyB,GACzB,mCAAmC,GACnC,0CAA0C,GAC1C,+CAA+C,GAC/C,MAAM,GACN,eAAe,GACf,0BAA0B,GAC1B,0BAA0B,GAC1B,oCAAoC,GACpC,2CAA2C,GAC3C,gDAAgD,GAChD,iBAAiB,GACjB,gBAAgB,GAChB,gBAAgB,GAChB,iBAAiB,CACpB,CAAC;IAEF;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,iBAAiB,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC;IAEzC;;OAEG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEjC;;;;OAIG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,cAAc,GACd,yBAAyB,GACzB,mCAAmC,GACnC,0CAA0C,GAC1C,+CAA+C,GAC/C,MAAM,GACN,eAAe,GACf,0BAA0B,GAC1B,0BAA0B,GAC1B,oCAAoC,GACpC,2CAA2C,GAC3C,gDAAgD,GAChD,iBAAiB,GACjB,gBAAgB,GAChB,gBAAgB,GAChB,iBAAiB,CACpB,CAAC;CACH;AAED,MAAM,WAAW,mBAAmB;IAClC;;;;;OAKG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;;;;;;;OAUG;IACH,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,UAAU,GAAG,QAAQ,GAAG,QAAQ,GAAG,KAAK,CAAC;IAEpE;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,cAAc,GACd,yBAAyB,GACzB,mCAAmC,GACnC,0CAA0C,GAC1C,+CAA+C,GAC/C,MAAM,GACN,eAAe,GACf,0BAA0B,GAC1B,0BAA0B,GAC1B,oCAAoC,GACpC,2CAA2C,GAC3C,gDAAgD,GAChD,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,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;;;;;OASG;IACH,iBAAiB,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC;IAEzC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,SAAS,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC;IAEnC;;;OAGG;IACH,UAAU,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC;CACrC;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,cAAc,GACd,yBAAyB,GACzB,mCAAmC,GACnC,0CAA0C,GAC1C,+CAA+C,GAC/C,MAAM,GACN,eAAe,GACf,0BAA0B,GAC1B,0BAA0B,GAC1B,oCAAoC,GACpC,2CAA2C,GAC3C,gDAAgD,GAChD,iBAAiB,GACjB,gBAAgB,GAChB,gBAAgB,GAChB,iBAAiB,CACpB,CAAC;IAEF;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC;IAEzC;;;;;OAKG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,UAAU,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC;CACrC;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,cAAc,GACd,yBAAyB,GACzB,mCAAmC,GACnC,0CAA0C,GAC1C,+CAA+C,GAC/C,MAAM,GACN,eAAe,GACf,0BAA0B,GAC1B,0BAA0B,GAC1B,oCAAoC,GACpC,2CAA2C,GAC3C,gDAAgD,GAChD,iBAAiB,GACjB,gBAAgB,GAChB,gBAAgB,GAChB,iBAAiB,CACpB,CAAC;CACH;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,cAAc,GACd,yBAAyB,GACzB,mCAAmC,GACnC,0CAA0C,GAC1C,+CAA+C,GAC/C,MAAM,GACN,eAAe,GACf,0BAA0B,GAC1B,0BAA0B,GAC1B,oCAAoC,GACpC,2CAA2C,GAC3C,gDAAgD,GAChD,iBAAiB,GACjB,gBAAgB,GAChB,gBAAgB,GAChB,iBAAiB,CACpB,CAAC;CACH;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;CACH"}

package/resources/catalog/products.js

@@ -9,24 +9,25 @@ const path_1 = require("../../internal/utils/path.js");
  */
 class Products extends resource_1.APIResource {
     /**
-     * Creates a product.
+     * Returns a paginated list of products for the target account.
+     *
+     * This endpoint requires the permissions: `items:read`, `customers:read`,
+     * `suppliers:read`.
      *
      * @example
      * ```ts
-     * const product = await client.catalog.products.create({
-     *   category_id: 'ic_01ae7bd7bfd21ca0ab81e1357e',
-     *   sku: 'ALM-2024-1001',
-     *   type: 'sale',
-     * });
+     * const listProduct = await client.catalog.products.list();
      * ```
      */
-    create(params, options) {
-        const { include, ...body } = params;
-        return this._client.post('/v1/catalog/products', { query: { include }, body, ...options });
+    list(query = {}, options) {
+        return this._client.get('/v1/catalog/products', { query, ...options });
     }
     /**
      * Returns a product by ID.
      *
+     * This endpoint requires the permissions: `items:read`, `customers:read`,
+     * `suppliers:read`.
+     *
      * @example
      * ```ts
      * const product = await client.catalog.products.retrieve(
@@ -38,33 +39,49 @@ class Products extends resource_1.APIResource {
         return this._client.get((0, path_1.path) `/v1/catalog/products/${id}`, { query, ...options });
     }
     /**
-     * Partially updates a product.
+     * Creates a product and its backing inventory item.
+     *
+     * The new item starts with zero on-hand inventory, and its pricing defaults to
+     * zero rates in the category's base unit unless `unit_price` or `unit_cost` is
+     * provided.
+     *
+     * This endpoint requires the permission: `items:create`.
      *
      * @example
      * ```ts
-     * const product = await client.catalog.products.update(
-     *   'pd_013c29ab3f1518d0004094c316',
-     * );
+     * const product = await client.catalog.products.create({
+     *   category_id: 'ic_01ae7bd7bfd21ca0ab81e1357e',
+     *   sku: 'ALM-2024-1001',
+     *   type: 'sale',
+     * });
      * ```
      */
-    update(id, params = {}, options) {
-        const { include, ...body } = params ?? {};
-        return this._client.patch((0, path_1.path) `/v1/catalog/products/${id}`, { query: { include }, body, ...options });
+    create(params, options) {
+        const { include, ...body } = params;
+        return this._client.post('/v1/catalog/products', { query: { include }, body, ...options });
     }
     /**
-     * Returns a paginated list of products for the target account.
+     * Partially updates a product.
+     *
+     * This endpoint requires the permission: `items:update`.
      *
      * @example
      * ```ts
-     * const listProduct = await client.catalog.products.list();
+     * const product = await client.catalog.products.update(
+     *   'pd_013c29ab3f1518d0004094c316',
+     *   { sku: 'SKU-002' },
+     * );
      * ```
      */
-    list(query = {}, options) {
-        return this._client.get('/v1/catalog/products', { query, ...options });
+    update(id, params = {}, options) {
+        const { include, ...body } = params ?? {};
+        return this._client.patch((0, path_1.path) `/v1/catalog/products/${id}`, { query: { include }, body, ...options });
     }
     /**
      * Soft-deletes a product and returns the deleted product.
      *
+     * This endpoint requires the permission: `items:delete`.
+     *
      * @example
      * ```ts
      * const product = await client.catalog.products.delete(
@@ -79,6 +96,8 @@ class Products extends resource_1.APIResource {
     /**
      * Changes the product line assignment for a product.
      *
+     * This endpoint requires the permission: `items:update`.
+     *
      * @example
      * ```ts
      * const product =

package/resources/catalog/products.js.map

@@ -1 +1 @@
-{"version":3,"file":"products.js","sourceRoot":"","sources":["../../src/resources/catalog/products.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAOlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,MAA2B,EAAE,OAAwB;QAC1D,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CACN,EAAU,EACV,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,wBAAwB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CACJ,EAAU,EACV,SAAiD,EAAE,EACnD,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,wBAAwB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxG,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CAAC,QAA8C,EAAE,EAAE,OAAwB;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAsB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CACJ,EAAU,EACV,SAAiD,EAAE,EACnD,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,wBAAwB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;;;;;OAWG;IACH,iBAAiB,CACf,aAAqB,EACrB,MAAsC,EACtC,OAAwB;QAExB,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,wBAAwB,EAAE,iBAAiB,aAAa,EAAE,EAAE;YACtF,KAAK,EAAE,EAAE,OAAO,EAAE;YAClB,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AA7GD,4BA6GC"}
+{"version":3,"file":"products.js","sourceRoot":"","sources":["../../src/resources/catalog/products.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAOlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;;OAUG;IACH,IAAI,CAAC,QAA8C,EAAE,EAAE,OAAwB;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAsB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,EAAU,EACV,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,wBAAwB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,MAA2B,EAAE,OAAwB;QAC1D,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,EAAU,EACV,SAAiD,EAAE,EACnD,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,wBAAwB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxG,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,EAAU,EACV,SAAiD,EAAE,EACnD,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,wBAAwB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,iBAAiB,CACf,aAAqB,EACrB,MAAsC,EACtC,OAAwB;QAExB,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,wBAAwB,EAAE,iBAAiB,aAAa,EAAE,EAAE;YACtF,KAAK,EAAE,EAAE,OAAO,EAAE;YAClB,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAhID,4BAgIC"}