@augno/sdk 0.1.9 → 0.7.1

package/resources/sales/customers/customers.d.mts

@@ -1,4 +1,5 @@
 import { APIResource } from "../../../core/resource.mjs";
+import * as BlocksAPI from "../../messaging/blocks.mjs";
 import * as AccountGroupsAPI from "../account-groups.mjs";
 import * as AddressesAPI from "../addresses.mjs";
 import * as PrioritiesAPI from "../priorities.mjs";
@@ -14,28 +15,21 @@ import { RequestOptions } from "../../../internal/request-options.mjs";
 export declare class Customers extends APIResource {
     actions: ActionsAPI.Actions;
     /**
-     * Creates a customer account. Auto-generates a customer number if one is not
-     * provided.
+     * Returns a paginated list of customers for the current account.
+     *
+     * This endpoint requires the permission: `customers:read`.
      *
      * @example
      * ```ts
-     * const customer = await client.sales.customers.create({
-     *   bill_to_address: { name: 'Acme Inc.', country: 'US' },
-     *   customer_type_group_id: 'acgp_018e88072d1320808dc979cfac',
-     *   default_carrier_id: 'cr_01784fd54c9ba197bb4e42f0e6',
-     *   default_payment_term_id:
-     *     'pytm_018694d6601ea771cd1b52e890',
-     *   default_shipping_term_id:
-     *     'shtm_014341ab4bb5bf94d5b6936f86',
-     *   name: 'Acme Inc.',
-     *   ship_to_address: { name: 'Acme Inc.', country: 'US' },
-     * });
+     * const listCustomer = await client.sales.customers.list();
      * ```
      */
-    create(params: CustomerCreateParams, options?: RequestOptions): APIPromise<Customer>;
+    list(query?: CustomerListParams | null | undefined, options?: RequestOptions): APIPromise<ListCustomer>;
     /**
      * Returns a customer by ID.
      *
+     * This endpoint requires the permissions: `customers:read`, `suppliers:read`.
+     *
      * @example
      * ```ts
      * const customer = await client.sales.customers.retrieve(
@@ -45,29 +39,74 @@ export declare class Customers extends APIResource {
      */
     retrieve(id: string, query?: CustomerRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<Customer>;
     /**
-     * Partially updates a customer account. When a Stripe integration is active,
-     * customer changes are synced to Stripe.
+     * Creates a customer account with its default addresses, fulfillment settings, and
+     * order policies.
+     *
+     * If `number` is omitted, the next sequential customer number is assigned
+     * automatically.
+     *
+     * This endpoint requires the permission: `customers:create`.
      *
      * @example
      * ```ts
-     * const customer = await client.sales.customers.update(
-     *   'ac_0170df1ac58e4d24c66fc89f5f',
-     * );
+     * const customer = await client.sales.customers.create({
+     *   bill_to_address: {
+     *     name: 'Acme Inc.',
+     *     street_line_1: '123 Main St',
+     *     locality: 'New York',
+     *     state: 'NY',
+     *     postal_code: '10001',
+     *     country: 'US',
+     *   },
+     *   customer_type_group_id: 'acgp_018e88072d1320808dc979cfac',
+     *   default_carrier_id: 'cr_01784fd54c9ba197bb4e42f0e6',
+     *   default_payment_term_id:
+     *     'pytm_018694d6601ea771cd1b52e890',
+     *   default_shipping_term_id:
+     *     'shtm_014341ab4bb5bf94d5b6936f86',
+     *   name: 'Acme Inc.',
+     *   ship_to_address: {
+     *     name: 'Acme Inc.',
+     *     street_line_1: '123 Main St',
+     *     locality: 'New York',
+     *     state: 'NY',
+     *     postal_code: '10001',
+     *     country: 'US',
+     *   },
+     *   note: 'Key enterprise account',
+     * });
      * ```
      */
-    update(id: string, params?: CustomerUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Customer>;
+    create(params: CustomerCreateParams, options?: RequestOptions): APIPromise<Customer>;
     /**
-     * Returns a paginated list of customers for the current account.
+     * Partially updates a customer account.
+     *
+     * Only the fields provided in the request are changed. Nullable fields can be set
+     * to `null` to clear their current value.
+     *
+     * This endpoint requires the permission: `customers:update`.
      *
      * @example
      * ```ts
-     * const listCustomer = await client.sales.customers.list();
+     * const customer = await client.sales.customers.update(
+     *   'ac_0170df1ac58e4d24c66fc89f5f',
+     *   {
+     *     default_carrier_id: 'cr_01784fd54c9ba197bb4e42f0e6',
+     *     freight_policy: 'billed_freight',
+     *     name: 'Acme Corp Updated',
+     *     note: 'Updated account notes',
+     *   },
+     * );
      * ```
      */
-    list(query?: CustomerListParams | null | undefined, options?: RequestOptions): APIPromise<ListCustomer>;
+    update(id: string, params?: CustomerUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Customer>;
     /**
-     * Deletes a customer and associated account relations, addresses, and account
-     * users.
+     * Deletes a customer.
+     *
+     * Fails with a conflict error if any sales orders still reference the customer;
+     * delete or reassign those orders, or merge the customer into another first.
+     *
+     * This endpoint requires the permission: `customers:delete`.
      *
      * @example
      * ```ts
@@ -79,64 +118,11 @@ export declare class Customers extends APIResource {
     delete(id: string, options?: RequestOptions): APIPromise<CustomerDeleteResponse>;
 }
 /**
- * Account user with profile, role, and department.
- */
-export interface AccountUser {
-    /**
-     * Account user ID.
-     */
-    id: string;
-    /**
-     * When the account user was created.
-     */
-    created_at: string;
-    /**
-     * Department resource.
-     */
-    department: Department | null;
-    /**
-     * Email address.
-     */
-    email: string | null;
-    /**
-     * Profile image URL.
-     */
-    image_url: string | null;
-    /**
-     * When the user last used this account.
-     */
-    last_used_at: string | null;
-    /**
-     * Display name.
-     */
-    name: string | null;
-    /**
-     * Resource type identifier.
-     */
-    object: 'account_user';
-    /**
-     * Role resource.
-     */
-    role: APIKeysAPI.Role | null;
-    /**
-     * Account user status.
-     */
-    status: 'active' | 'disabled' | 'removed';
-    /**
-     * When the account user was last updated.
-     */
-    updated_at: string;
-    /**
-     * Underlying user ID.
-     */
-    user_id: string;
-    /**
-     * Username.
-     */
-    username: string | null;
-}
-/**
- * Carrier resource.
+ * A shipping carrier configured for fulfilling orders.
+ *
+ * Carriers with a Shippo-supported `code` (`fedex`, `ups`, `usps`) are connected
+ * through Shippo for live rating and label purchase; other carriers represent
+ * self-managed shipping methods such as will call or local delivery.
  */
 export interface Carrier {
     /**
@@ -144,11 +130,19 @@ export interface Carrier {
      */
     id: string;
     /**
-     * Account number.
+     * Your account number with this carrier, used to connect UPS and USPS accounts.
      */
     account_number: string | null;
     /**
-     * Carrier code.
+     * Well-known carrier identifier, set only for recognized carriers and absent for
+     * custom ones.
+     *
+     * - `fedex`, `ups`, `usps`: integrated carriers managed through Shippo (live
+     *   rating and labels).
+     * - `will_call`: customer picks the order up; no carrier shipment.
+     * - `delivery`: delivered by your own vehicles/drivers.
+     * - `ltl`, `ltl1`: less-than-truckload freight carriers.
+     * - `freight_collect`: freight billed to and arranged by the receiver.
      */
     code: 'fedex' | 'ups' | 'usps' | 'will_call' | 'delivery' | 'ltl' | 'ltl1' | 'freight_collect' | null;
     /**
@@ -156,7 +150,8 @@ export interface Carrier {
      */
     created_at: string;
     /**
-     * Customer portal visibility.
+     * Whether customers can see and select this carrier at checkout in the customer
+     * portal.
      */
     customer_portal_visibility: 'visible' | 'hidden';
     /**
@@ -164,7 +159,7 @@ export interface Carrier {
      */
     deleted_at: string | null;
     /**
-     * Display name.
+     * Human-readable name for the carrier, unique among your account's carriers.
      */
     name: string;
     /**
@@ -184,57 +179,22 @@ export interface Carrier {
      */
     updated_at: string;
 }
-/**
- * Material consumed by a production step.
- */
-export interface Consumption {
-    /**
-     * Consumption ID.
-     */
-    id: string;
-    /**
-     * Item is an inventory item (product, material, or part).
-     */
-    consumed_item: ItemsAPI.Item | null;
-    /**
-     * Creation timestamp.
-     */
-    created_at: string;
-    /**
-     * Instructions for how this material is consumed.
-     */
-    instructions: string | null;
-    /**
-     * Resource type identifier.
-     */
-    object: 'consumption';
-    /**
-     * Value with an associated unit.
-     */
-    quantity: ItemsAPI.Quantity | null;
-    /**
-     * Last updated timestamp.
-     */
-    updated_at: string;
-    /**
-     * Value with an associated unit.
-     */
-    waste_quantity: ItemsAPI.Quantity | null;
-}
 /**
  * Request to create a customer.
  */
 export interface CreateCustomerRequest {
     /**
-     * Request to create an address.
+     * Address details used to create an address, either directly or inline on another
+     * resource.
      */
     bill_to_address: AddressesAPI.AddressInput;
     /**
-     * Customer type group ID.
+     * ID of the account group of type `type_group` that categorizes this customer (for
+     * example "Distributors").
      */
     customer_type_group_id: string;
     /**
-     * Default carrier ID.
+     * ID of the default carrier for this customer's shipments.
      */
     default_carrier_id: string;
     /**
@@ -246,36 +206,45 @@ export interface CreateCustomerRequest {
      */
     default_shipping_term_id: string;
     /**
-     * Display name.
+     * The customer's business name, as shown throughout the app and on documents.
      */
     name: string;
     /**
-     * Request to create an address.
+     * Address details used to create an address, either directly or inline on another
+     * resource.
      */
     ship_to_address: AddressesAPI.AddressInput;
     /**
-     * Carrier billing account number.
+     * Carrier billing account number charged when `carrier_billing_type` is
+     * `third_party`.
      */
     carrier_billing_account?: string;
     /**
-     * Carrier billing type.
+     * Who pays the carrier for shipments.
+     *
+     * - `sender`: the shipper (you) pays the carrier.
+     * - `third_party`: a third party is billed, using `carrier_billing_account`.
      */
     carrier_billing_type?: 'sender' | 'third_party';
     /**
-     * Commission policy.
+     * How sales commission applies to this customer's orders.
+     *
+     * - `commission_exempt`: this customer's orders are exempt from sales commission.
+     * - `commission_applied`: sales commission is calculated on this customer's
+     *   orders.
      */
     commission_policy?: 'commission_applied' | 'commission_exempt';
     /**
-     * QuantityInput represents a value with an associated unit for create/update
-     * requests.
+     * A value with an associated unit, used in create and update requests.
      */
     credit_limit?: QuantityInput;
     /**
-     * Price group IDs.
+     * IDs of the account groups of type `pricing_group` to assign to this customer,
+     * used to apply pricing rules.
      */
     customer_price_group_ids?: Array<string>;
     /**
-     * Default priority code.
+     * Priority applied to new orders for this customer.
      */
     default_priority?: 'low' | 'normal' | 'high';
     /**
@@ -283,11 +252,12 @@ export interface CreateCustomerRequest {
      */
     default_sales_rep_id?: string;
     /**
-     * Default service level ID.
+     * ID of the default carrier service level.
      */
     default_service_level_id?: string;
     /**
-     * EDI status.
+     * Whether EDI (Electronic Data Interchange) is enabled for exchanging orders and
+     * documents with this customer.
      */
     edi_status?: 'enabled' | 'disabled';
     /**
@@ -295,15 +265,23 @@ export interface CreateCustomerRequest {
      */
     email?: string;
     /**
-     * Freight policy.
+     * Whether this customer is billed for freight on their orders.
+     *
+     * - `free_freight`: the customer is not billed for freight.
+     * - `billed_freight`: freight is billed to the customer, unless overridden on the
+     *   order.
      */
     freight_policy?: 'free_freight' | 'billed_freight';
     /**
-     * Note.
+     * Free-form note about the customer.
      */
     note?: string;
     /**
-     * Customer number. Auto-generated if omitted.
+     * Human-readable customer number used to identify the account, distinct from the
+     * `id`.
+     *
+     * Must be unique within your account. If omitted, the next sequential number is
+     * assigned automatically.
      */
     number?: string;
     /**
@@ -311,7 +289,12 @@ export interface CreateCustomerRequest {
      */
     phone?: string;
     /**
-     * Account status code.
+     * Account status code, controlling whether the customer can transact.
+     *
+     * - `normal`: standard active account with no restrictions.
+     * - `preferred`: active account flagged as preferred.
+     * - `hold_shipment`: orders can be placed, but shipments are held.
+     * - `hold_all`: all activity is on hold.
      */
     status?: 'normal' | 'preferred' | 'hold_shipment' | 'hold_all';
     /**
@@ -320,7 +303,8 @@ export interface CreateCustomerRequest {
     url?: string;
 }
 /**
- * Customer account.
+ * A business you sell to, with its contact details, default fulfillment settings,
+ * and order policies.
  */
 export interface Customer {
     /**
@@ -328,7 +312,8 @@ export interface Customer {
      */
     id: string;
     /**
-     * Address with associated geolocation.
+     * A saved address that can be used for billing and shipping on sales orders,
+     * invoices, and shipments.
      */
     bill_to_address: APIKeysAPI.Address | null;
     /**
@@ -336,7 +321,11 @@ export interface Customer {
      */
     child_accounts: ListCustomer | null;
     /**
-     * Commission policy.
+     * How sales commission applies to this customer's orders.
+     *
+     * - `commission_exempt`: this customer's orders are exempt from sales commission.
+     * - `commission_applied`: sales commission is calculated on this customer's
+     *   orders.
      */
     commission_policy: 'commission_applied' | 'commission_exempt';
     /**
@@ -356,7 +345,8 @@ export interface Customer {
      */
     defaults: CustomerDefaults | null;
     /**
-     * EDI status.
+     * Whether EDI (Electronic Data Interchange) is enabled for exchanging orders and
+     * documents with this customer.
      */
     edi_status: 'enabled' | 'disabled';
     /**
@@ -364,11 +354,11 @@ export interface Customer {
      */
     freight_preferences: CustomerFreightPreferences | null;
     /**
-     * Display name.
+     * The customer's business name, as shown throughout the app and on documents.
      */
     name: string;
     /**
-     * Note.
+     * Free-form note about the customer.
      */
     note: string | null;
     /**
@@ -376,7 +366,8 @@ export interface Customer {
      */
     notification_preferences: CustomerNotificationPreferences | null;
     /**
-     * Customer number.
+     * Human-readable customer number used to identify the account, distinct from the
+     * `id`.
      */
     number: string;
     /**
@@ -384,7 +375,8 @@ export interface Customer {
      */
     object: 'customer';
     /**
-     * Customer account.
+     * A business you sell to, with its contact details, default fulfillment settings,
+     * and order policies.
      */
     parent_account: Customer | null;
     /**
@@ -392,19 +384,30 @@ export interface Customer {
      */
     price_groups: AccountGroupsAPI.ListAccountGroup | null;
     /**
-     * Customer relationship type.
+     * The customer's position in the account hierarchy.
+     *
+     * - `standalone`: no parent or child accounts.
+     * - `parent`: has one or more child accounts (see `child_accounts`).
+     * - `child`: belongs to a parent account (see `parent_account`).
      */
     relationship_type: 'standalone' | 'parent' | 'child';
     /**
-     * Address with associated geolocation.
+     * A saved address that can be used for billing and shipping on sales orders,
+     * invoices, and shipments.
      */
     ship_to_address: APIKeysAPI.Address | null;
     /**
-     * Account status code.
+     * Account status code, controlling whether the customer can transact.
+     *
+     * - `normal`: standard active account with no restrictions.
+     * - `preferred`: active account flagged as preferred.
+     * - `hold_shipment`: orders can be placed, but shipments are held.
+     * - `hold_all`: all activity is on hold.
      */
     status: 'normal' | 'preferred' | 'hold_shipment' | 'hold_all';
     /**
-     * Account group resource.
+     * A named grouping of customer accounts, used for pricing rules or to categorize
+     * accounts.
      */
     type: AccountGroupsAPI.AccountGroup | null;
     /**
@@ -442,19 +445,24 @@ export interface CustomerDefaults {
      */
     object: 'customer_defaults';
     /**
-     * Payment term resource.
+     * A payment term describing when payment is due (e.g. `Net 30`), assignable to
+     * customers, sales orders, purchase orders, and invoices.
      */
     payment_term: PaymentTerm | null;
     /**
-     * Priority level used by sales orders and picks.
+     * Priority level used to order work on sales orders, purchase orders, and picks.
      */
     priority: PrioritiesAPI.Priority | null;
     /**
-     * Account user with profile, role, and department.
+     * A user's membership in an account, carrying the account-specific status, role,
+     * and department.
+     *
+     * Profile fields (name, email, username, image URL) live on the expandable `user`
+     * sub-resource, which is shared across every account the user belongs to.
      */
-    sales_rep: AccountUser | null;
+    sales_rep: BlocksAPI.AccountUser | null;
     /**
-     * ShippingTerm resource.
+     * A shipping term defining how freight charges are calculated for an order.
      */
     shipping_term: ShippingTerm | null;
 }
@@ -463,15 +471,22 @@ export interface CustomerDefaults {
  */
 export interface CustomerFreightPreferences {
     /**
-     * Carrier billing account number.
+     * Carrier billing account number charged when `billing_type` is `third_party`.
      */
     billing_account: string | null;
     /**
-     * Carrier billing type.
+     * Who pays the carrier for shipments.
+     *
+     * - `sender`: the shipper (you) pays the carrier.
+     * - `third_party`: a third party is billed, using `billing_account`.
      */
     billing_type: 'sender' | 'third_party' | null;
     /**
-     * Carrier resource.
+     * A shipping carrier configured for fulfilling orders.
+     *
+     * Carriers with a Shippo-supported `code` (`fedex`, `ups`, `usps`) are connected
+     * through Shippo for live rating and label purchase; other carriers represent
+     * self-managed shipping methods such as will call or local delivery.
      */
     carrier: Carrier | null;
     /**
@@ -483,7 +498,11 @@ export interface CustomerFreightPreferences {
      */
     service_level: ServiceLevel | null;
     /**
-     * Freight policy.
+     * Freight policy applied to this customer's orders.
+     *
+     * - `free_freight`: the customer is not billed for freight.
+     * - `billed_freight`: freight is billed to the customer, unless overridden
+     *   elsewhere.
      */
     status: 'free_freight' | 'billed_freight';
 }
@@ -500,64 +519,6 @@ export interface CustomerNotificationPreferences {
      */
     object: 'customer_notification_preferences';
 }
-/**
- * Department resource.
- */
-export interface Department {
-    /**
-     * Department ID.
-     */
-    id: string;
-    /**
-     * Creation timestamp.
-     */
-    created_at: string;
-    /**
-     * Location resource.
-     */
-    location: Location | null;
-    /**
-     * List represents a paginated list of resources.
-     */
-    machines: ListMachine | null;
-    /**
-     * Display name.
-     */
-    name: string;
-    /**
-     * Notes about the department.
-     */
-    notes: string | null;
-    /**
-     * Resource type identifier.
-     */
-    object: 'department';
-    /**
-     * List represents a paginated list of resources.
-     */
-    scanning_stations: ListScanningStation | null;
-    /**
-     * Last update timestamp.
-     */
-    updated_at: string;
-}
-/**
- * List represents a paginated list of resources.
- */
-export interface ListConsumption {
-    /**
-     * Resources in this page.
-     */
-    data: Array<Consumption>;
-    /**
-     * Resource type identifier.
-     */
-    object: 'list';
-    /**
-     * PageInfo contains URL-based pagination metadata.
-     */
-    page_info: APIKeysAPI.PageInfo;
-}
 /**
  * List represents a paginated list of resources.
  */
@@ -578,11 +539,11 @@ export interface ListCustomer {
 /**
  * List represents a paginated list of resources.
  */
-export interface ListLocation {
+export interface ListServiceLevel {
     /**
      * Resources in this page.
      */
-    data: Array<Location>;
+    data: Array<ServiceLevel>;
     /**
      * Resource type identifier.
      */
@@ -593,550 +554,391 @@ export interface ListLocation {
     page_info: APIKeysAPI.PageInfo;
 }
 /**
- * List represents a paginated list of resources.
+ * A payment term describing when payment is due (e.g. `Net 30`), assignable to
+ * customers, sales orders, purchase orders, and invoices.
  */
-export interface ListMachine {
-    /**
-     * Resources in this page.
-     */
-    data: Array<Machine>;
+export interface PaymentTerm {
     /**
-     * Resource type identifier.
+     * Payment term ID.
      */
-    object: 'list';
+    id: string;
     /**
-     * PageInfo contains URL-based pagination metadata.
+     * Creation timestamp.
      */
-    page_info: APIKeysAPI.PageInfo;
-}
-/**
- * List represents a paginated list of resources.
- */
-export interface ListProductionStep {
+    created_at: string;
     /**
-     * Resources in this page.
+     * Display name (e.g. `Net 30`).
      */
-    data: Array<ProductionStep>;
+    name: string;
     /**
      * Resource type identifier.
      */
-    object: 'list';
-    /**
-     * PageInfo contains URL-based pagination metadata.
-     */
-    page_info: APIKeysAPI.PageInfo;
-}
-/**
- * List represents a paginated list of resources.
- */
-export interface ListScanningStation {
+    object: 'payment_term';
     /**
-     * Resources in this page.
+     * Owner describes the provenance of a resource.
      */
-    data: Array<ScanningStation>;
+    owner: APIKeysAPI.Owner | null;
     /**
-     * Resource type identifier.
+     * Lifecycle status of the payment term.
      */
-    object: 'list';
+    status: 'active' | 'inactive';
     /**
-     * PageInfo contains URL-based pagination metadata.
+     * Last-updated timestamp.
      */
-    page_info: APIKeysAPI.PageInfo;
+    updated_at: string;
 }
 /**
- * List represents a paginated list of resources.
+ * A value with an associated unit, used in create and update requests.
  */
-export interface ListServiceLevel {
-    /**
-     * Resources in this page.
-     */
-    data: Array<ServiceLevel>;
+export interface QuantityInput {
     /**
-     * Resource type identifier.
+     * ID of the unit of measure for the value.
      */
-    object: 'list';
+    unit_id: string;
     /**
-     * PageInfo contains URL-based pagination metadata.
+     * Decimal value, as a string to preserve precision.
      */
-    page_info: APIKeysAPI.PageInfo;
+    value: string;
 }
 /**
- * Location resource.
+ * Shipping service level for a carrier.
  */
-export interface Location {
+export interface ServiceLevel {
     /**
-     * Location ID.
+     * Service level ID.
      */
     id: string;
-    /**
-     * List represents a paginated list of resources.
-     */
-    children: ListLocation | null;
     /**
      * Creation timestamp.
      */
     created_at: string;
     /**
-     * Display name.
+     * Whether customers can see and select this service level at checkout in the
+     * customer portal.
+     */
+    customer_portal_visibility: 'visible' | 'hidden';
+    /**
+     * Whether this is the carrier's default service level, pre-selected when the
+     * carrier is chosen.
+     *
+     * Each carrier has at most one default; setting a new default clears the previous
+     * one.
+     */
+    is_default: boolean;
+    /**
+     * Human-readable name for the service level, shown to customers at checkout when
+     * the service level is visible.
      */
     name: string;
     /**
      * Resource type identifier.
      */
-    object: 'location';
+    object: 'service_level';
     /**
-     * Location resource.
+     * Owner describes the provenance of a resource.
      */
-    parent: Location | null;
+    owner: APIKeysAPI.Owner | null;
     /**
-     * Location type code.
+     * Carrier-specific code identifying this service level (e.g. `fedex_ground`,
+     * `ups_next_day_air`).
+     *
+     * Values are carrier-defined, so any non-empty string is accepted.
      */
-    type: 'building' | 'section' | 'aisle' | 'rack' | 'shelf' | 'bin';
+    service_level_token: string;
     /**
-     * Last-updated timestamp.
+     * Last updated timestamp.
      */
     updated_at: string;
 }
 /**
- * Machine within an account.
+ * A shipping term defining how freight charges are calculated for an order.
  */
-export interface Machine {
+export interface ShippingTerm {
     /**
-     * Machine ID.
+     * Shipping term ID.
      */
     id: string;
     /**
-     * Creation timestamp.
+     * When this shipping term was created.
      */
     created_at: string;
     /**
-     * Department resource.
+     * Value with an associated unit.
+     */
+    flat_rate: ItemsAPI.Quantity | null;
+    /**
+     * List represents a paginated list of resources.
      */
-    department: Department | null;
+    free_shipping_service_levels: ListServiceLevel | null;
     /**
-     * Display name.
+     * Value with an associated unit.
      */
-    name: string;
+    minimum_order_value: ItemsAPI.Quantity | null;
     /**
-     * Notes.
+     * Human-readable name for the shipping term, used to identify it when assigning
+     * shipping terms to customers and orders.
      */
-    notes: string | null;
+    name: string;
     /**
      * Resource type identifier.
      */
-    object: 'machine';
+    object: 'shipping_term';
     /**
-     * Serial number.
+     * Owner describes the provenance of a resource.
      */
-    serial_number: string;
+    owner: APIKeysAPI.Owner | null;
     /**
-     * Last updated timestamp.
+     * Freight pricing model applied by this shipping term.
+     *
+     * - `free_freight`: no shipping cost to the buyer.
+     * - `flat_rate_freight`: a fixed shipping cost regardless of order details (see
+     *   `flat_rate`).
+     * - `carrier_rate_freight`: shipping cost is determined by the carrier's quoted
+     *   rate.
      */
-    updated_at: string;
-}
-/**
- * Payment term resource.
- */
-export interface PaymentTerm {
-    /**
-     * Payment term ID.
-     */
-    id: string;
-    /**
-     * Creation timestamp.
-     */
-    created_at: string;
-    /**
-     * Display name.
-     */
-    name: string;
-    /**
-     * Resource type identifier.
-     */
-    object: 'payment_term';
-    /**
-     * Owner describes the provenance of a resource.
-     */
-    owner: APIKeysAPI.Owner | null;
-    /**
-     * Payment term status.
-     */
-    status: 'active' | 'inactive';
+    type: 'free_freight' | 'flat_rate_freight' | 'carrier_rate_freight';
     /**
-     * Last-updated timestamp.
+     * When this shipping term was last updated.
      */
     updated_at: string;
 }
 /**
- * Production output of a production step.
+ * Request to partially update a customer.
  */
-export interface ProductionOutput {
-    /**
-     * Production ID.
-     */
-    id: string;
+export interface UpdateCustomerRequest {
     /**
-     * Creation timestamp.
+     * ID of an existing address to use as the default billing address.
      */
-    created_at: string;
+    bill_to_address_id?: string | null;
     /**
-     * Resource type identifier.
+     * Carrier billing account number charged when `carrier_billing_type` is
+     * `third_party`.
      */
-    object: 'production';
+    carrier_billing_account?: string | null;
     /**
-     * Item is an inventory item (product, material, or part).
+     * Who pays the carrier for shipments.
+     *
+     * - `sender`: the shipper (you) pays the carrier.
+     * - `third_party`: a third party is billed, using `carrier_billing_account`.
      */
-    produced_item: ItemsAPI.Item | null;
+    carrier_billing_type?: 'sender' | 'third_party';
     /**
-     * Value with an associated unit.
+     * How sales commission applies to this customer's orders.
+     *
+     * - `commission_exempt`: this customer's orders are exempt from sales commission.
+     * - `commission_applied`: sales commission is calculated on this customer's
+     *   orders.
      */
-    quantity: ItemsAPI.Quantity | null;
+    commission_policy?: 'commission_applied' | 'commission_exempt';
     /**
-     * Last updated timestamp.
+     * A value with an associated unit, used in create and update requests.
      */
-    updated_at: string;
-}
-/**
- * Production step with all nested data.
- */
-export interface ProductionStep {
+    credit_limit?: QuantityInput | null;
     /**
-     * Production step ID.
+     * IDs of the account groups of type `pricing_group` to assign to this customer,
+     * used to apply pricing rules.
+     *
+     * When provided, replaces the customer's full set of existing price groups.
      */
-    id: string;
+    customer_price_group_ids?: Array<string>;
     /**
-     * Allowances as a decimal string.
+     * ID of the account group of type `type_group` that categorizes this customer (for
+     * example "Distributors").
      */
-    allowances: string;
+    customer_type_group_id?: string;
     /**
-     * List represents a paginated list of resources.
+     * ID of the default carrier for this customer's shipments.
      */
-    consumptions: ListConsumption | null;
+    default_carrier_id?: string;
     /**
-     * Creation timestamp.
+     * Default payment term ID.
      */
-    created_at: string;
+    default_payment_term_id?: string;
     /**
-     * Department resource.
+     * Priority applied to new orders for this customer.
      */
-    department: Department | null;
+    default_priority?: 'low' | 'normal' | 'high';
     /**
-     * List represents a paginated list of resources.
+     * The ID of the account user to assign as the default sales rep.
      */
-    in_steps: ListProductionStep | null;
+    default_sales_rep_id?: string | null;
     /**
-     * Rate resource.
+     * ID of the default carrier service level.
      */
-    labor_rate: ItemsAPI.Rate | null;
+    default_service_level_id?: string | null;
     /**
-     * Rate resource.
+     * Default shipping term ID.
      */
-    labor_time: ItemsAPI.Rate | null;
+    default_shipping_term_id?: string;
     /**
-     * Leveling factor as a decimal string.
+     * Whether EDI (Electronic Data Interchange) is enabled for exchanging orders and
+     * documents with this customer.
      */
-    leveling_factor: string;
+    edi_status?: 'enabled' | 'disabled';
     /**
-     * List represents a paginated list of resources.
+     * Email address.
      */
-    machines: ListMachine | null;
+    email?: string | null;
     /**
-     * Display name.
+     * Whether this customer is billed for freight on their orders.
+     *
+     * - `free_freight`: the customer is not billed for freight.
+     * - `billed_freight`: freight is billed to the customer, unless overridden on the
+     *   order.
      */
-    name: string;
+    freight_policy?: 'free_freight' | 'billed_freight';
     /**
-     * Notes.
+     * The customer's business name, as shown throughout the app and on documents.
      */
-    notes: string | null;
+    name?: string;
     /**
-     * Resource type identifier.
+     * Free-form note about the customer.
      */
-    object: 'production_step';
+    note?: string | null;
     /**
-     * List represents a paginated list of resources.
+     * Human-readable customer number used to identify the account, distinct from the
+     * `id`.
+     *
+     * Must be unique within your account.
      */
-    out_steps: ListProductionStep | null;
+    number?: string;
     /**
-     * Rate resource.
+     * Phone number.
      */
-    overhead_rate: ItemsAPI.Rate | null;
+    phone?: string | null;
     /**
-     * Production output of a production step.
+     * ID of an existing address to use as the default shipping address.
      */
-    production: ProductionOutput | null;
+    ship_to_address_id?: string | null;
     /**
-     * Scanning station resource.
+     * Account status code, controlling whether the customer can transact.
+     *
+     * - `normal`: standard active account with no restrictions.
+     * - `preferred`: active account flagged as preferred.
+     * - `hold_shipment`: orders can be placed, but shipments are held.
+     * - `hold_all`: all activity is on hold.
      */
-    scanning_station: ScanningStation | null;
+    status?: 'normal' | 'preferred' | 'hold_shipment' | 'hold_all';
     /**
-     * Last updated timestamp.
+     * Website URL.
      */
-    updated_at: string;
+    url?: string | null;
 }
-/**
- * QuantityInput represents a value with an associated unit for create/update
- * requests.
- */
-export interface QuantityInput {
-    /**
-     * The unit ID for the value.
-     */
-    unit_id: string;
-    /**
-     * The decimal value.
-     */
-    value: string;
+export interface CustomerDeleteResponse {
 }
-/**
- * Scanning station resource.
- */
-export interface ScanningStation {
-    /**
-     * Scanning station ID.
-     */
-    id: string;
-    /**
-     * Creation timestamp.
-     */
-    created_at: string;
-    /**
-     * Department resource.
-     */
-    department: Department | null;
-    /**
-     * Label size code.
-     */
-    label_size: '1x1' | '1x3' | '1x4' | '2x4' | null;
-    /**
-     * Label type code.
-     */
-    label_type: 'tag' | 'traveler' | null;
-    /**
-     * Display name.
-     */
-    name: string;
-    /**
-     * Notes.
-     */
-    notes: string | null;
-    /**
-     * Resource type identifier.
-     */
-    object: 'scanning_station';
-    /**
-     * Operator requirement behavior for this station.
-     */
-    operator_requirement: 'none' | 'material_check';
-    /**
-     * List represents a paginated list of resources.
-     */
-    production_steps: ListProductionStep | null;
-    /**
-     * Scanning station type.
-     */
-    type: 'init_batch' | 'merge_batch' | 'move_batch' | 'split_batch';
+export interface CustomerListParams {
     /**
-     * Last updated timestamp.
+     * Filter by default carrier IDs.
      */
-    updated_at: string;
-}
-/**
- * Shipping service level for a carrier.
- */
-export interface ServiceLevel {
+    carrier_ids?: Array<string>;
     /**
-     * Service level ID.
+     * Filter to customers with any address in this city (exact match).
+     *
+     * When combined with `state` or `postal_code`, a single address must match all
+     * provided values.
      */
-    id: string;
+    city?: string;
     /**
-     * Creation timestamp.
+     * Filter by commission policy.
      */
-    created_at: string;
+    commission_status_codes?: Array<'commission_applied' | 'commission_exempt'>;
     /**
-     * Customer portal visibility.
+     * 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.
      */
-    customer_portal_visibility: 'visible' | 'hidden';
+    cursor?: string;
     /**
-     * Default service level for the carrier.
+     * Filter by customer type group IDs (the account group of type `type_group`
+     * returned in the customer's `type` field).
      */
-    is_default: boolean;
+    customer_group_ids?: Array<string>;
     /**
-     * Display name.
+     * Filter to customers created at or before this timestamp (inclusive).
      */
-    name: string;
+    end_date?: string;
     /**
-     * Resource type identifier.
+     * Filter by freight policy.
      */
-    object: 'service_level';
+    freight_status_codes?: Array<'free_freight' | 'billed_freight'>;
     /**
-     * Owner describes the provenance of a resource.
+     * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+     * `null`.
      */
-    owner: APIKeysAPI.Owner | null;
+    include?: Array<'bill_to_address' | 'ship_to_address' | 'type' | 'parent_account' | 'freight_preferences.carrier' | 'freight_preferences.carrier.service_levels' | 'freight_preferences.service_level' | 'defaults.payment_term' | 'defaults.shipping_term' | 'defaults.sales_rep' | 'defaults.sales_rep.user' | 'defaults.priority' | 'contact_info' | 'freight_preferences' | 'defaults' | 'notification_preferences' | 'price_groups' | 'child_accounts' | 'credit_limit' | 'credit_limit.unit'>;
     /**
-     * Service level token.
+     * Maximum number of results to return in a single page.
      */
-    service_level_token: string;
+    limit?: number;
     /**
-     * Last updated timestamp.
+     * Filter by whether the customer has child accounts.
      */
-    updated_at: string;
-}
-/**
- * ShippingTerm resource.
- */
-export interface ShippingTerm {
+    parent_account_status?: 'parent' | 'non_parent';
     /**
-     * Shipping term ID.
+     * Filter by default payment term IDs.
      */
-    id: string;
+    payment_term_ids?: Array<string>;
     /**
-     * When this shipping term was created.
+     * Filter to customers with any address in this postal code (exact match).
      */
-    created_at: string;
+    postal_code?: string;
     /**
-     * Value with an associated unit.
+     * Filter to customers that belong to any of these pricing groups.
      */
-    flat_rate: ItemsAPI.Quantity | null;
+    pricing_group_ids?: Array<string>;
     /**
-     * List represents a paginated list of resources.
+     * Free-text search term used to filter results.
+     *
+     * Which fields are matched against the term varies by endpoint.
      */
-    free_shipping_service_levels: ListServiceLevel | null;
+    q?: string;
     /**
-     * Value with an associated unit.
+     * Filter by default sales rep IDs.
      */
-    minimum_order_value: ItemsAPI.Quantity | null;
+    sales_rep_ids?: Array<string>;
     /**
-     * Display name.
+     * Filter by default service level IDs.
      */
-    name: string;
+    service_level_ids?: Array<string>;
     /**
-     * Resource type identifier.
+     * Filter by default shipping term IDs.
      */
-    object: 'shipping_term';
+    shipping_term_ids?: Array<string>;
     /**
-     * Owner describes the provenance of a resource.
+     * Filter to customers created at or after this timestamp (inclusive).
      */
-    owner: APIKeysAPI.Owner | null;
+    start_date?: string;
     /**
-     * Shipping term type.
+     * Filter to customers with any address in this state (exact match).
      */
-    type: 'free_freight' | 'flat_rate_freight' | 'carrier_rate_freight';
+    state?: string;
     /**
-     * When this shipping term was last updated.
+     * Filter by account status codes.
      */
-    updated_at: string;
+    status_codes?: Array<'normal' | 'preferred' | 'hold_shipment' | 'hold_all'>;
 }
-/**
- * Request to partially update a customer.
- */
-export interface UpdateCustomerRequest {
-    /**
-     * Bill-to address ID.
-     */
-    bill_to_address_id?: string | null;
-    /**
-     * Carrier billing account number.
-     */
-    carrier_billing_account?: string | null;
-    /**
-     * Carrier billing type.
-     */
-    carrier_billing_type?: 'sender' | 'third_party';
-    /**
-     * Commission policy.
-     */
-    commission_policy?: 'commission_applied' | 'commission_exempt';
-    /**
-     * QuantityInput represents a value with an associated unit for create/update
-     * requests.
-     */
-    credit_limit?: QuantityInput | null;
-    /**
-     * Price group IDs. Replaces all existing price groups when provided.
-     */
-    customer_price_group_ids?: Array<string>;
-    /**
-     * Customer type group ID.
-     */
-    customer_type_group_id?: string;
-    /**
-     * Default carrier ID.
-     */
-    default_carrier_id?: string;
-    /**
-     * Default payment term ID.
-     */
-    default_payment_term_id?: string;
-    /**
-     * Default priority code.
-     */
-    default_priority?: 'low' | 'normal' | 'high';
-    /**
-     * The ID of the account user to assign as the default sales rep.
-     */
-    default_sales_rep_id?: string | null;
-    /**
-     * Default service level ID.
-     */
-    default_service_level_id?: string | null;
-    /**
-     * Default shipping term ID.
-     */
-    default_shipping_term_id?: string;
-    /**
-     * EDI status.
-     */
-    edi_status?: 'enabled' | 'disabled';
-    /**
-     * Email address. Send null to clear.
-     */
-    email?: string | null;
-    /**
-     * Freight policy.
-     */
-    freight_policy?: 'free_freight' | 'billed_freight';
-    /**
-     * Customer name.
-     */
-    name?: string;
-    /**
-     * Note.
-     */
-    note?: string | null;
-    /**
-     * Customer number.
-     */
-    number?: string;
-    /**
-     * Phone number. Send null to clear.
-     */
-    phone?: string | null;
-    /**
-     * Ship-to address ID.
-     */
-    ship_to_address_id?: string | null;
-    /**
-     * Account status code.
-     */
-    status?: 'normal' | 'preferred' | 'hold_shipment' | 'hold_all';
+export interface CustomerRetrieveParams {
     /**
-     * Website URL. Send null to clear.
+     * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+     * `null`.
      */
-    url?: string | null;
-}
-export interface CustomerDeleteResponse {
+    include?: Array<'bill_to_address' | 'ship_to_address' | 'type' | 'parent_account' | 'freight_preferences.carrier' | 'freight_preferences.carrier.service_levels' | 'freight_preferences.service_level' | 'defaults.payment_term' | 'defaults.shipping_term' | 'defaults.sales_rep' | 'defaults.sales_rep.user' | 'defaults.priority' | 'contact_info' | 'freight_preferences' | 'defaults' | 'notification_preferences' | 'price_groups' | 'child_accounts' | 'credit_limit' | 'credit_limit.unit'>;
 }
 export interface CustomerCreateParams {
     /**
-     * Body param: Request to create an address.
+     * Body param: Address details used to create an address, either directly or inline
+     * on another resource.
      */
     bill_to_address: AddressesAPI.AddressInput;
     /**
-     * Body param: Customer type group ID.
+     * Body param: ID of the account group of type `type_group` that categorizes this
+     * customer (for example "Distributors").
      */
     customer_type_group_id: string;
     /**
-     * Body param: Default carrier ID.
+     * Body param: ID of the default carrier for this customer's shipments.
      */
     default_carrier_id: string;
     /**
@@ -1148,41 +950,51 @@ export interface CustomerCreateParams {
      */
     default_shipping_term_id: string;
     /**
-     * Body param: Display name.
+     * Body param: The customer's business name, as shown throughout the app and on
+     * documents.
      */
     name: string;
     /**
-     * Body param: Request to create an address.
+     * Body param: Address details used to create an address, either directly or inline
+     * on another resource.
      */
     ship_to_address: AddressesAPI.AddressInput;
     /**
      * Query param: Sub-objects to expand in the response. When omitted, sub-objects
      * are returned as `null`.
      */
-    include?: Array<'bill_to_address' | 'ship_to_address' | 'type' | 'parent_account' | 'freight_preferences.carrier' | 'freight_preferences.service_level' | 'defaults.payment_term' | 'defaults.shipping_term' | 'defaults.sales_rep' | 'defaults.priority' | 'contact_info' | 'freight_preferences' | 'defaults' | 'notification_preferences' | 'price_groups' | 'child_accounts' | 'credit_limit'>;
+    include?: Array<'bill_to_address' | 'ship_to_address' | 'type' | 'parent_account' | 'freight_preferences.carrier' | 'freight_preferences.carrier.service_levels' | 'freight_preferences.service_level' | 'defaults.payment_term' | 'defaults.shipping_term' | 'defaults.sales_rep' | 'defaults.sales_rep.user' | 'defaults.priority' | 'contact_info' | 'freight_preferences' | 'defaults' | 'notification_preferences' | 'price_groups' | 'child_accounts' | 'credit_limit' | 'credit_limit.unit'>;
     /**
-     * Body param: Carrier billing account number.
+     * Body param: Carrier billing account number charged when `carrier_billing_type`
+     * is `third_party`.
      */
     carrier_billing_account?: string;
     /**
-     * Body param: Carrier billing type.
+     * Body param: Who pays the carrier for shipments.
+     *
+     * - `sender`: the shipper (you) pays the carrier.
+     * - `third_party`: a third party is billed, using `carrier_billing_account`.
      */
     carrier_billing_type?: 'sender' | 'third_party';
     /**
-     * Body param: Commission policy.
+     * Body param: How sales commission applies to this customer's orders.
+     *
+     * - `commission_exempt`: this customer's orders are exempt from sales commission.
+     * - `commission_applied`: sales commission is calculated on this customer's
+     *   orders.
      */
     commission_policy?: 'commission_applied' | 'commission_exempt';
     /**
-     * Body param: QuantityInput represents a value with an associated unit for
-     * create/update requests.
+     * Body param: A value with an associated unit, used in create and update requests.
      */
     credit_limit?: QuantityInput;
     /**
-     * Body param: Price group IDs.
+     * Body param: IDs of the account groups of type `pricing_group` to assign to this
+     * customer, used to apply pricing rules.
      */
     customer_price_group_ids?: Array<string>;
     /**
-     * Body param: Default priority code.
+     * Body param: Priority applied to new orders for this customer.
      */
     default_priority?: 'low' | 'normal' | 'high';
     /**
@@ -1190,11 +1002,12 @@ export interface CustomerCreateParams {
      */
     default_sales_rep_id?: string;
     /**
-     * Body param: Default service level ID.
+     * Body param: ID of the default carrier service level.
      */
     default_service_level_id?: string;
     /**
-     * Body param: EDI status.
+     * Body param: Whether EDI (Electronic Data Interchange) is enabled for exchanging
+     * orders and documents with this customer.
      */
     edi_status?: 'enabled' | 'disabled';
     /**
@@ -1202,15 +1015,23 @@ export interface CustomerCreateParams {
      */
     email?: string;
     /**
-     * Body param: Freight policy.
+     * Body param: Whether this customer is billed for freight on their orders.
+     *
+     * - `free_freight`: the customer is not billed for freight.
+     * - `billed_freight`: freight is billed to the customer, unless overridden on the
+     *   order.
      */
     freight_policy?: 'free_freight' | 'billed_freight';
     /**
-     * Body param: Note.
+     * Body param: Free-form note about the customer.
      */
     note?: string;
     /**
-     * Body param: Customer number. Auto-generated if omitted.
+     * Body param: Human-readable customer number used to identify the account,
+     * distinct from the `id`.
+     *
+     * Must be unique within your account. If omitted, the next sequential number is
+     * assigned automatically.
      */
     number?: string;
     /**
@@ -1218,7 +1039,12 @@ export interface CustomerCreateParams {
      */
     phone?: string;
     /**
-     * Body param: Account status code.
+     * Body param: Account status code, controlling whether the customer can transact.
+     *
+     * - `normal`: standard active account with no restrictions.
+     * - `preferred`: active account flagged as preferred.
+     * - `hold_shipment`: orders can be placed, but shipments are held.
+     * - `hold_all`: all activity is on hold.
      */
     status?: 'normal' | 'preferred' | 'hold_shipment' | 'hold_all';
     /**
@@ -1226,50 +1052,54 @@ export interface CustomerCreateParams {
      */
     url?: string;
 }
-export interface CustomerRetrieveParams {
-    /**
-     * Sub-objects to expand in the response. When omitted, sub-objects are returned as
-     * `null`.
-     */
-    include?: Array<'bill_to_address' | 'ship_to_address' | 'type' | 'parent_account' | 'freight_preferences.carrier' | 'freight_preferences.service_level' | 'defaults.payment_term' | 'defaults.shipping_term' | 'defaults.sales_rep' | 'defaults.priority' | 'contact_info' | 'freight_preferences' | 'defaults' | 'notification_preferences' | 'price_groups' | 'child_accounts' | 'credit_limit'>;
-}
 export interface CustomerUpdateParams {
     /**
      * Query param: Sub-objects to expand in the response. When omitted, sub-objects
      * are returned as `null`.
      */
-    include?: Array<'bill_to_address' | 'ship_to_address' | 'type' | 'parent_account' | 'freight_preferences.carrier' | 'freight_preferences.service_level' | 'defaults.payment_term' | 'defaults.shipping_term' | 'defaults.sales_rep' | 'defaults.priority' | 'contact_info' | 'freight_preferences' | 'defaults' | 'notification_preferences' | 'price_groups' | 'child_accounts' | 'credit_limit'>;
+    include?: Array<'bill_to_address' | 'ship_to_address' | 'type' | 'parent_account' | 'freight_preferences.carrier' | 'freight_preferences.carrier.service_levels' | 'freight_preferences.service_level' | 'defaults.payment_term' | 'defaults.shipping_term' | 'defaults.sales_rep' | 'defaults.sales_rep.user' | 'defaults.priority' | 'contact_info' | 'freight_preferences' | 'defaults' | 'notification_preferences' | 'price_groups' | 'child_accounts' | 'credit_limit' | 'credit_limit.unit'>;
     /**
-     * Body param: Bill-to address ID.
+     * Body param: ID of an existing address to use as the default billing address.
      */
     bill_to_address_id?: string | null;
     /**
-     * Body param: Carrier billing account number.
+     * Body param: Carrier billing account number charged when `carrier_billing_type`
+     * is `third_party`.
      */
     carrier_billing_account?: string | null;
     /**
-     * Body param: Carrier billing type.
+     * Body param: Who pays the carrier for shipments.
+     *
+     * - `sender`: the shipper (you) pays the carrier.
+     * - `third_party`: a third party is billed, using `carrier_billing_account`.
      */
     carrier_billing_type?: 'sender' | 'third_party';
     /**
-     * Body param: Commission policy.
+     * Body param: How sales commission applies to this customer's orders.
+     *
+     * - `commission_exempt`: this customer's orders are exempt from sales commission.
+     * - `commission_applied`: sales commission is calculated on this customer's
+     *   orders.
      */
     commission_policy?: 'commission_applied' | 'commission_exempt';
     /**
-     * Body param: QuantityInput represents a value with an associated unit for
-     * create/update requests.
+     * Body param: A value with an associated unit, used in create and update requests.
      */
     credit_limit?: QuantityInput | null;
     /**
-     * Body param: Price group IDs. Replaces all existing price groups when provided.
+     * Body param: IDs of the account groups of type `pricing_group` to assign to this
+     * customer, used to apply pricing rules.
+     *
+     * When provided, replaces the customer's full set of existing price groups.
      */
     customer_price_group_ids?: Array<string>;
     /**
-     * Body param: Customer type group ID.
+     * Body param: ID of the account group of type `type_group` that categorizes this
+     * customer (for example "Distributors").
      */
     customer_type_group_id?: string;
     /**
-     * Body param: Default carrier ID.
+     * Body param: ID of the default carrier for this customer's shipments.
      */
     default_carrier_id?: string;
     /**
@@ -1277,7 +1107,7 @@ export interface CustomerUpdateParams {
      */
     default_payment_term_id?: string;
     /**
-     * Body param: Default priority code.
+     * Body param: Priority applied to new orders for this customer.
      */
     default_priority?: 'low' | 'normal' | 'high';
     /**
@@ -1285,7 +1115,7 @@ export interface CustomerUpdateParams {
      */
     default_sales_rep_id?: string | null;
     /**
-     * Body param: Default service level ID.
+     * Body param: ID of the default carrier service level.
      */
     default_service_level_id?: string | null;
     /**
@@ -1293,131 +1123,62 @@ export interface CustomerUpdateParams {
      */
     default_shipping_term_id?: string;
     /**
-     * Body param: EDI status.
+     * Body param: Whether EDI (Electronic Data Interchange) is enabled for exchanging
+     * orders and documents with this customer.
      */
     edi_status?: 'enabled' | 'disabled';
     /**
-     * Body param: Email address. Send null to clear.
+     * Body param: Email address.
      */
     email?: string | null;
     /**
-     * Body param: Freight policy.
+     * Body param: Whether this customer is billed for freight on their orders.
+     *
+     * - `free_freight`: the customer is not billed for freight.
+     * - `billed_freight`: freight is billed to the customer, unless overridden on the
+     *   order.
      */
     freight_policy?: 'free_freight' | 'billed_freight';
     /**
-     * Body param: Customer name.
+     * Body param: The customer's business name, as shown throughout the app and on
+     * documents.
      */
     name?: string;
     /**
-     * Body param: Note.
+     * Body param: Free-form note about the customer.
      */
     note?: string | null;
     /**
-     * Body param: Customer number.
+     * Body param: Human-readable customer number used to identify the account,
+     * distinct from the `id`.
+     *
+     * Must be unique within your account.
      */
     number?: string;
     /**
-     * Body param: Phone number. Send null to clear.
+     * Body param: Phone number.
      */
     phone?: string | null;
     /**
-     * Body param: Ship-to address ID.
+     * Body param: ID of an existing address to use as the default shipping address.
      */
     ship_to_address_id?: string | null;
     /**
-     * Body param: Account status code.
+     * Body param: Account status code, controlling whether the customer can transact.
+     *
+     * - `normal`: standard active account with no restrictions.
+     * - `preferred`: active account flagged as preferred.
+     * - `hold_shipment`: orders can be placed, but shipments are held.
+     * - `hold_all`: all activity is on hold.
      */
     status?: 'normal' | 'preferred' | 'hold_shipment' | 'hold_all';
     /**
-     * Body param: Website URL. Send null to clear.
+     * Body param: Website URL.
      */
     url?: string | null;
 }
-export interface CustomerListParams {
-    /**
-     * Filter by carrier IDs.
-     */
-    carrier_ids?: Array<string>;
-    /**
-     * Filter by city.
-     */
-    city?: string;
-    /**
-     * Filter by commission status codes.
-     */
-    commission_status_codes?: Array<'commission_applied' | 'commission_exempt'>;
-    /**
-     * Cursor token used to retrieve the next or previous page of results.
-     */
-    cursor?: string;
-    /**
-     * Filter by customer group IDs.
-     */
-    customer_group_ids?: Array<string>;
-    /**
-     * Filter by end date (created before).
-     */
-    end_date?: string;
-    /**
-     * Filter by freight status codes.
-     */
-    freight_status_codes?: Array<'free_freight' | 'billed_freight'>;
-    /**
-     * Sub-objects to expand in the response. When omitted, sub-objects are returned as
-     * `null`.
-     */
-    include?: Array<'bill_to_address' | 'ship_to_address' | 'type' | 'parent_account' | 'freight_preferences.carrier' | 'freight_preferences.service_level' | 'defaults.payment_term' | 'defaults.shipping_term' | 'defaults.sales_rep' | 'defaults.priority' | 'contact_info' | 'freight_preferences' | 'defaults' | 'notification_preferences' | 'price_groups' | 'child_accounts' | 'credit_limit'>;
-    /**
-     * Maximum number of results per page (default: 100, max: 1000).
-     */
-    limit?: number;
-    /**
-     * Filter by whether the customer has child accounts.
-     */
-    parent_account_status?: 'parent' | 'non_parent';
-    /**
-     * Filter by payment term IDs.
-     */
-    payment_term_ids?: Array<string>;
-    /**
-     * Filter by postal code.
-     */
-    postal_code?: string;
-    /**
-     * Filter by pricing group IDs.
-     */
-    pricing_group_ids?: Array<string>;
-    /**
-     * Search query used to filter results.
-     */
-    q?: string;
-    /**
-     * Filter by sales rep IDs.
-     */
-    sales_rep_ids?: Array<string>;
-    /**
-     * Filter by service level IDs.
-     */
-    service_level_ids?: Array<string>;
-    /**
-     * Filter by shipping term IDs.
-     */
-    shipping_term_ids?: Array<string>;
-    /**
-     * Filter by start date (created after).
-     */
-    start_date?: string;
-    /**
-     * Filter by state.
-     */
-    state?: string;
-    /**
-     * Filter by status codes.
-     */
-    status_codes?: Array<'normal' | 'preferred' | 'hold_shipment' | 'hold_all'>;
-}
 export declare namespace Customers {
-    export { type AccountUser as AccountUser, type Carrier as Carrier, type Consumption as Consumption, type CreateCustomerRequest as CreateCustomerRequest, type Customer as Customer, type CustomerContactInfo as CustomerContactInfo, type CustomerDefaults as CustomerDefaults, type CustomerFreightPreferences as CustomerFreightPreferences, type CustomerNotificationPreferences as CustomerNotificationPreferences, type Department as Department, type ListConsumption as ListConsumption, type ListCustomer as ListCustomer, type ListLocation as ListLocation, type ListMachine as ListMachine, type ListProductionStep as ListProductionStep, type ListScanningStation as ListScanningStation, type ListServiceLevel as ListServiceLevel, type Location as Location, type Machine as Machine, type PaymentTerm as PaymentTerm, type ProductionOutput as ProductionOutput, type ProductionStep as ProductionStep, type QuantityInput as QuantityInput, type ScanningStation as ScanningStation, type ServiceLevel as ServiceLevel, type ShippingTerm as ShippingTerm, type UpdateCustomerRequest as UpdateCustomerRequest, type CustomerDeleteResponse as CustomerDeleteResponse, type CustomerCreateParams as CustomerCreateParams, type CustomerRetrieveParams as CustomerRetrieveParams, type CustomerUpdateParams as CustomerUpdateParams, type CustomerListParams as CustomerListParams, };
+    export { type Carrier as Carrier, type CreateCustomerRequest as CreateCustomerRequest, type Customer as Customer, type CustomerContactInfo as CustomerContactInfo, type CustomerDefaults as CustomerDefaults, type CustomerFreightPreferences as CustomerFreightPreferences, type CustomerNotificationPreferences as CustomerNotificationPreferences, type ListCustomer as ListCustomer, type ListServiceLevel as ListServiceLevel, type PaymentTerm as PaymentTerm, type QuantityInput as QuantityInput, type ServiceLevel as ServiceLevel, type ShippingTerm as ShippingTerm, type UpdateCustomerRequest as UpdateCustomerRequest, type CustomerDeleteResponse as CustomerDeleteResponse, type CustomerListParams as CustomerListParams, type CustomerRetrieveParams as CustomerRetrieveParams, type CustomerCreateParams as CustomerCreateParams, type CustomerUpdateParams as CustomerUpdateParams, };
     export { Actions as Actions, type MergeCustomersRequest as MergeCustomersRequest, type ActionMergeParams as ActionMergeParams, };
 }
 //# sourceMappingURL=customers.d.mts.map