@augno/sdk 0.1.9 → 0.7.1

package/src/resources/sales/customers/customers.ts

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../../core/resource';
+import * as BlocksAPI from '../../messaging/blocks';
 import * as AccountGroupsAPI from '../account-groups';
 import * as AddressesAPI from '../addresses';
 import * as PrioritiesAPI from '../priorities';
@@ -19,32 +20,27 @@ export class Customers extends APIResource {
   actions: ActionsAPI.Actions = new ActionsAPI.Actions(this._client);
 
   /**
-   * 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> {
-    const { include, ...body } = params;
-    return this._client.post('/v1/sales/customers', { query: { include }, body, ...options });
+  list(
+    query: CustomerListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ListCustomer> {
+    return this._client.get('/v1/sales/customers', { query, ...options });
   }
 
   /**
    * Returns a customer by ID.
    *
+   * This endpoint requires the permissions: `customers:read`, `suppliers:read`.
+   *
    * @example
    * ```ts
    * const customer = await client.sales.customers.retrieve(
@@ -61,13 +57,67 @@ export class Customers extends APIResource {
   }
 
   /**
-   * 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.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',
+   * });
+   * ```
+   */
+  create(params: CustomerCreateParams, options?: RequestOptions): APIPromise<Customer> {
+    const { include, ...body } = params;
+    return this._client.post('/v1/sales/customers', { query: { include }, body, ...options });
+  }
+
+  /**
+   * 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 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',
+   *   },
    * );
    * ```
    */
@@ -81,23 +131,12 @@ export class Customers extends APIResource {
   }
 
   /**
-   * Returns a paginated list of customers for the current account.
+   * Deletes a customer.
    *
-   * @example
-   * ```ts
-   * const listCustomer = await client.sales.customers.list();
-   * ```
-   */
-  list(
-    query: CustomerListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<ListCustomer> {
-    return this._client.get('/v1/sales/customers', { query, ...options });
-  }
-
-  /**
-   * Deletes a customer and associated account relations, addresses, and account
-   * users.
+   * 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
@@ -112,77 +151,11 @@ export class Customers extends APIResource {
 }
 
 /**
- * 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 {
   /**
@@ -191,12 +164,20 @@ 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;
 
@@ -206,7 +187,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';
 
@@ -216,7 +198,7 @@ export interface Carrier {
   deleted_at: string | null;
 
   /**
-   * Display name.
+   * Human-readable name for the carrier, unique among your account's carriers.
    */
   name: string;
 
@@ -241,67 +223,24 @@ 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;
 
@@ -316,43 +255,52 @@ 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';
 
@@ -362,12 +310,13 @@ 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';
 
@@ -377,17 +326,25 @@ 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;
 
@@ -397,7 +354,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';
 
@@ -408,7 +370,8 @@ export interface CreateCustomerRequest {
 }
 
 /**
- * Customer account.
+ * A business you sell to, with its contact details, default fulfillment settings,
+ * and order policies.
  */
 export interface Customer {
   /**
@@ -417,7 +380,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;
 
@@ -427,7 +391,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';
 
@@ -452,7 +420,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';
 
@@ -462,12 +431,12 @@ 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;
 
@@ -477,7 +446,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;
 
@@ -487,7 +457,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;
 
@@ -497,22 +468,33 @@ 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;
 
@@ -557,22 +539,27 @@ 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;
 }
@@ -582,17 +569,24 @@ 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;
 
@@ -607,7 +601,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';
 }
@@ -628,63 +626,33 @@ export interface CustomerNotificationPreferences {
 }
 
 /**
- * Department resource.
+ * List represents a paginated list of resources.
  */
-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;
-
+export interface ListCustomer {
   /**
-   * Notes about the department.
+   * Resources in this page.
    */
-  notes: string | null;
+  data: Array<Customer>;
 
   /**
    * Resource type identifier.
    */
-  object: 'department';
-
-  /**
-   * List represents a paginated list of resources.
-   */
-  scanning_stations: ListScanningStation | null;
+  object: 'list';
 
   /**
-   * Last update timestamp.
+   * PageInfo contains URL-based pagination metadata.
    */
-  updated_at: string;
+  page_info: APIKeysAPI.PageInfo;
 }
 
 /**
  * List represents a paginated list of resources.
  */
-export interface ListConsumption {
+export interface ListServiceLevel {
   /**
    * Resources in this page.
    */
-  data: Array<Consumption>;
+  data: Array<ServiceLevel>;
 
   /**
    * Resource type identifier.
@@ -698,238 +666,100 @@ export interface ListConsumption {
 }
 
 /**
- * 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 ListCustomer {
+export interface PaymentTerm {
   /**
-   * Resources in this page.
+   * Payment term ID.
    */
-  data: Array<Customer>;
+  id: string;
 
   /**
-   * Resource type identifier.
+   * Creation timestamp.
    */
-  object: 'list';
+  created_at: string;
 
   /**
-   * PageInfo contains URL-based pagination metadata.
+   * Display name (e.g. `Net 30`).
    */
-  page_info: APIKeysAPI.PageInfo;
-}
+  name: string;
 
-/**
- * List represents a paginated list of resources.
- */
-export interface ListLocation {
   /**
-   * Resources in this page.
+   * Resource type identifier.
    */
-  data: Array<Location>;
+  object: 'payment_term';
 
   /**
-   * Resource type identifier.
+   * Owner describes the provenance of a resource.
    */
-  object: 'list';
+  owner: APIKeysAPI.Owner | null;
 
   /**
-   * PageInfo contains URL-based pagination metadata.
+   * Lifecycle status of the payment term.
    */
-  page_info: APIKeysAPI.PageInfo;
-}
+  status: 'active' | 'inactive';
 
-/**
- * List represents a paginated list of resources.
- */
-export interface ListMachine {
   /**
-   * Resources in this page.
+   * Last-updated timestamp.
    */
-  data: Array<Machine>;
+  updated_at: string;
+}
 
+/**
+ * A value with an associated unit, used in create and update requests.
+ */
+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;
 }
 
 /**
- * List represents a paginated list of resources.
+ * Shipping service level for a carrier.
  */
-export interface ListProductionStep {
+export interface ServiceLevel {
   /**
-   * Resources in this page.
+   * Service level ID.
    */
-  data: Array<ProductionStep>;
+  id: string;
 
   /**
-   * Resource type identifier.
+   * Creation timestamp.
    */
-  object: 'list';
+  created_at: string;
 
   /**
-   * PageInfo contains URL-based pagination metadata.
+   * Whether customers can see and select this service level at checkout in the
+   * customer portal.
    */
-  page_info: APIKeysAPI.PageInfo;
-}
+  customer_portal_visibility: 'visible' | 'hidden';
 
-/**
- * List represents a paginated list of resources.
- */
-export interface ListScanningStation {
   /**
-   * Resources in this page.
+   * 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.
    */
-  data: Array<ScanningStation>;
+  is_default: boolean;
 
   /**
-   * Resource type identifier.
-   */
-  object: 'list';
-
-  /**
-   * PageInfo contains URL-based pagination metadata.
-   */
-  page_info: APIKeysAPI.PageInfo;
-}
-
-/**
- * List represents a paginated list of resources.
- */
-export interface ListServiceLevel {
-  /**
-   * Resources in this page.
-   */
-  data: Array<ServiceLevel>;
-
-  /**
-   * Resource type identifier.
-   */
-  object: 'list';
-
-  /**
-   * PageInfo contains URL-based pagination metadata.
-   */
-  page_info: APIKeysAPI.PageInfo;
-}
-
-/**
- * Location resource.
- */
-export interface Location {
-  /**
-   * Location ID.
-   */
-  id: string;
-
-  /**
-   * List represents a paginated list of resources.
-   */
-  children: ListLocation | null;
-
-  /**
-   * Creation timestamp.
-   */
-  created_at: string;
-
-  /**
-   * Display name.
-   */
-  name: string;
-
-  /**
-   * Resource type identifier.
-   */
-  object: 'location';
-
-  /**
-   * Location resource.
-   */
-  parent: Location | null;
-
-  /**
-   * Location type code.
-   */
-  type: 'building' | 'section' | 'aisle' | 'rack' | 'shelf' | 'bin';
-
-  /**
-   * Last-updated timestamp.
-   */
-  updated_at: string;
-}
-
-/**
- * Machine within an account.
- */
-export interface Machine {
-  /**
-   * Machine ID.
-   */
-  id: string;
-
-  /**
-   * Creation timestamp.
-   */
-  created_at: string;
-
-  /**
-   * Department resource.
-   */
-  department: Department | null;
-
-  /**
-   * Display name.
-   */
-  name: string;
-
-  /**
-   * Notes.
-   */
-  notes: string | null;
-
-  /**
-   * Resource type identifier.
-   */
-  object: 'machine';
-
-  /**
-   * Serial number.
-   */
-  serial_number: string;
-
-  /**
-   * Last updated timestamp.
-   */
-  updated_at: string;
-}
-
-/**
- * Payment term resource.
- */
-export interface PaymentTerm {
-  /**
-   * Payment term ID.
-   */
-  id: string;
-
-  /**
-   * Creation timestamp.
-   */
-  created_at: string;
-
-  /**
-   * Display name.
+   * Human-readable name for the service level, shown to customers at checkout when
+   * the service level is visible.
    */
   name: string;
 
   /**
    * Resource type identifier.
    */
-  object: 'payment_term';
+  object: 'service_level';
 
   /**
    * Owner describes the provenance of a resource.
@@ -937,44 +767,12 @@ export interface PaymentTerm {
   owner: APIKeysAPI.Owner | null;
 
   /**
-   * Payment term status.
-   */
-  status: 'active' | 'inactive';
-
-  /**
-   * Last-updated timestamp.
-   */
-  updated_at: string;
-}
-
-/**
- * Production output of a production step.
- */
-export interface ProductionOutput {
-  /**
-   * Production ID.
-   */
-  id: string;
-
-  /**
-   * Creation timestamp.
-   */
-  created_at: string;
-
-  /**
-   * Resource type identifier.
-   */
-  object: 'production';
-
-  /**
-   * Item is an inventory item (product, material, or part).
-   */
-  produced_item: ItemsAPI.Item | null;
-
-  /**
-   * Value with an associated unit.
+   * 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.
    */
-  quantity: ItemsAPI.Quantity | null;
+  service_level_token: string;
 
   /**
    * Last updated timestamp.
@@ -983,422 +781,392 @@ export interface ProductionOutput {
 }
 
 /**
- * Production step with all nested data.
+ * A shipping term defining how freight charges are calculated for an order.
  */
-export interface ProductionStep {
+export interface ShippingTerm {
   /**
-   * Production step ID.
+   * Shipping term ID.
    */
   id: string;
 
   /**
-   * Allowances as a decimal string.
-   */
-  allowances: string;
-
-  /**
-   * List represents a paginated list of resources.
-   */
-  consumptions: ListConsumption | null;
-
-  /**
-   * Creation timestamp.
+   * When this shipping term was created.
    */
   created_at: string;
 
   /**
-   * Department resource.
+   * Value with an associated unit.
    */
-  department: Department | null;
+  flat_rate: ItemsAPI.Quantity | null;
 
   /**
    * List represents a paginated list of resources.
    */
-  in_steps: ListProductionStep | null;
-
-  /**
-   * Rate resource.
-   */
-  labor_rate: ItemsAPI.Rate | null;
-
-  /**
-   * Rate resource.
-   */
-  labor_time: ItemsAPI.Rate | null;
-
-  /**
-   * Leveling factor as a decimal string.
-   */
-  leveling_factor: string;
+  free_shipping_service_levels: ListServiceLevel | null;
 
   /**
-   * List represents a paginated list of resources.
+   * Value with an associated unit.
    */
-  machines: ListMachine | null;
+  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;
 
-  /**
-   * Notes.
-   */
-  notes: string | null;
-
   /**
    * Resource type identifier.
    */
-  object: 'production_step';
-
-  /**
-   * List represents a paginated list of resources.
-   */
-  out_steps: ListProductionStep | null;
-
-  /**
-   * Rate resource.
-   */
-  overhead_rate: ItemsAPI.Rate | null;
+  object: 'shipping_term';
 
   /**
-   * Production output of a production step.
+   * Owner describes the provenance of a resource.
    */
-  production: ProductionOutput | null;
+  owner: APIKeysAPI.Owner | null;
 
   /**
-   * Scanning station resource.
+   * 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.
    */
-  scanning_station: ScanningStation | null;
+  type: 'free_freight' | 'flat_rate_freight' | 'carrier_rate_freight';
 
   /**
-   * Last updated timestamp.
+   * When this shipping term was last updated.
    */
   updated_at: string;
 }
 
 /**
- * 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;
-}
-
-/**
- * Scanning station resource.
+ * Request to partially update a customer.
  */
-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 UpdateCustomerRequest {
   /**
-   * Last updated timestamp.
+   * ID of an existing address to use as the default billing address.
    */
-  updated_at: string;
-}
+  bill_to_address_id?: string | null;
 
-/**
- * Shipping service level for a carrier.
- */
-export interface ServiceLevel {
   /**
-   * Service level ID.
+   * Carrier billing account number charged when `carrier_billing_type` is
+   * `third_party`.
    */
-  id: string;
+  carrier_billing_account?: string | null;
 
   /**
-   * Creation timestamp.
+   * Who pays the carrier for shipments.
+   *
+   * - `sender`: the shipper (you) pays the carrier.
+   * - `third_party`: a third party is billed, using `carrier_billing_account`.
    */
-  created_at: string;
+  carrier_billing_type?: 'sender' | 'third_party';
 
   /**
-   * Customer portal visibility.
+   * 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.
    */
-  customer_portal_visibility: 'visible' | 'hidden';
+  commission_policy?: 'commission_applied' | 'commission_exempt';
 
   /**
-   * Default service level for the carrier.
+   * A value with an associated unit, used in create and update requests.
    */
-  is_default: boolean;
+  credit_limit?: QuantityInput | null;
 
   /**
-   * Display name.
+   * 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.
    */
-  name: string;
+  customer_price_group_ids?: Array<string>;
 
   /**
-   * Resource type identifier.
+   * ID of the account group of type `type_group` that categorizes this customer (for
+   * example "Distributors").
    */
-  object: 'service_level';
+  customer_type_group_id?: string;
 
   /**
-   * Owner describes the provenance of a resource.
+   * ID of the default carrier for this customer's shipments.
    */
-  owner: APIKeysAPI.Owner | null;
+  default_carrier_id?: string;
 
   /**
-   * Service level token.
+   * Default payment term ID.
    */
-  service_level_token: string;
+  default_payment_term_id?: string;
 
   /**
-   * Last updated timestamp.
+   * Priority applied to new orders for this customer.
    */
-  updated_at: string;
-}
+  default_priority?: 'low' | 'normal' | 'high';
 
-/**
- * ShippingTerm resource.
- */
-export interface ShippingTerm {
   /**
-   * Shipping term ID.
+   * The ID of the account user to assign as the default sales rep.
    */
-  id: string;
+  default_sales_rep_id?: string | null;
 
   /**
-   * When this shipping term was created.
+   * ID of the default carrier service level.
    */
-  created_at: string;
+  default_service_level_id?: string | null;
 
   /**
-   * Value with an associated unit.
+   * Default shipping term ID.
    */
-  flat_rate: ItemsAPI.Quantity | null;
+  default_shipping_term_id?: string;
 
   /**
-   * List represents a paginated list of resources.
+   * Whether EDI (Electronic Data Interchange) is enabled for exchanging orders and
+   * documents with this customer.
    */
-  free_shipping_service_levels: ListServiceLevel | null;
+  edi_status?: 'enabled' | 'disabled';
 
   /**
-   * Value with an associated unit.
+   * Email address.
    */
-  minimum_order_value: ItemsAPI.Quantity | 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';
 
   /**
-   * Resource type identifier.
+   * The customer's business name, as shown throughout the app and on documents.
    */
-  object: 'shipping_term';
+  name?: string;
 
   /**
-   * Owner describes the provenance of a resource.
+   * Free-form note about the customer.
    */
-  owner: APIKeysAPI.Owner | null;
+  note?: string | null;
 
   /**
-   * Shipping term type.
+   * Human-readable customer number used to identify the account, distinct from the
+   * `id`.
+   *
+   * Must be unique within your account.
    */
-  type: 'free_freight' | 'flat_rate_freight' | 'carrier_rate_freight';
+  number?: string;
 
   /**
-   * When this shipping term was last updated.
+   * Phone number.
    */
-  updated_at: string;
-}
+  phone?: string | null;
 
-/**
- * Request to partially update a customer.
- */
-export interface UpdateCustomerRequest {
   /**
-   * Bill-to address ID.
+   * ID of an existing address to use as the default shipping address.
    */
-  bill_to_address_id?: string | null;
+  ship_to_address_id?: string | null;
 
   /**
-   * Carrier billing account number.
+   * 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.
    */
-  carrier_billing_account?: string | null;
+  status?: 'normal' | 'preferred' | 'hold_shipment' | 'hold_all';
 
   /**
-   * Carrier billing type.
+   * Website URL.
    */
-  carrier_billing_type?: 'sender' | 'third_party';
+  url?: string | null;
+}
+
+export interface CustomerDeleteResponse {}
 
+export interface CustomerListParams {
   /**
-   * Commission policy.
+   * Filter by default carrier IDs.
    */
-  commission_policy?: 'commission_applied' | 'commission_exempt';
+  carrier_ids?: Array<string>;
 
   /**
-   * QuantityInput represents a value with an associated unit for create/update
-   * requests.
+   * 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.
    */
-  credit_limit?: QuantityInput | null;
+  city?: string;
 
   /**
-   * Price group IDs. Replaces all existing price groups when provided.
+   * Filter by commission policy.
    */
-  customer_price_group_ids?: Array<string>;
+  commission_status_codes?: Array<'commission_applied' | 'commission_exempt'>;
 
   /**
-   * Customer type group ID.
+   * 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_type_group_id?: string;
+  cursor?: string;
 
   /**
-   * Default carrier ID.
+   * Filter by customer type group IDs (the account group of type `type_group`
+   * returned in the customer's `type` field).
    */
-  default_carrier_id?: string;
+  customer_group_ids?: Array<string>;
 
   /**
-   * Default payment term ID.
+   * Filter to customers created at or before this timestamp (inclusive).
    */
-  default_payment_term_id?: string;
+  end_date?: string;
 
   /**
-   * Default priority code.
+   * Filter by freight policy.
    */
-  default_priority?: 'low' | 'normal' | 'high';
+  freight_status_codes?: Array<'free_freight' | 'billed_freight'>;
 
   /**
-   * The ID of the account user to assign as the default sales rep.
+   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+   * `null`.
    */
-  default_sales_rep_id?: string | 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'
+  >;
 
   /**
-   * Default service level ID.
+   * Maximum number of results to return in a single page.
    */
-  default_service_level_id?: string | null;
+  limit?: number;
 
   /**
-   * Default shipping term ID.
+   * Filter by whether the customer has child accounts.
    */
-  default_shipping_term_id?: string;
+  parent_account_status?: 'parent' | 'non_parent';
 
   /**
-   * EDI status.
+   * Filter by default payment term IDs.
    */
-  edi_status?: 'enabled' | 'disabled';
+  payment_term_ids?: Array<string>;
 
   /**
-   * Email address. Send null to clear.
+   * Filter to customers with any address in this postal code (exact match).
    */
-  email?: string | null;
+  postal_code?: string;
 
   /**
-   * Freight policy.
+   * Filter to customers that belong to any of these pricing groups.
    */
-  freight_policy?: 'free_freight' | 'billed_freight';
+  pricing_group_ids?: Array<string>;
 
   /**
-   * Customer name.
+   * Free-text search term used to filter results.
+   *
+   * Which fields are matched against the term varies by endpoint.
    */
-  name?: string;
+  q?: string;
 
   /**
-   * Note.
+   * Filter by default sales rep IDs.
    */
-  note?: string | null;
+  sales_rep_ids?: Array<string>;
 
   /**
-   * Customer number.
+   * Filter by default service level IDs.
    */
-  number?: string;
+  service_level_ids?: Array<string>;
 
   /**
-   * Phone number. Send null to clear.
+   * Filter by default shipping term IDs.
    */
-  phone?: string | null;
+  shipping_term_ids?: Array<string>;
 
   /**
-   * Ship-to address ID.
+   * Filter to customers created at or after this timestamp (inclusive).
    */
-  ship_to_address_id?: string | null;
+  start_date?: string;
 
   /**
-   * Account status code.
+   * Filter to customers with any address in this state (exact match).
    */
-  status?: 'normal' | 'preferred' | 'hold_shipment' | 'hold_all';
+  state?: string;
 
   /**
-   * Website URL. Send null to clear.
+   * Filter by account status codes.
    */
-  url?: string | null;
+  status_codes?: Array<'normal' | 'preferred' | 'hold_shipment' | 'hold_all'>;
 }
 
-export interface CustomerDeleteResponse {}
+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.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;
 
@@ -1413,12 +1181,14 @@ 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;
 
@@ -1432,10 +1202,12 @@ export interface CustomerCreateParams {
     | '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'
@@ -1444,36 +1216,45 @@ export interface CustomerCreateParams {
     | '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';
 
@@ -1483,12 +1264,13 @@ 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';
 
@@ -1498,17 +1280,25 @@ 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;
 
@@ -1518,7 +1308,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';
 
@@ -1528,32 +1323,6 @@ 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
@@ -1565,10 +1334,12 @@ export interface CustomerUpdateParams {
     | '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'
@@ -1577,46 +1348,58 @@ export interface CustomerUpdateParams {
     | '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;
 
@@ -1626,7 +1409,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';
 
@@ -1636,7 +1419,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;
 
@@ -1646,213 +1429,93 @@ 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'>;
-}
-
 Customers.Actions = Actions;
 
 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 CustomerListParams as CustomerListParams,
     type CustomerRetrieveParams as CustomerRetrieveParams,
+    type CustomerCreateParams as CustomerCreateParams,
     type CustomerUpdateParams as CustomerUpdateParams,
-    type CustomerListParams as CustomerListParams,
   };
 
   export {