@augno/sdk 0.1.9 → 0.7.1

package/src/resources/catalog/product-lines.ts

@@ -12,28 +12,32 @@ import { path } from '../../internal/utils/path';
  */
 export class ProductLines extends APIResource {
   /**
-   * Creates an account-owned product line.
+   * Returns a paginated list of product lines, including account-owned and system
+   * product lines.
+   *
+   * This endpoint requires the permissions: `product_lines:read`, `customers:read`,
+   * `suppliers:read`.
    *
    * @example
    * ```ts
-   * const productLine =
-   *   await client.catalog.productLines.create({
-   *     commission_policy: 'commission_exempt',
-   *     freight_policy: 'billed_freight',
-   *     name: 'Industrial Fasteners',
-   *     unit_group_id: 'ug_01aad07abb8e41fd392d2d7013',
-   *   });
+   * const listProductLine =
+   *   await client.catalog.productLines.list();
    * ```
    */
-  create(params: ProductLineCreateParams, options?: RequestOptions): APIPromise<ProductLine> {
-    const { include, ...body } = params;
-    return this._client.post('/v1/catalog/product-lines', { query: { include }, body, ...options });
+  list(
+    query: ProductLineListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ListProductLine> {
+    return this._client.get('/v1/catalog/product-lines', { query, ...options });
   }
 
   /**
    * Returns a product line by ID, including system-owned product lines accessible to
    * the account.
    *
+   * This endpoint requires the permissions: `product_lines:read`, `customers:read`,
+   * `suppliers:read`.
+   *
    * @example
    * ```ts
    * const productLine =
@@ -51,14 +55,40 @@ export class ProductLines extends APIResource {
   }
 
   /**
-   * Partially updates an account-owned product line. Default system product lines
-   * cannot be updated.
+   * Creates an account-owned product line.
+   *
+   * This endpoint requires the permission: `product_lines:create`.
+   *
+   * @example
+   * ```ts
+   * const productLine =
+   *   await client.catalog.productLines.create({
+   *     commission_policy: 'commission_exempt',
+   *     freight_policy: 'billed_freight',
+   *     name: 'Industrial Fasteners',
+   *     unit_group_id: 'ug_01aad07abb8e41fd392d2d7013',
+   *   });
+   * ```
+   */
+  create(params: ProductLineCreateParams, options?: RequestOptions): APIPromise<ProductLine> {
+    const { include, ...body } = params;
+    return this._client.post('/v1/catalog/product-lines', { query: { include }, body, ...options });
+  }
+
+  /**
+   * Partially updates an account-owned product line.
+   *
+   * Only the provided fields are changed. The reserved default product lines
+   * (shipping, service, credit, tax) cannot be updated.
+   *
+   * This endpoint requires the permission: `product_lines:update`.
    *
    * @example
    * ```ts
    * const productLine =
    *   await client.catalog.productLines.update(
    *     'pl_01996357326a0d3f7b129542ea',
+   *     { name: 'Updated Product Line' },
    *   );
    * ```
    */
@@ -76,26 +106,13 @@ export class ProductLines extends APIResource {
   }
 
   /**
-   * Returns a paginated list of product lines, including account-owned and system
-   * product lines.
+   * Permanently deletes an account-owned product line.
    *
-   * @example
-   * ```ts
-   * const listProductLine =
-   *   await client.catalog.productLines.list();
-   * ```
-   */
-  list(
-    query: ProductLineListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<ListProductLine> {
-    return this._client.get('/v1/catalog/product-lines', { query, ...options });
-  }
-
-  /**
-   * Deletes an account-owned product line. Default system product lines cannot be
+   * The reserved default product lines (shipping, service, credit, tax) cannot be
    * deleted.
    *
+   * This endpoint requires the permission: `product_lines:delete`.
+   *
    * @example
    * ```ts
    * const productLine =
@@ -114,23 +131,36 @@ export class ProductLines extends APIResource {
  */
 export interface CreateProductLineRequest {
   /**
-   * Commission policy of products in this product line.
+   * Default commission policy for products in this product line.
+   *
+   * - `commission_exempt`: no commission applies to these products.
+   * - `commission_applied`: commission applies to these products, unless overridden
+   *   elsewhere.
    */
   commission_policy: 'commission_applied' | 'commission_exempt';
 
   /**
-   * Freight policy for all items in this product line.
+   * Default freight policy for products in this product line.
+   *
+   * - `free_freight`: these products do not incur a freight charge.
+   * - `billed_freight`: freight is billed for these products, unless overridden
+   *   elsewhere.
    */
   freight_policy: 'free_freight' | 'billed_freight';
 
   /**
    * Display name.
+   *
+   * Must be unique among the account's product lines; a duplicate name returns a
+   * conflict error.
    */
   name: string;
 
   /**
-   * Unit group ID associated with this product line. This unit group dictates the
-   * units that products in this product line may be purchased in.
+   * ID of the unit group to associate with this product line.
+   *
+   * The unit group determines the set of units available to products in this product
+   * line.
    */
   unit_group_id: string;
 }
@@ -157,6 +187,9 @@ export interface ListProductLine {
 
 /**
  * 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.
  */
 export interface ProductLine {
   /**
@@ -165,7 +198,11 @@ export interface ProductLine {
   id: string;
 
   /**
-   * Commission policy of products in this product line.
+   * Default commission policy for products in this product line.
+   *
+   * - `commission_exempt`: no commission applies to these products.
+   * - `commission_applied`: commission applies to these products, unless overridden
+   *   elsewhere.
    */
   commission_policy: 'commission_applied' | 'commission_exempt';
 
@@ -175,22 +212,26 @@ export interface ProductLine {
   created_at: string;
 
   /**
-   * Description.
+   * Free-form description of the product line.
    */
   description: string | null;
 
   /**
-   * Freight policy for all items in this product line.
+   * Default freight policy for products in this product line.
+   *
+   * - `free_freight`: these products do not incur a freight charge.
+   * - `billed_freight`: freight is billed for these products, unless overridden
+   *   elsewhere.
    */
   freight_policy: 'free_freight' | 'billed_freight';
 
   /**
-   * Display name.
+   * Display name of the product line.
    */
   name: string;
 
   /**
-   * Notes.
+   * Free-form notes about the product line.
    */
   notes: string | null;
 
@@ -205,7 +246,8 @@ export interface ProductLine {
   owner: APIKeysAPI.Owner | null;
 
   /**
-   * UnitGroup is a unit group resource.
+   * Named collection of units sharing one dimension, defining which units products
+   * can be ordered in along with per-unit discounts and customer portal visibility.
    */
   unit_group: UnitGroupsAPI.UnitGroup | null;
 
@@ -220,56 +262,69 @@ export interface ProductLine {
  */
 export interface UpdateProductLineRequest {
   /**
-   * Commission policy of products in this product line.
+   * Default commission policy for products in this product line.
+   *
+   * - `commission_exempt`: no commission applies to these products.
+   * - `commission_applied`: commission applies to these products, unless overridden
+   *   elsewhere.
    */
   commission_policy?: 'commission_applied' | 'commission_exempt';
 
   /**
-   * Freight policy for all items in this product line.
+   * Default freight policy for products in this product line.
+   *
+   * - `free_freight`: these products do not incur a freight charge.
+   * - `billed_freight`: freight is billed for these products, unless overridden
+   *   elsewhere.
    */
   freight_policy?: 'free_freight' | 'billed_freight';
 
   /**
    * Display name.
+   *
+   * Must be unique among the account's product lines; a duplicate name returns a
+   * conflict error.
    */
   name?: string;
 
   /**
-   * Unit group ID associated with this product line. This unit group dictates the
-   * units that products in this product line may be purchased in.
+   * ID of the unit group to associate with this product line.
+   *
+   * The unit group determines the set of units available to products in this product
+   * line.
    */
   unit_group_id?: string;
 }
 
 export interface ProductLineDeleteResponse {}
 
-export interface ProductLineCreateParams {
-  /**
-   * Body param: Commission policy of products in this product line.
-   */
-  commission_policy: 'commission_applied' | 'commission_exempt';
-
+export interface ProductLineListParams {
   /**
-   * Body param: Freight policy for all items in this product line.
+   * 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.
    */
-  freight_policy: 'free_freight' | 'billed_freight';
+  cursor?: string;
 
   /**
-   * Body param: Display name.
+   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+   * `null`.
    */
-  name: string;
+  include?: Array<'owner' | 'owner.account' | 'unit_group'>;
 
   /**
-   * Body param: Unit group ID associated with this product line. This unit group
-   * dictates the units that products in this product line may be purchased in.
+   * Maximum number of results to return in a single page.
    */
-  unit_group_id: string;
+  limit?: number;
 
   /**
-   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
-   * are returned as `null`.
+   * Free-text search term used to filter results.
+   *
+   * Which fields are matched against the term varies by endpoint.
    */
-  include?: Array<'owner' | 'owner.account' | 'unit_group'>;
+  q?: string;
 }
 
 export interface ProductLineRetrieveParams {
@@ -280,56 +335,88 @@ export interface ProductLineRetrieveParams {
   include?: Array<'owner' | 'owner.account' | 'unit_group'>;
 }
 
-export interface ProductLineUpdateParams {
+export interface ProductLineCreateParams {
   /**
-   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
-   * are returned as `null`.
+   * Body param: Default commission policy for products in this product line.
+   *
+   * - `commission_exempt`: no commission applies to these products.
+   * - `commission_applied`: commission applies to these products, unless overridden
+   *   elsewhere.
    */
-  include?: Array<'owner' | 'owner.account' | 'unit_group'>;
+  commission_policy: 'commission_applied' | 'commission_exempt';
 
   /**
-   * Body param: Commission policy of products in this product line.
+   * Body param: Default freight policy for products in this product line.
+   *
+   * - `free_freight`: these products do not incur a freight charge.
+   * - `billed_freight`: freight is billed for these products, unless overridden
+   *   elsewhere.
    */
-  commission_policy?: 'commission_applied' | 'commission_exempt';
+  freight_policy: 'free_freight' | 'billed_freight';
 
   /**
-   * Body param: Freight policy for all items in this product line.
+   * Body param: Display name.
+   *
+   * Must be unique among the account's product lines; a duplicate name returns a
+   * conflict error.
    */
-  freight_policy?: 'free_freight' | 'billed_freight';
+  name: string;
 
   /**
-   * Body param: Display name.
+   * Body param: ID of the unit group to associate with this product line.
+   *
+   * The unit group determines the set of units available to products in this product
+   * line.
    */
-  name?: string;
+  unit_group_id: string;
 
   /**
-   * Body param: Unit group ID associated with this product line. This unit group
-   * dictates the units that products in this product line may be purchased in.
+   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+   * are returned as `null`.
    */
-  unit_group_id?: string;
+  include?: Array<'owner' | 'owner.account' | 'unit_group'>;
 }
 
-export interface ProductLineListParams {
+export interface ProductLineUpdateParams {
   /**
-   * Cursor token used to retrieve the next or previous page of results.
+   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+   * are returned as `null`.
    */
-  cursor?: string;
+  include?: Array<'owner' | 'owner.account' | 'unit_group'>;
 
   /**
-   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
-   * `null`.
+   * Body param: Default commission policy for products in this product line.
+   *
+   * - `commission_exempt`: no commission applies to these products.
+   * - `commission_applied`: commission applies to these products, unless overridden
+   *   elsewhere.
    */
-  include?: Array<'owner' | 'owner.account' | 'unit_group'>;
+  commission_policy?: 'commission_applied' | 'commission_exempt';
 
   /**
-   * Maximum number of results per page (default: 100, max: 1000).
+   * Body param: Default freight policy for products in this product line.
+   *
+   * - `free_freight`: these products do not incur a freight charge.
+   * - `billed_freight`: freight is billed for these products, unless overridden
+   *   elsewhere.
    */
-  limit?: number;
+  freight_policy?: 'free_freight' | 'billed_freight';
 
   /**
-   * Search query used to filter results.
+   * Body param: Display name.
+   *
+   * Must be unique among the account's product lines; a duplicate name returns a
+   * conflict error.
    */
-  q?: string;
+  name?: string;
+
+  /**
+   * Body param: ID of the unit group to associate with this product line.
+   *
+   * The unit group determines the set of units available to products in this product
+   * line.
+   */
+  unit_group_id?: string;
 }
 
 export declare namespace ProductLines {
@@ -339,9 +426,9 @@ export declare namespace ProductLines {
     type ProductLine as ProductLine,
     type UpdateProductLineRequest as UpdateProductLineRequest,
     type ProductLineDeleteResponse as ProductLineDeleteResponse,
-    type ProductLineCreateParams as ProductLineCreateParams,
+    type ProductLineListParams as ProductLineListParams,
     type ProductLineRetrieveParams as ProductLineRetrieveParams,
+    type ProductLineCreateParams as ProductLineCreateParams,
     type ProductLineUpdateParams as ProductLineUpdateParams,
-    type ProductLineListParams as ProductLineListParams,
   };
 }