@augno/sdk 0.1.6 → 0.7.0

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

@@ -19,28 +19,18 @@ 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.
    *
    * @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' },
-   *   note: 'Key enterprise account',
-   * });
+   * 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 });
   }
 
   /**
@@ -62,8 +52,52 @@ 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.
+   *
+   * @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.
    *
    * @example
    * ```ts
@@ -73,6 +107,7 @@ export class Customers extends APIResource {
    *     default_carrier_id: 'cr_01784fd54c9ba197bb4e42f0e6',
    *     freight_policy: 'billed_freight',
    *     name: 'Acme Corp Updated',
+   *     note: 'Updated account notes',
    *   },
    * );
    * ```
@@ -87,23 +122,10 @@ 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.
    *
    * @example
    * ```ts
@@ -118,7 +140,11 @@ export class Customers extends APIResource {
 }
 
 /**
- * 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 {
   /**
@@ -132,42 +158,33 @@ 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';
 
@@ -177,13 +194,20 @@ export interface AccountUser {
   updated_at: 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 {
   /**
@@ -192,12 +216,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;
 
@@ -207,7 +239,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';
 
@@ -217,7 +250,7 @@ export interface Carrier {
   deleted_at: string | null;
 
   /**
-   * Display name.
+   * Human-readable name for the carrier, unique among your account's carriers.
    */
   name: string;
 
@@ -244,6 +277,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 {
   /**
@@ -292,17 +329,19 @@ 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;
 
@@ -317,43 +356,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';
 
@@ -363,12 +411,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';
 
@@ -378,17 +427,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;
 
@@ -398,7 +455,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';
 
@@ -409,7 +471,8 @@ export interface CreateCustomerRequest {
 }
 
 /**
- * Customer account.
+ * A business you sell to, with its contact details, default fulfillment settings,
+ * and order policies.
  */
 export interface Customer {
   /**
@@ -418,7 +481,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;
 
@@ -428,7 +492,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';
 
@@ -453,7 +521,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';
 
@@ -463,12 +532,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;
 
@@ -478,7 +547,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;
 
@@ -488,7 +558,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;
 
@@ -498,22 +569,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;
 
@@ -558,22 +640,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;
 
   /**
-   * ShippingTerm resource.
+   * A shipping term defining how freight charges are calculated for an order.
    */
   shipping_term: ShippingTerm | null;
 }
@@ -583,17 +670,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;
 
@@ -608,7 +702,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';
 }
@@ -629,7 +727,8 @@ export interface CustomerNotificationPreferences {
 }
 
 /**
- * Department resource.
+ * A functional area of a production operation, such as fabrication or packaging,
+ * that groups scanning stations and machines.
  */
 export interface Department {
   /**
@@ -643,7 +742,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;
 
@@ -653,12 +753,14 @@ 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;
 
@@ -819,7 +921,8 @@ export interface ListServiceLevel {
 }
 
 /**
- * Location resource.
+ * A physical storage location, such as a warehouse, aisle, or bin, arranged in a
+ * parent-child hierarchy.
  */
 export interface Location {
   /**
@@ -838,7 +941,7 @@ export interface Location {
   created_at: string;
 
   /**
-   * Display name.
+   * Display name of the location.
    */
   name: string;
 
@@ -848,14 +951,22 @@ 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.
@@ -863,8 +974,11 @@ export interface Location {
   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 {
   /**
@@ -878,17 +992,20 @@ 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;
 
@@ -898,7 +1015,7 @@ export interface Machine {
   object: 'machine';
 
   /**
-   * Serial number.
+   * Serial number of the machine.
    */
   serial_number: string;
 
@@ -909,7 +1026,8 @@ export interface Machine {
 }
 
 /**
- * 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 {
   /**
@@ -923,7 +1041,7 @@ export interface PaymentTerm {
   created_at: string;
 
   /**
-   * Display name.
+   * Display name (e.g. `Net 30`).
    */
   name: string;
 
@@ -938,7 +1056,7 @@ export interface PaymentTerm {
   owner: APIKeysAPI.Owner | null;
 
   /**
-   * Payment term status.
+   * Lifecycle status of the payment term.
    */
   status: 'active' | 'inactive';
 
@@ -949,7 +1067,7 @@ export interface PaymentTerm {
 }
 
 /**
- * Production output of a production step.
+ * The output of a production step: the item it produces and the quantity produced.
  */
 export interface ProductionOutput {
   /**
@@ -984,7 +1102,8 @@ export interface ProductionOutput {
 }
 
 /**
- * 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 {
   /**
@@ -993,7 +1112,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;
 
@@ -1008,7 +1131,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;
 
@@ -1018,17 +1142,23 @@ 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;
 
@@ -1038,12 +1168,12 @@ 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;
 
@@ -1058,17 +1188,19 @@ 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;
 
@@ -1079,23 +1211,23 @@ export interface ProductionStep {
 }
 
 /**
- * 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 {
   /**
@@ -1109,27 +1241,35 @@ 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;
 
@@ -1139,7 +1279,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';
 
@@ -1149,7 +1292,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';
 
@@ -1174,17 +1322,23 @@ 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;
 
@@ -1199,7 +1353,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;
 
@@ -1210,7 +1367,7 @@ export interface ServiceLevel {
 }
 
 /**
- * ShippingTerm resource.
+ * A shipping term defining how freight charges are calculated for an order.
  */
 export interface ShippingTerm {
   /**
@@ -1239,7 +1396,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;
 
@@ -1254,7 +1412,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';
 
@@ -1269,43 +1433,54 @@ 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;
 
@@ -1315,7 +1490,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';
 
@@ -1325,7 +1500,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;
 
@@ -1335,97 +1510,171 @@ 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 CustomerCreateParams {
+export interface CustomerListParams {
   /**
-   * Body param: Request to create an address.
+   * Filter by default carrier IDs.
    */
-  bill_to_address: AddressesAPI.AddressInput;
+  carrier_ids?: Array<string>;
 
   /**
-   * Body param: Customer type group ID.
+   * Filter to customers with any address in this city (exact match).
+   *
+   * When combined with `state` or `postal_code`, a single address must match all
+   * provided values.
    */
-  customer_type_group_id: string;
+  city?: string;
 
   /**
-   * Body param: Default carrier ID.
+   * Filter by commission policy.
    */
-  default_carrier_id: string;
+  commission_status_codes?: Array<'commission_applied' | 'commission_exempt'>;
 
   /**
-   * Body param: Default payment term 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.
    */
-  default_payment_term_id: string;
+  cursor?: string;
 
   /**
-   * Body param: Default shipping term ID.
+   * Filter by customer type group IDs (the account group of type `type_group`
+   * returned in the customer's `type` field).
    */
-  default_shipping_term_id: string;
+  customer_group_ids?: Array<string>;
 
   /**
-   * Body param: Display name.
+   * Filter to customers created at or before this timestamp (inclusive).
    */
-  name: string;
+  end_date?: string;
 
   /**
-   * Body param: Request to create an address.
+   * Filter by freight policy.
    */
-  ship_to_address: AddressesAPI.AddressInput;
+  freight_status_codes?: Array<'free_freight' | 'billed_freight'>;
 
   /**
-   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
-   * are returned as `null`.
+   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+   * `null`.
    */
   include?: Array<
     | 'bill_to_address'
@@ -1437,6 +1686,7 @@ export interface CustomerCreateParams {
     | 'defaults.payment_term'
     | 'defaults.shipping_term'
     | 'defaults.sales_rep'
+    | 'defaults.sales_rep.user'
     | 'defaults.priority'
     | 'contact_info'
     | 'freight_preferences'
@@ -1448,85 +1698,66 @@ export interface CustomerCreateParams {
   >;
 
   /**
-   * Body param: Carrier billing account number.
-   */
-  carrier_billing_account?: string;
-
-  /**
-   * Body param: Carrier billing type.
+   * Maximum number of results to return in a single page.
    */
-  carrier_billing_type?: 'sender' | 'third_party';
-
-  /**
-   * Body param: Commission policy.
-   */
-  commission_policy?: 'commission_applied' | 'commission_exempt';
-
-  /**
-   * Body param: QuantityInput represents a value with an associated unit for
-   * create/update requests.
-   */
-  credit_limit?: QuantityInput;
-
-  /**
-   * Body param: Price group IDs.
-   */
-  customer_price_group_ids?: Array<string>;
+  limit?: number;
 
   /**
-   * Body param: Default priority code.
+   * Filter by whether the customer has child accounts.
    */
-  default_priority?: 'low' | 'normal' | 'high';
+  parent_account_status?: 'parent' | 'non_parent';
 
   /**
-   * Body param: The ID of the account user to assign as the default sales rep.
+   * Filter by default payment term IDs.
    */
-  default_sales_rep_id?: string;
+  payment_term_ids?: Array<string>;
 
   /**
-   * Body param: Default service level ID.
+   * Filter to customers with any address in this postal code (exact match).
    */
-  default_service_level_id?: string;
+  postal_code?: string;
 
   /**
-   * Body param: EDI status.
+   * Filter to customers that belong to any of these pricing groups.
    */
-  edi_status?: 'enabled' | 'disabled';
+  pricing_group_ids?: Array<string>;
 
   /**
-   * Body param: Email address.
+   * Free-text search term used to filter results.
+   *
+   * Which fields are matched against the term varies by endpoint.
    */
-  email?: string;
+  q?: string;
 
   /**
-   * Body param: Freight policy.
+   * Filter by default sales rep IDs.
    */
-  freight_policy?: 'free_freight' | 'billed_freight';
+  sales_rep_ids?: Array<string>;
 
   /**
-   * Body param: Note.
+   * Filter by default service level IDs.
    */
-  note?: string;
+  service_level_ids?: Array<string>;
 
   /**
-   * Body param: Customer number. Auto-generated if omitted.
+   * Filter by default shipping term IDs.
    */
-  number?: string;
+  shipping_term_ids?: Array<string>;
 
   /**
-   * Body param: Phone number.
+   * Filter to customers created at or after this timestamp (inclusive).
    */
-  phone?: string;
+  start_date?: string;
 
   /**
-   * Body param: Account status code.
+   * Filter to customers with any address in this state (exact match).
    */
-  status?: 'normal' | 'preferred' | 'hold_shipment' | 'hold_all';
+  state?: string;
 
   /**
-   * Body param: Website URL.
+   * Filter by account status codes.
    */
-  url?: string;
+  status_codes?: Array<'normal' | 'preferred' | 'hold_shipment' | 'hold_all'>;
 }
 
 export interface CustomerRetrieveParams {
@@ -1544,6 +1775,7 @@ export interface CustomerRetrieveParams {
     | 'defaults.payment_term'
     | 'defaults.shipping_term'
     | 'defaults.sales_rep'
+    | 'defaults.sales_rep.user'
     | 'defaults.priority'
     | 'contact_info'
     | 'freight_preferences'
@@ -1555,7 +1787,46 @@ export interface CustomerRetrieveParams {
   >;
 }
 
-export interface CustomerUpdateParams {
+export interface CustomerCreateParams {
+  /**
+   * Body param: Address details used to create an address, either directly or inline
+   * on another resource.
+   */
+  bill_to_address: AddressesAPI.AddressInput;
+
+  /**
+   * 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: ID of the default carrier for this customer's shipments.
+   */
+  default_carrier_id: string;
+
+  /**
+   * Body param: Default payment term ID.
+   */
+  default_payment_term_id: string;
+
+  /**
+   * Body param: Default shipping term ID.
+   */
+  default_shipping_term_id: string;
+
+  /**
+   * Body param: The customer's business name, as shown throughout the app and on
+   * documents.
+   */
+  name: string;
+
+  /**
+   * 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`.
@@ -1570,6 +1841,7 @@ export interface CustomerUpdateParams {
     | 'defaults.payment_term'
     | 'defaults.shipping_term'
     | 'defaults.sales_rep'
+    | 'defaults.sales_rep.user'
     | 'defaults.priority'
     | 'contact_info'
     | 'freight_preferences'
@@ -1581,241 +1853,275 @@ export interface CustomerUpdateParams {
   >;
 
   /**
-   * Body param: Bill-to address ID.
-   */
-  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;
+  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 | null;
+  credit_limit?: QuantityInput;
 
   /**
-   * 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.
    */
   customer_price_group_ids?: Array<string>;
 
   /**
-   * Body param: Customer type group ID.
-   */
-  customer_type_group_id?: string;
-
-  /**
-   * Body param: Default carrier ID.
-   */
-  default_carrier_id?: string;
-
-  /**
-   * Body param: Default payment term ID.
+   * Body param: Priority applied to new orders for this customer.
    */
-  default_payment_term_id?: string;
+  default_priority?: 'low' | 'normal' | 'high';
 
   /**
-   * Body param: Default priority code.
+   * Body param: The ID of the account user to assign as the default sales rep.
    */
-  default_priority?: 'low' | 'normal' | 'high';
+  default_sales_rep_id?: string;
 
   /**
-   * Body param: The ID of the account user to assign as the default sales rep.
+   * Body param: ID of the default carrier service level.
    */
-  default_sales_rep_id?: string | null;
+  default_service_level_id?: string;
 
   /**
-   * Body param: Default service level ID.
+   * Body param: Whether EDI (Electronic Data Interchange) is enabled for exchanging
+   * orders and documents with this customer.
    */
-  default_service_level_id?: string | null;
+  edi_status?: 'enabled' | 'disabled';
 
   /**
-   * Body param: Default shipping term ID.
+   * Body param: Email address.
    */
-  default_shipping_term_id?: string;
+  email?: string;
 
   /**
-   * Body param: EDI status.
+   * 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.
    */
-  edi_status?: 'enabled' | 'disabled';
+  freight_policy?: 'free_freight' | 'billed_freight';
 
   /**
-   * Body param: Email address. Send null to clear.
+   * Body param: Free-form note about the customer.
    */
-  email?: string | null;
+  note?: string;
 
   /**
-   * Body param: Freight policy.
+   * 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.
    */
-  freight_policy?: 'free_freight' | 'billed_freight';
+  number?: string;
 
   /**
-   * Body param: Customer name.
+   * Body param: Phone number.
    */
-  name?: string;
+  phone?: string;
 
   /**
-   * Body param: Note.
+   * 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.
    */
-  note?: string | null;
+  status?: 'normal' | 'preferred' | 'hold_shipment' | 'hold_all';
 
   /**
-   * Body param: Customer number.
+   * Body param: Website URL.
    */
-  number?: string;
+  url?: string;
+}
 
+export interface CustomerUpdateParams {
   /**
-   * Body param: Phone number. Send null to clear.
+   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+   * are returned as `null`.
    */
-  phone?: string | 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'
+  >;
 
   /**
-   * Body param: Ship-to address ID.
+   * Body param: ID of an existing address to use as the default billing address.
    */
-  ship_to_address_id?: string | null;
+  bill_to_address_id?: string | null;
 
   /**
-   * Body param: Account status code.
+   * Body param: Carrier billing account number charged when `carrier_billing_type`
+   * is `third_party`.
    */
-  status?: 'normal' | 'preferred' | 'hold_shipment' | 'hold_all';
+  carrier_billing_account?: string | null;
 
   /**
-   * Body param: Website URL. Send null to clear.
+   * 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`.
    */
-  url?: string | null;
-}
+  carrier_billing_type?: 'sender' | 'third_party';
 
-export interface CustomerListParams {
   /**
-   * Filter by carrier IDs.
+   * 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.
    */
-  carrier_ids?: Array<string>;
+  commission_policy?: 'commission_applied' | 'commission_exempt';
 
   /**
-   * Filter by city.
+   * Body param: A value with an associated unit, used in create and update requests.
    */
-  city?: string;
+  credit_limit?: QuantityInput | null;
 
   /**
-   * Filter by commission status codes.
+   * 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.
    */
-  commission_status_codes?: Array<'commission_applied' | 'commission_exempt'>;
+  customer_price_group_ids?: Array<string>;
 
   /**
-   * Cursor token used to retrieve the next or previous page of results.
+   * Body param: ID of the account group of type `type_group` that categorizes this
+   * customer (for example "Distributors").
    */
-  cursor?: string;
+  customer_type_group_id?: string;
 
   /**
-   * Filter by customer group IDs.
+   * Body param: ID of the default carrier for this customer's shipments.
    */
-  customer_group_ids?: Array<string>;
+  default_carrier_id?: string;
 
   /**
-   * Filter by end date (created before).
+   * Body param: Default payment term ID.
    */
-  end_date?: string;
+  default_payment_term_id?: string;
 
   /**
-   * Filter by freight status codes.
+   * Body param: Priority applied to new orders for this customer.
    */
-  freight_status_codes?: Array<'free_freight' | 'billed_freight'>;
+  default_priority?: 'low' | 'normal' | 'high';
 
   /**
-   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
-   * `null`.
+   * Body param: The ID of the account user to assign as the default sales rep.
    */
-  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'
-  >;
+  default_sales_rep_id?: string | null;
 
   /**
-   * Maximum number of results per page (default: 100, max: 1000).
+   * Body param: ID of the default carrier service level.
    */
-  limit?: number;
+  default_service_level_id?: string | null;
 
   /**
-   * Filter by whether the customer has child accounts.
+   * Body param: Default shipping term ID.
    */
-  parent_account_status?: 'parent' | 'non_parent';
+  default_shipping_term_id?: string;
 
   /**
-   * Filter by payment term IDs.
+   * Body param: Whether EDI (Electronic Data Interchange) is enabled for exchanging
+   * orders and documents with this customer.
    */
-  payment_term_ids?: Array<string>;
+  edi_status?: 'enabled' | 'disabled';
 
   /**
-   * Filter by postal code.
+   * Body param: Email address.
    */
-  postal_code?: string;
+  email?: string | null;
 
   /**
-   * Filter by pricing group IDs.
+   * 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.
    */
-  pricing_group_ids?: Array<string>;
+  freight_policy?: 'free_freight' | 'billed_freight';
 
   /**
-   * Search query used to filter results.
+   * Body param: The customer's business name, as shown throughout the app and on
+   * documents.
    */
-  q?: string;
+  name?: string;
 
   /**
-   * Filter by sales rep IDs.
+   * Body param: Free-form note about the customer.
    */
-  sales_rep_ids?: Array<string>;
+  note?: string | null;
 
   /**
-   * Filter by service level IDs.
+   * Body param: Human-readable customer number used to identify the account,
+   * distinct from the `id`.
+   *
+   * Must be unique within your account.
    */
-  service_level_ids?: Array<string>;
+  number?: string;
 
   /**
-   * Filter by shipping term IDs.
+   * Body param: Phone number.
    */
-  shipping_term_ids?: Array<string>;
+  phone?: string | null;
 
   /**
-   * Filter by start date (created after).
+   * Body param: ID of an existing address to use as the default shipping address.
    */
-  start_date?: string;
+  ship_to_address_id?: string | null;
 
   /**
-   * Filter by state.
+   * 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.
    */
-  state?: string;
+  status?: 'normal' | 'preferred' | 'hold_shipment' | 'hold_all';
 
   /**
-   * Filter by status codes.
+   * Body param: Website URL.
    */
-  status_codes?: Array<'normal' | 'preferred' | 'hold_shipment' | 'hold_all'>;
+  url?: string | null;
 }
 
 Customers.Actions = Actions;
@@ -1840,6 +2146,7 @@ export declare namespace Customers {
     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,
@@ -1849,11 +2156,12 @@ export declare namespace Customers {
     type ServiceLevel as ServiceLevel,
     type ShippingTerm as ShippingTerm,
     type UpdateCustomerRequest as UpdateCustomerRequest,
+    type User as User,
     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 {