@augno/sdk 0.1.9 → 0.7.0

package/resources/sales/customers/customers.d.ts

@@ -14,25 +14,14 @@ import { RequestOptions } from "../../../internal/request-options.js";
 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.
      *
      * @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.
      *
@@ -45,29 +34,68 @@ 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.
      *
      * @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.
      *
      * @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.
      *
      * @example
      * ```ts
@@ -79,7 +107,11 @@ export declare class Customers extends APIResource {
     delete(id: string, options?: RequestOptions): APIPromise<CustomerDeleteResponse>;
 }
 /**
- * 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.
  */
 export interface AccountUser {
     /**
@@ -91,35 +123,29 @@ export interface AccountUser {
      */
     created_at: string;
     /**
-     * Department resource.
+     * A functional area of a production operation, such as fabrication or packaging,
+     * that groups scanning stations and machines.
      */
     department: Department | null;
     /**
-     * Email address.
-     */
-    email: string | null;
-    /**
-     * Profile image URL.
-     */
-    image_url: string | null;
-    /**
-     * When the user last used this account.
+     * When the user last accessed this account.
      */
     last_used_at: string | null;
-    /**
-     * Display name.
-     */
-    name: string | null;
     /**
      * Resource type identifier.
      */
     object: 'account_user';
     /**
-     * Role resource.
+     * A named set of permissions that can be assigned to users to control what they
+     * can access.
      */
     role: APIKeysAPI.Role | null;
     /**
      * Account user status.
+     *
+     * - `active`: the user can access the account.
+     * - `disabled`: the user is locked out of the account.
+     * - `removed`: the user has been removed (soft-deleted) from the account.
      */
     status: 'active' | 'disabled' | 'removed';
     /**
@@ -127,16 +153,19 @@ export interface AccountUser {
      */
     updated_at: string;
     /**
-     * Underlying user ID.
-     */
-    user_id: string;
-    /**
-     * Username.
+     * A user's global profile, shared across every account they belong to.
+     *
+     * Account-specific settings (status, role, department) live on the account user
+     * resource that links the user to each account.
      */
-    username: string | null;
+    user: User | 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 +173,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 +193,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 +202,7 @@ export interface Carrier {
      */
     deleted_at: string | null;
     /**
-     * Display name.
+     * Human-readable name for the carrier, unique among your account's carriers.
      */
     name: string;
     /**
@@ -186,6 +224,10 @@ export interface Carrier {
 }
 /**
  * Material consumed by a production step.
+ *
+ * Each consumption records one input item and how much of it the step uses.
+ * Consumptions also determine the production flow: when another step produces the
+ * consumed item, the two steps are linked upstream/downstream automatically.
  */
 export interface Consumption {
     /**
@@ -226,15 +268,17 @@ export interface Consumption {
  */
 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 +290,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 +336,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 +349,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 +373,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 +387,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 +396,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 +405,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 +429,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 +438,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 +450,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 +459,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 +468,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 +529,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;
     /**
-     * ShippingTerm resource.
+     * A shipping term defining how freight charges are calculated for an order.
      */
     shipping_term: ShippingTerm | null;
 }
@@ -463,15 +555,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 +582,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';
 }
@@ -501,7 +604,8 @@ export interface CustomerNotificationPreferences {
     object: 'customer_notification_preferences';
 }
 /**
- * Department resource.
+ * A functional area of a production operation, such as fabrication or packaging,
+ * that groups scanning stations and machines.
  */
 export interface Department {
     /**
@@ -513,7 +617,8 @@ export interface Department {
      */
     created_at: string;
     /**
-     * Location resource.
+     * A physical storage location, such as a warehouse, aisle, or bin, arranged in a
+     * parent-child hierarchy.
      */
     location: Location | null;
     /**
@@ -521,11 +626,13 @@ export interface Department {
      */
     machines: ListMachine | null;
     /**
-     * Display name.
+     * Display name of the department.
+     *
+     * Unique within the account.
      */
     name: string;
     /**
-     * Notes about the department.
+     * Free-form notes about the department.
      */
     notes: string | null;
     /**
@@ -661,7 +768,8 @@ export interface ListServiceLevel {
     page_info: APIKeysAPI.PageInfo;
 }
 /**
- * Location resource.
+ * A physical storage location, such as a warehouse, aisle, or bin, arranged in a
+ * parent-child hierarchy.
  */
 export interface Location {
     /**
@@ -677,7 +785,7 @@ export interface Location {
      */
     created_at: string;
     /**
-     * Display name.
+     * Display name of the location.
      */
     name: string;
     /**
@@ -685,20 +793,30 @@ export interface Location {
      */
     object: 'location';
     /**
-     * Location resource.
+     * A physical storage location, such as a warehouse, aisle, or bin, arranged in a
+     * parent-child hierarchy.
      */
     parent: Location | null;
     /**
-     * Location type code.
+     * Location type code, identifying this location's level in the storage hierarchy.
+     *
+     * - `building`: a building-level location.
+     * - `section`: a section within a building.
+     * - `aisle`: an aisle within a section.
+     * - `rack`: a rack within an aisle.
+     * - `shelf`: a shelf within a rack.
+     * - `bin`: a bin within a shelf.
      */
-    type: 'building' | 'section' | 'aisle' | 'rack' | 'shelf' | 'bin';
+    type: LocationTypeCode;
     /**
      * Last-updated timestamp.
      */
     updated_at: string;
 }
+export type LocationTypeCode = 'building' | 'section' | 'aisle' | 'rack' | 'shelf' | 'bin';
 /**
- * Machine within an account.
+ * A piece of production equipment, such as a CNC router or press, assigned to a
+ * department.
  */
 export interface Machine {
     /**
@@ -710,15 +828,18 @@ export interface Machine {
      */
     created_at: string;
     /**
-     * Department resource.
+     * A functional area of a production operation, such as fabrication or packaging,
+     * that groups scanning stations and machines.
      */
     department: Department | null;
     /**
-     * Display name.
+     * Display name of the machine.
+     *
+     * Unique within the account.
      */
     name: string;
     /**
-     * Notes.
+     * Free-form notes about the machine.
      */
     notes: string | null;
     /**
@@ -726,7 +847,7 @@ export interface Machine {
      */
     object: 'machine';
     /**
-     * Serial number.
+     * Serial number of the machine.
      */
     serial_number: string;
     /**
@@ -735,7 +856,8 @@ export interface Machine {
     updated_at: string;
 }
 /**
- * Payment term resource.
+ * A payment term describing when payment is due (e.g. `Net 30`), assignable to
+ * customers, sales orders, purchase orders, and invoices.
  */
 export interface PaymentTerm {
     /**
@@ -747,7 +869,7 @@ export interface PaymentTerm {
      */
     created_at: string;
     /**
-     * Display name.
+     * Display name (e.g. `Net 30`).
      */
     name: string;
     /**
@@ -759,7 +881,7 @@ export interface PaymentTerm {
      */
     owner: APIKeysAPI.Owner | null;
     /**
-     * Payment term status.
+     * Lifecycle status of the payment term.
      */
     status: 'active' | 'inactive';
     /**
@@ -768,7 +890,7 @@ export interface PaymentTerm {
     updated_at: string;
 }
 /**
- * Production output of a production step.
+ * The output of a production step: the item it produces and the quantity produced.
  */
 export interface ProductionOutput {
     /**
@@ -797,7 +919,8 @@ export interface ProductionOutput {
     updated_at: string;
 }
 /**
- * Production step with all nested data.
+ * A single stage of work in an item's production flow, with its output, material
+ * inputs, cost rates, and graph connections.
  */
 export interface ProductionStep {
     /**
@@ -805,7 +928,11 @@ export interface ProductionStep {
      */
     id: string;
     /**
-     * Allowances as a decimal string.
+     * Allowance correction factor applied to labor time in cost calculations, as a
+     * decimal string.
+     *
+     * Effective labor time per unit is
+     * `labor_time × (1 + leveling_factor) × (1 + allowances)`.
      */
     allowances: string;
     /**
@@ -817,7 +944,8 @@ export interface ProductionStep {
      */
     created_at: string;
     /**
-     * Department resource.
+     * A functional area of a production operation, such as fabrication or packaging,
+     * that groups scanning stations and machines.
      */
     department: Department | null;
     /**
@@ -825,15 +953,21 @@ export interface ProductionStep {
      */
     in_steps: ListProductionStep | null;
     /**
-     * Rate resource.
+     * Value expressed as a ratio of two units, such as a price per kilogram or a
+     * throughput per hour.
      */
     labor_rate: ItemsAPI.Rate | null;
     /**
-     * Rate resource.
+     * Value expressed as a ratio of two units, such as a price per kilogram or a
+     * throughput per hour.
      */
     labor_time: ItemsAPI.Rate | null;
     /**
-     * Leveling factor as a decimal string.
+     * Leveling correction factor applied to labor time in cost calculations, as a
+     * decimal string.
+     *
+     * Effective labor time per unit is
+     * `labor_time × (1 + leveling_factor) × (1 + allowances)`.
      */
     leveling_factor: string;
     /**
@@ -841,11 +975,11 @@ export interface ProductionStep {
      */
     machines: ListMachine | null;
     /**
-     * Display name.
+     * Display name of the step.
      */
     name: string;
     /**
-     * Notes.
+     * Free-form notes about the step.
      */
     notes: string | null;
     /**
@@ -857,15 +991,17 @@ export interface ProductionStep {
      */
     out_steps: ListProductionStep | null;
     /**
-     * Rate resource.
+     * Value expressed as a ratio of two units, such as a price per kilogram or a
+     * throughput per hour.
      */
     overhead_rate: ItemsAPI.Rate | null;
     /**
-     * Production output of a production step.
+     * The output of a production step: the item it produces and the quantity produced.
      */
     production: ProductionOutput | null;
     /**
-     * Scanning station resource.
+     * A station on the production floor where operators scan batches to perform a
+     * batch operation, such as initializing or moving a batch.
      */
     scanning_station: ScanningStation | null;
     /**
@@ -874,21 +1010,21 @@ export interface ProductionStep {
     updated_at: string;
 }
 /**
- * QuantityInput represents a value with an associated unit for create/update
- * requests.
+ * A value with an associated unit, used in create and update requests.
  */
 export interface QuantityInput {
     /**
-     * The unit ID for the value.
+     * ID of the unit of measure for the value.
      */
     unit_id: string;
     /**
-     * The decimal value.
+     * Decimal value, as a string to preserve precision.
      */
     value: string;
 }
 /**
- * Scanning station resource.
+ * A station on the production floor where operators scan batches to perform a
+ * batch operation, such as initializing or moving a batch.
  */
 export interface ScanningStation {
     /**
@@ -900,23 +1036,31 @@ export interface ScanningStation {
      */
     created_at: string;
     /**
-     * Department resource.
+     * A functional area of a production operation, such as fabrication or packaging,
+     * that groups scanning stations and machines.
      */
     department: Department | null;
     /**
-     * Label size code.
+     * Size of the labels printed at this station, given as width-by-height (for
+     * example, `1x1`).
      */
     label_size: '1x1' | '1x3' | '1x4' | '2x4' | null;
     /**
-     * Label type code.
+     * Type of label printed at this station.
+     *
+     * - `tag`: a label attached to the physical product.
+     * - `traveler`: a routing sheet that accompanies the batch through every
+     *   production step.
      */
     label_type: 'tag' | 'traveler' | null;
     /**
-     * Display name.
+     * Display name of the scanning station.
+     *
+     * Unique within the account.
      */
     name: string;
     /**
-     * Notes.
+     * Free-form notes about the scanning station.
      */
     notes: string | null;
     /**
@@ -924,7 +1068,10 @@ export interface ScanningStation {
      */
     object: 'scanning_station';
     /**
-     * Operator requirement behavior for this station.
+     * Whether operators must perform a material check at this station.
+     *
+     * - `none`: no additional operator check is required.
+     * - `material_check`: a material check is expected before the operation.
      */
     operator_requirement: 'none' | 'material_check';
     /**
@@ -932,7 +1079,12 @@ export interface ScanningStation {
      */
     production_steps: ListProductionStep | null;
     /**
-     * Scanning station type.
+     * Scanning station type, determining which batch operation the station performs.
+     *
+     * - `init_batch`: initializes a new batch.
+     * - `merge_batch`: merges multiple batches into one.
+     * - `move_batch`: moves a batch to another location or step.
+     * - `split_batch`: splits a batch into multiple batches.
      */
     type: 'init_batch' | 'merge_batch' | 'move_batch' | 'split_batch';
     /**
@@ -953,15 +1105,21 @@ export interface ServiceLevel {
      */
     created_at: string;
     /**
-     * Customer portal visibility.
+     * Whether customers can see and select this service level at checkout in the
+     * customer portal.
      */
     customer_portal_visibility: 'visible' | 'hidden';
     /**
-     * Default service level for the carrier.
+     * 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;
     /**
-     * Display name.
+     * Human-readable name for the service level, shown to customers at checkout when
+     * the service level is visible.
      */
     name: string;
     /**
@@ -973,7 +1131,10 @@ export interface ServiceLevel {
      */
     owner: APIKeysAPI.Owner | null;
     /**
-     * Service level token.
+     * 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.
      */
     service_level_token: string;
     /**
@@ -982,7 +1143,7 @@ export interface ServiceLevel {
     updated_at: string;
 }
 /**
- * ShippingTerm resource.
+ * A shipping term defining how freight charges are calculated for an order.
  */
 export interface ShippingTerm {
     /**
@@ -1006,7 +1167,8 @@ export interface ShippingTerm {
      */
     minimum_order_value: ItemsAPI.Quantity | null;
     /**
-     * Display name.
+     * Human-readable name for the shipping term, used to identify it when assigning
+     * shipping terms to customers and orders.
      */
     name: string;
     /**
@@ -1018,7 +1180,13 @@ export interface ShippingTerm {
      */
     owner: APIKeysAPI.Owner | null;
     /**
-     * Shipping term type.
+     * 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.
      */
     type: 'free_freight' | 'flat_rate_freight' | 'carrier_rate_freight';
     /**
@@ -1031,36 +1199,47 @@ export interface ShippingTerm {
  */
 export interface UpdateCustomerRequest {
     /**
-     * Bill-to address ID.
+     * ID of an existing address to use as the default billing address.
      */
     bill_to_address_id?: string | null;
     /**
-     * Carrier billing account number.
+     * Carrier billing account number charged when `carrier_billing_type` is
+     * `third_party`.
      */
     carrier_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 `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 | null;
     /**
-     * Price group IDs. Replaces all existing price groups when provided.
+     * 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>;
     /**
-     * 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;
     /**
@@ -1068,7 +1247,7 @@ export interface UpdateCustomerRequest {
      */
     default_payment_term_id?: string;
     /**
-     * Default priority code.
+     * Priority applied to new orders for this customer.
      */
     default_priority?: 'low' | 'normal' | 'high';
     /**
@@ -1076,7 +1255,7 @@ export interface UpdateCustomerRequest {
      */
     default_sales_rep_id?: string | null;
     /**
-     * Default service level ID.
+     * ID of the default carrier service level.
      */
     default_service_level_id?: string | null;
     /**
@@ -1084,59 +1263,218 @@ export interface UpdateCustomerRequest {
      */
     default_shipping_term_id?: string;
     /**
-     * EDI status.
+     * Whether EDI (Electronic Data Interchange) is enabled for exchanging orders and
+     * documents with this customer.
      */
     edi_status?: 'enabled' | 'disabled';
     /**
-     * Email address. Send null to clear.
+     * Email address.
      */
     email?: string | null;
     /**
-     * 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';
     /**
-     * Customer 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;
     /**
-     * Customer number.
+     * Human-readable customer number used to identify the account, distinct from the
+     * `id`.
+     *
+     * Must be unique within your account.
      */
     number?: string;
     /**
-     * Phone number. Send null to clear.
+     * Phone number.
      */
     phone?: string | null;
     /**
-     * Ship-to address ID.
+     * ID of an existing address to use as the default shipping address.
      */
     ship_to_address_id?: string | 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';
     /**
-     * Website URL. Send null to clear.
+     * Website URL.
      */
     url?: string | null;
 }
+/**
+ * A user's global profile, shared across every account they belong to.
+ *
+ * Account-specific settings (status, role, department) live on the account user
+ * resource that links the user to each account.
+ */
+export interface User {
+    /**
+     * User ID.
+     */
+    id: string;
+    /**
+     * Creation timestamp.
+     */
+    created_at: string;
+    /**
+     * Email address.
+     */
+    email: string | null;
+    /**
+     * When the user verified their email address.
+     */
+    email_verified_at: string | null;
+    /**
+     * URL of the user's profile image.
+     */
+    image_url: string | null;
+    /**
+     * User's full display name.
+     */
+    name: string | null;
+    /**
+     * Resource type identifier.
+     */
+    object: 'user';
+    /**
+     * Last updated timestamp.
+     */
+    updated_at: string;
+    /**
+     * Username.
+     */
+    username: string | null;
+}
 export interface CustomerDeleteResponse {
 }
+export interface CustomerListParams {
+    /**
+     * Filter by default carrier IDs.
+     */
+    carrier_ids?: Array<string>;
+    /**
+     * 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.
+     */
+    city?: string;
+    /**
+     * Filter by commission policy.
+     */
+    commission_status_codes?: Array<'commission_applied' | 'commission_exempt'>;
+    /**
+     * Opaque cursor token identifying where the page of results starts.
+     *
+     * Use the `cursor` value embedded in a previous response's `next_page_url` or
+     * `previous_page_url` to fetch the adjacent page. Omit to start from the first
+     * page.
+     */
+    cursor?: string;
+    /**
+     * Filter by customer type group IDs (the account group of type `type_group`
+     * returned in the customer's `type` field).
+     */
+    customer_group_ids?: Array<string>;
+    /**
+     * Filter to customers created at or before this timestamp (inclusive).
+     */
+    end_date?: string;
+    /**
+     * Filter by freight policy.
+     */
+    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.sales_rep.user' | 'defaults.priority' | 'contact_info' | 'freight_preferences' | 'defaults' | 'notification_preferences' | 'price_groups' | 'child_accounts' | 'credit_limit'>;
+    /**
+     * Maximum number of results to return in a single page.
+     */
+    limit?: number;
+    /**
+     * Filter by whether the customer has child accounts.
+     */
+    parent_account_status?: 'parent' | 'non_parent';
+    /**
+     * Filter by default payment term IDs.
+     */
+    payment_term_ids?: Array<string>;
+    /**
+     * Filter to customers with any address in this postal code (exact match).
+     */
+    postal_code?: string;
+    /**
+     * Filter to customers that belong to any of these pricing groups.
+     */
+    pricing_group_ids?: Array<string>;
+    /**
+     * Free-text search term used to filter results.
+     *
+     * Which fields are matched against the term varies by endpoint.
+     */
+    q?: string;
+    /**
+     * Filter by default sales rep IDs.
+     */
+    sales_rep_ids?: Array<string>;
+    /**
+     * Filter by default service level IDs.
+     */
+    service_level_ids?: Array<string>;
+    /**
+     * Filter by default shipping term IDs.
+     */
+    shipping_term_ids?: Array<string>;
+    /**
+     * Filter to customers created at or after this timestamp (inclusive).
+     */
+    start_date?: string;
+    /**
+     * Filter to customers with any address in this state (exact match).
+     */
+    state?: string;
+    /**
+     * Filter by account status codes.
+     */
+    status_codes?: Array<'normal' | 'preferred' | 'hold_shipment' | 'hold_all'>;
+}
+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.sales_rep.user' | 'defaults.priority' | 'contact_info' | 'freight_preferences' | 'defaults' | 'notification_preferences' | 'price_groups' | 'child_accounts' | 'credit_limit'>;
+}
 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 +1486,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.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'>;
     /**
-     * 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 +1538,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 +1551,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 +1575,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 +1588,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.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'>;
     /**
-     * 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 +1643,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 +1651,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 +1659,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 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 LocationTypeCode as LocationTypeCode, 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 User as User, 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.ts.map