@uengage.io/platform-sdk 0.8.0 → 0.12.0

package/dist/business/schema.d.ts

@@ -2,14 +2,154 @@
  * Group names recognised by the business read API. Mirrors the GROUPS
  * registry in services/business; if the server adds a group, add it here.
  */
-export declare const BUSINESS_GROUPS: readonly ["profile", "gst", "payment_gateway"];
+export declare const BUSINESS_GROUPS: readonly ["profile", "branding", "compliance", "address", "contact", "hours", "slots", "order_types", "delivery", "charges", "attributes", "app_config", "payment_gateway", "bank"];
 export type BusinessGroupName = (typeof BUSINESS_GROUPS)[number];
 export interface BusinessProfile {
     name: string | null;
+    slug: string | null;
+    /** Numeric flag; 1 = active, 0 = inactive (legacy convention). */
+    status: number | null;
+    legal_entity_name: string | null;
 }
-export interface BusinessGst {
+export interface BusinessBranding {
+    /** Logo image URL or relative path served by the legacy CDN. */
+    logo: string | null;
+    /** Header/banner image URL. */
+    header_image: string | null;
+    /** Hex color string, e.g. "#01522B". */
+    brand_color: string | null;
+    social: {
+        facebook: string | null;
+        instagram: string | null;
+    };
+}
+export interface BusinessCompliance {
+    gstin: string | null;
+    fssai_no: string | null;
+    /** State of GST registration; same column as `address.state` in the DB. */
     state: string | null;
-    gst_no: string | null;
+    legal_entity_name: string | null;
+}
+export interface BusinessAddress {
+    city: string | null;
+    state: string | null;
+    address: string | null;
+    locality: string | null;
+    postal_code: number | null;
+    latitude: string | null;
+    longitude: string | null;
+}
+export interface BusinessContact {
+    outlet_phone: string | null;
+    owner_phone: string | null;
+    alternative_phone: string | null;
+    /** Phone number that receives order-failure / SLA-breach SMS alerts. */
+    alert_phone: string | null;
+    /** Comma-separated email list for daily reports + alerts. */
+    alert_emails: string | null;
+}
+export interface TimeOfDay {
+    hour: number | null;
+    minute: number;
+}
+export interface BusinessHours {
+    /** Window during which the storefront accepts online orders. */
+    online_orders: {
+        start: TimeOfDay;
+        end: TimeOfDay;
+    };
+    /** Real-world open/close times (may differ from order-window for prep buffers). */
+    actual: {
+        open: TimeOfDay;
+        close: TimeOfDay;
+    };
+    /** Hours of the day (0-23) when ordering is blocked. */
+    blocked_hours: number[];
+    /** Legacy off-hours config; same shape as blocked_hours. */
+    off_hours: number[];
+    /** Minutes between order placement and outlet handoff. String for legacy compat. */
+    preparation_time_minutes: string | null;
+}
+export interface BusinessSlots {
+    /** 1 = slots enabled, 0 = disabled. */
+    enabled: number | null;
+    /** 1 = slot-based ordering, 0 = continuous. */
+    slot_based_ordering: number | null;
+    /** "1" = show today's slots, "0" = hide. */
+    show_current_day: string | null;
+    /** Number of days into the future the user can pick slots for. */
+    day_limit: string | null;
+}
+export interface BusinessOrderTypes {
+    self_pickup: number | null;
+    delivery: number | null;
+    in_car: number | null;
+    dine_in: number | null;
+    /** "1" / "0" — legacy storage uses string. */
+    uengage_pay: string | null;
+    /**
+     * Inverted from intuition: "1" = delivery is fully disabled, "0" = enabled.
+     * Same string-typed legacy column.
+     */
+    delivery_disabled: string | null;
+}
+export interface BusinessDelivery {
+    /** Service radius in kilometers. String in legacy. */
+    radius_km: string | null;
+    /** Estimated delivery time, minutes. String in legacy. */
+    time_minutes: string | null;
+    tax_percent: number | null;
+    /** Min order value above which delivery is free. */
+    free_delivery_min_order_value: number | null;
+    /** Charge applied below the free-delivery threshold. */
+    delivery_charges: number | null;
+    /** Lower bound on order value the outlet accepts at all. */
+    eligible_order_value: number | null;
+    /** 0 → applied on Gross Value; 1 → applied on SubTotal. */
+    charges_applied_on: number;
+}
+export interface BusinessCharges {
+    packing: {
+        /** "1" = fixed, "2" = percentage. */
+        type: string | null;
+        /** Amount or percentage depending on `type`. */
+        amount: number | null;
+        tax_percent: number | null;
+    };
+    service: {
+        /** Percentage applied as service charge for dine-in orders. */
+        amount: number | null;
+        tax_percent: number | null;
+    };
+}
+export interface BusinessAttributes {
+    pure_veg: number | null;
+    serves_cuisine: string | null;
+    manages_riders: number | null;
+    /** "1" = grocery flow enabled in the consumer app. */
+    grocery_flow: string | null;
+    /** "1" = cloud kitchen (no in-person dining). */
+    cloud_kitchen: string | null;
+    /** Numeric campus identifier for B2B tenants; null for non-campus businesses. */
+    campus_id: string | null;
+}
+export interface BusinessAppConfig {
+    /** "1" = display menu prices inclusive of GST in the consumer app. */
+    menu_price_inclusive_of_gst: string | null;
+    new_launch: string | null;
+    share_link: string | null;
+    launch_date: string | null;
+    /** "0" = paid plan, "1" = free (legacy inverted). */
+    paid: string | null;
+    firebase_key: string | null;
+    /** Online listing visibility toggle; 1 = visible, 0 = hidden. */
+    online_visibility: number | null;
+    wallet: {
+        /** "1" = activated, "2" = inactive. */
+        activated: string | null;
+        /** "0" = show wallet tab, "1" = hide. */
+        hidden: string | null;
+    };
 }
 export interface BusinessPaymentGateway {
     razorpay: {
@@ -17,6 +157,12 @@ export interface BusinessPaymentGateway {
         secret: string | null;
     };
 }
+export interface BusinessBank {
+    account_holder: string | null;
+    account_number: string | null;
+    bank_name: string | null;
+    ifsc: string | null;
+}
 /**
  * Public summary of a parent business. Same shape as a top-level record
  * with the `profile` group included, but the parent's own parent is NOT
@@ -37,6 +183,17 @@ export interface BusinessRecord {
     /** Direct parent business (single level), or null if root. */
     parent: BusinessParent | null;
     profile?: BusinessProfile;
-    gst?: BusinessGst;
+    branding?: BusinessBranding;
+    compliance?: BusinessCompliance;
+    address?: BusinessAddress;
+    contact?: BusinessContact;
+    hours?: BusinessHours;
+    slots?: BusinessSlots;
+    order_types?: BusinessOrderTypes;
+    delivery?: BusinessDelivery;
+    charges?: BusinessCharges;
+    attributes?: BusinessAttributes;
+    app_config?: BusinessAppConfig;
     payment_gateway?: BusinessPaymentGateway;
+    bank?: BusinessBank;
 }

package/dist/business/schema.js

@@ -5,5 +5,20 @@ exports.BUSINESS_GROUPS = void 0;
  * Group names recognised by the business read API. Mirrors the GROUPS
  * registry in services/business; if the server adds a group, add it here.
  */
-exports.BUSINESS_GROUPS = ['profile', 'gst', 'payment_gateway'];
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2NoZW1hLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2J1c2luZXNzL3NjaGVtYS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQTs7O0dBR0c7QUFDVSxRQUFBLGVBQWUsR0FBRyxDQUFDLFNBQVMsRUFBRSxLQUFLLEVBQUUsaUJBQWlCLENBQVUsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbIi8qKlxuICogR3JvdXAgbmFtZXMgcmVjb2duaXNlZCBieSB0aGUgYnVzaW5lc3MgcmVhZCBBUEkuIE1pcnJvcnMgdGhlIEdST1VQU1xuICogcmVnaXN0cnkgaW4gc2VydmljZXMvYnVzaW5lc3M7IGlmIHRoZSBzZXJ2ZXIgYWRkcyBhIGdyb3VwLCBhZGQgaXQgaGVyZS5cbiAqL1xuZXhwb3J0IGNvbnN0IEJVU0lORVNTX0dST1VQUyA9IFsncHJvZmlsZScsICdnc3QnLCAncGF5bWVudF9nYXRld2F5J10gYXMgY29uc3Q7XG5leHBvcnQgdHlwZSBCdXNpbmVzc0dyb3VwTmFtZSA9ICh0eXBlb2YgQlVTSU5FU1NfR1JPVVBTKVtudW1iZXJdO1xuXG5leHBvcnQgaW50ZXJmYWNlIEJ1c2luZXNzUHJvZmlsZSB7XG4gIG5hbWU6IHN0cmluZyB8IG51bGw7XG59XG5cbmV4cG9ydCBpbnRlcmZhY2UgQnVzaW5lc3NHc3Qge1xuICBzdGF0ZTogc3RyaW5nIHwgbnVsbDtcbiAgZ3N0X25vOiBzdHJpbmcgfCBudWxsO1xufVxuXG5leHBvcnQgaW50ZXJmYWNlIEJ1c2luZXNzUGF5bWVudEdhdGV3YXkge1xuICByYXpvcnBheToge1xuICAgIGtleTogc3RyaW5nIHwgbnVsbDtcbiAgICBzZWNyZXQ6IHN0cmluZyB8IG51bGw7XG4gIH07XG59XG5cbi8qKlxuICogUHVibGljIHN1bW1hcnkgb2YgYSBwYXJlbnQgYnVzaW5lc3MuIFNhbWUgc2hhcGUgYXMgYSB0b3AtbGV2ZWwgcmVjb3JkXG4gKiB3aXRoIHRoZSBgcHJvZmlsZWAgZ3JvdXAgaW5jbHVkZWQsIGJ1dCB0aGUgcGFyZW50J3Mgb3duIHBhcmVudCBpcyBOT1RcbiAqIHJlY3Vyc2l2ZWx5IHJlc29sdmVkIChjYXBwZWQgYXQgZGVwdGggMSkuIENhbGxcbiAqIGBidXNpbmVzcy5nZXQocGFyZW50LmlkKWAgZm9yIHRoZSBncmFuZC1wYXJlbnQgaWYgbmVlZGVkLlxuICovXG5leHBvcnQgaW50ZXJmYWNlIEJ1c2luZXNzUGFyZW50IHtcbiAgaWQ6IG51bWJlcjtcbiAgcHJvZmlsZTogQnVzaW5lc3NQcm9maWxlO1xufVxuXG4vKipcbiAqIFJlc3BvbnNlIHNoYXBlIGZyb20gR0VUIC92MS9idXNpbmVzc2VzLzppZCBhbmQgdGhlIGVudHJpZXMgcmV0dXJuZWQgYnlcbiAqIEdFVCAvdjEvYnVzaW5lc3Nlcy4gR3JvdXAga2V5cyBhcmUgb3B0aW9uYWwgLSB0aGUgc2VydmVyIGluY2x1ZGVzXG4gKiBvbmx5IHRoZSBncm91cHMgdGhhdCB3ZXJlIGJvdGggcmVxdWVzdGVkIGFuZCBhdXRob3JpemVkIGZvciB0aGUgY2FsbGVyLlxuICovXG5leHBvcnQgaW50ZXJmYWNlIEJ1c2luZXNzUmVjb3JkIHtcbiAgaWQ6IG51bWJlcjtcbiAgLyoqIERpcmVjdCBwYXJlbnQgYnVzaW5lc3MgKHNpbmdsZSBsZXZlbCksIG9yIG51bGwgaWYgcm9vdC4gKi9cbiAgcGFyZW50OiBCdXNpbmVzc1BhcmVudCB8IG51bGw7XG4gIHByb2ZpbGU/OiBCdXNpbmVzc1Byb2ZpbGU7XG4gIGdzdD86IEJ1c2luZXNzR3N0O1xuICBwYXltZW50X2dhdGV3YXk/OiBCdXNpbmVzc1BheW1lbnRHYXRld2F5O1xufVxuIl19
+exports.BUSINESS_GROUPS = [
+    'profile',
+    'branding',
+    'compliance',
+    'address',
+    'contact',
+    'hours',
+    'slots',
+    'order_types',
+    'delivery',
+    'charges',
+    'attributes',
+    'app_config',
+    'payment_gateway',
+    'bank',
+];
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../src/business/schema.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACU,QAAA,eAAe,GAAG;IAC7B,SAAS;IACT,UAAU;IACV,YAAY;IACZ,SAAS;IACT,SAAS;IACT,OAAO;IACP,OAAO;IACP,aAAa;IACb,UAAU;IACV,SAAS;IACT,YAAY;IACZ,YAAY;IACZ,iBAAiB;IACjB,MAAM;CACE,CAAC","sourcesContent":["/**\n * Group names recognised by the business read API. Mirrors the GROUPS\n * registry in services/business; if the server adds a group, add it here.\n */\nexport const BUSINESS_GROUPS = [\n  'profile',\n  'branding',\n  'compliance',\n  'address',\n  'contact',\n  'hours',\n  'slots',\n  'order_types',\n  'delivery',\n  'charges',\n  'attributes',\n  'app_config',\n  'payment_gateway',\n  'bank',\n] as const;\nexport type BusinessGroupName = (typeof BUSINESS_GROUPS)[number];\n\n// ─── Identity ─────────────────────────────────────────────────────────────\nexport interface BusinessProfile {\n  name: string | null;\n  slug: string | null;\n  /** Numeric flag; 1 = active, 0 = inactive (legacy convention). */\n  status: number | null;\n  legal_entity_name: string | null;\n}\n\nexport interface BusinessBranding {\n  /** Logo image URL or relative path served by the legacy CDN. */\n  logo: string | null;\n  /** Header/banner image URL. */\n  header_image: string | null;\n  /** Hex color string, e.g. \"#01522B\". */\n  brand_color: string | null;\n  social: {\n    facebook: string | null;\n    instagram: string | null;\n  };\n}\n\n// ─── Statutory / regulatory ───────────────────────────────────────────────\nexport interface BusinessCompliance {\n  gstin: string | null;\n  fssai_no: string | null;\n  /** State of GST registration; same column as `address.state` in the DB. */\n  state: string | null;\n  legal_entity_name: string | null;\n}\n\n// ─── Where the outlet lives ───────────────────────────────────────────────\nexport interface BusinessAddress {\n  city: string | null;\n  state: string | null;\n  address: string | null;\n  locality: string | null;\n  postal_code: number | null;\n  latitude: string | null;\n  longitude: string | null;\n}\n\nexport interface BusinessContact {\n  outlet_phone: string | null;\n  owner_phone: string | null;\n  alternative_phone: string | null;\n  /** Phone number that receives order-failure / SLA-breach SMS alerts. */\n  alert_phone: string | null;\n  /** Comma-separated email list for daily reports + alerts. */\n  alert_emails: string | null;\n}\n\n// ─── Operations ───────────────────────────────────────────────────────────\nexport interface TimeOfDay {\n  hour: number | null;\n  minute: number;\n}\n\nexport interface BusinessHours {\n  /** Window during which the storefront accepts online orders. */\n  online_orders: { start: TimeOfDay; end: TimeOfDay };\n  /** Real-world open/close times (may differ from order-window for prep buffers). */\n  actual: { open: TimeOfDay; close: TimeOfDay };\n  /** Hours of the day (0-23) when ordering is blocked. */\n  blocked_hours: number[];\n  /** Legacy off-hours config; same shape as blocked_hours. */\n  off_hours: number[];\n  /** Minutes between order placement and outlet handoff. String for legacy compat. */\n  preparation_time_minutes: string | null;\n}\n\nexport interface BusinessSlots {\n  /** 1 = slots enabled, 0 = disabled. */\n  enabled: number | null;\n  /** 1 = slot-based ordering, 0 = continuous. */\n  slot_based_ordering: number | null;\n  /** \"1\" = show today's slots, \"0\" = hide. */\n  show_current_day: string | null;\n  /** Number of days into the future the user can pick slots for. */\n  day_limit: string | null;\n}\n\nexport interface BusinessOrderTypes {\n  self_pickup: number | null;\n  delivery: number | null;\n  in_car: number | null;\n  dine_in: number | null;\n  /** \"1\" / \"0\" — legacy storage uses string. */\n  uengage_pay: string | null;\n  /**\n   * Inverted from intuition: \"1\" = delivery is fully disabled, \"0\" = enabled.\n   * Same string-typed legacy column.\n   */\n  delivery_disabled: string | null;\n}\n\nexport interface BusinessDelivery {\n  /** Service radius in kilometers. String in legacy. */\n  radius_km: string | null;\n  /** Estimated delivery time, minutes. String in legacy. */\n  time_minutes: string | null;\n  tax_percent: number | null;\n  /** Min order value above which delivery is free. */\n  free_delivery_min_order_value: number | null;\n  /** Charge applied below the free-delivery threshold. */\n  delivery_charges: number | null;\n  /** Lower bound on order value the outlet accepts at all. */\n  eligible_order_value: number | null;\n  /** 0 → applied on Gross Value; 1 → applied on SubTotal. */\n  charges_applied_on: number;\n}\n\nexport interface BusinessCharges {\n  packing: {\n    /** \"1\" = fixed, \"2\" = percentage. */\n    type: string | null;\n    /** Amount or percentage depending on `type`. */\n    amount: number | null;\n    tax_percent: number | null;\n  };\n  service: {\n    /** Percentage applied as service charge for dine-in orders. */\n    amount: number | null;\n    tax_percent: number | null;\n  };\n}\n\n// ─── Business attributes / type ───────────────────────────────────────────\nexport interface BusinessAttributes {\n  pure_veg: number | null;\n  serves_cuisine: string | null;\n  manages_riders: number | null;\n  /** \"1\" = grocery flow enabled in the consumer app. */\n  grocery_flow: string | null;\n  /** \"1\" = cloud kitchen (no in-person dining). */\n  cloud_kitchen: string | null;\n  /** Numeric campus identifier for B2B tenants; null for non-campus businesses. */\n  campus_id: string | null;\n}\n\n// ─── App-level config + visibility ────────────────────────────────────────\nexport interface BusinessAppConfig {\n  /** \"1\" = display menu prices inclusive of GST in the consumer app. */\n  menu_price_inclusive_of_gst: string | null;\n  new_launch: string | null;\n  share_link: string | null;\n  launch_date: string | null;\n  /** \"0\" = paid plan, \"1\" = free (legacy inverted). */\n  paid: string | null;\n  firebase_key: string | null;\n  /** Online listing visibility toggle; 1 = visible, 0 = hidden. */\n  online_visibility: number | null;\n  wallet: {\n    /** \"1\" = activated, \"2\" = inactive. */\n    activated: string | null;\n    /** \"0\" = show wallet tab, \"1\" = hide. */\n    hidden: string | null;\n  };\n}\n\n// ─── Money in / out ───────────────────────────────────────────────────────\nexport interface BusinessPaymentGateway {\n  razorpay: {\n    key: string | null;\n    secret: string | null;\n  };\n}\n\nexport interface BusinessBank {\n  account_holder: string | null;\n  account_number: string | null;\n  bank_name: string | null;\n  ifsc: string | null;\n}\n\n/**\n * Public summary of a parent business. Same shape as a top-level record\n * with the `profile` group included, but the parent's own parent is NOT\n * recursively resolved (capped at depth 1). Call\n * `business.get(parent.id)` for the grand-parent if needed.\n */\nexport interface BusinessParent {\n  id: number;\n  profile: BusinessProfile;\n}\n\n/**\n * Response shape from GET /v1/businesses/:id and the entries returned by\n * GET /v1/businesses. Group keys are optional - the server includes\n * only the groups that were both requested and authorized for the caller.\n */\nexport interface BusinessRecord {\n  id: number;\n  /** Direct parent business (single level), or null if root. */\n  parent: BusinessParent | null;\n  profile?: BusinessProfile;\n  branding?: BusinessBranding;\n  compliance?: BusinessCompliance;\n  address?: BusinessAddress;\n  contact?: BusinessContact;\n  hours?: BusinessHours;\n  slots?: BusinessSlots;\n  order_types?: BusinessOrderTypes;\n  delivery?: BusinessDelivery;\n  charges?: BusinessCharges;\n  attributes?: BusinessAttributes;\n  app_config?: BusinessAppConfig;\n  payment_gateway?: BusinessPaymentGateway;\n  bank?: BusinessBank;\n}\n"]}

package/dist/client.d.ts

@@ -1,34 +1,86 @@
 import { type AuditClient } from './audit/client';
 import { type BusinessClient } from './business/client';
-import { auth } from './auth';
+import { type ZonesClient } from './zones/client';
+import { auth as authNamespace } from './auth';
 /**
- * Caller-facing config for the unified `createClient(...)` factory and
- * the `platform` singleton.
+ * Caller-facing config for `createClient(...)`.
  *
- * Pick exactly one of:
- *   - `accessToken` (string or callback) for the static Bearer flow
- *   - `serviceId` + `serviceSecret` for OAuth2 client_credentials
+ * `createClient()` (no args) reads everything from the standard
+ * `UENGAGE_*` environment variables — convenient for Lambdas that
+ * already have their config injected by the deploy stack. Any field
+ * passed explicitly overrides the matching env default for that one
+ * call only (no shared mutable state, no singleton).
  *
- * Without either, calls throw `ConfigError` on the first request.
+ * Auth-mode fields are mutually exclusive. Pick one:
+ *   - `serviceId` + `serviceSecret`  OAuth2 client_credentials.
+ *   - `authToken`                    static Bearer token, or async
+ *                                    callback that returns one.
+ *   - `session: {id, token}`         legacy uEngage (id, apiToken) /
+ *                                    (id, addo_contacts_mapping.token)
+ *                                    pair. The SDK probes the business
+ *                                    surface (users) first, falls back
+ *                                    to the customer surface
+ *                                    (addo_contacts_mapping) if the
+ *                                    business probe returns
+ *                                    `invalid_grant`, and caches the
+ *                                    resulting JWT.
+ *
+ * Passing more than one explicitly is a `ConfigError`. Passing any one
+ * of them suppresses every env-derived auth default, so a caller's
+ * explicit override is never silently merged with env credentials of
+ * a different mode.
  */
 export interface ClientConfig {
     baseUrl?: string;
     /**
      * Auth surface base used to bootstrap the first client_credentials
-     * mint. Defaults to `${baseUrl}/auth/business`. Once a token exists,
-     * future auth calls follow the token's `iss` claim.
+     * mint. Defaults to `${baseUrl}/auth/business`.
      */
     authBaseUrl?: string;
     /**
-     * Customer auth surface base used by `withSessionToken`. Defaults
-     * to `${baseUrl}/auth/customer`.
+     * Customer auth surface base used by `session` exchanges. Defaults to
+     * `${baseUrl}/auth/customer`.
      */
     customerAuthBaseUrl?: string;
-    accessToken?: string | (() => string | Promise<string>);
+    /** OAuth2 `client_credentials` clientId. Pair with `serviceSecret`. */
     serviceId?: string;
+    /** OAuth2 `client_credentials` clientSecret. Pair with `serviceId`. */
     serviceSecret?: string;
     /** Space-separated scope list to request when minting via client_credentials. */
     scope?: string;
+    /** Static Bearer JWT, or async callback that returns one. */
+    authToken?: string | (() => string | Promise<string>);
+    /**
+     * Legacy uEngage (id, token) pair. `id` is `users.userId` for staff
+     * users (matched via the business surface) or
+     * `addo_contacts_mapping.id`/`contactId` for customers (matched via
+     * the customer surface). The SDK probes the business surface first
+     * and falls back to customer on `invalid_grant`.
+     */
+    session?: {
+        id: string | number;
+        token: string;
+    };
+    /**
+     * `(accessToken, refreshToken)` pair from a finished login flow
+     * (`auth.loginWithPassword(...)`, `auth.verifyOtp(...)`, etc). The
+     * SDK uses the access token until it expires, then rotates via
+     * `auth.refresh(...)` transparently. `onRotate` fires after every
+     * rotation so callers can persist the new pair.
+     */
+    tokens?: {
+        accessToken: string;
+        refreshToken: string;
+        /** Access token TTL (seconds), as returned by the auth surface. */
+        expiresIn: number;
+        /** OAuth client id used during the original login (required by the refresh handler). */
+        clientId: string;
+        onRotate?: (pair: {
+            accessToken: string;
+            refreshToken: string;
+            expiresAt: number;
+        }) => void | Promise<void>;
+    };
     /**
      * Service identifier the audit client should stamp into `actor.via`
      * on emitted events. Defaults to `serviceId` when set; otherwise
@@ -41,48 +93,22 @@ export interface ClientConfig {
 export interface PlatformClient {
     business: BusinessClient;
     audit: AuditClient;
-    auth: typeof auth;
-    /**
-     * Return a derived client bound to the supplied access token.
-     * Inherits `baseUrl` and `fetchFn`; replaces the token source with
-     * the new one. Use case: BFF handlers that want to call the
-     * platform API as the end user instead of as the service.
-     */
-    withToken(token: string | (() => string | Promise<string>)): PlatformClient;
+    zones: ZonesClient;
+    auth: typeof authNamespace;
     /**
-     * Return a derived client that exchanges a legacy customer session
-     * token (from `addo_contacts_mapping.token`) for a Bearer JWT
-     * transparently on each call. The session token is the persistent
-     * credential — exchanges happen lazily on token-cache miss and on
-     * 401 retries. When the legacy session is revoked, the next
-     * exchange returns 401 and surfaces as `AuthenticationError`.
+     * Resolve the current access token, minting via the configured auth
+     * mode if the cache is cold. Useful for `auth.verifyAccessToken(...)`
+     * round-trips and for callers that want to log / forward the bearer
+     * to a downstream service.
+     *
+     * Throws `ConfigError` when the client was built with no auth mode.
      */
-    withSessionToken(sessionToken: string): PlatformClient;
+    getAccessToken(): Promise<string>;
 }
 /**
- * Build a fresh, isolated client from explicit config. Each call
- * gets its own TokenSource state — concurrent `createClient(...)` use
- * does not stampede the cache.
+ * Build a fresh, isolated client. With no args, reads `UENGAGE_*`
+ * env vars; explicit fields override per call. Each call gets its own
+ * TokenSource state — concurrent `createClient(...)` use does not
+ * stampede the cache.
  */
 export declare function createClient(input?: ClientConfig): PlatformClient;
-/**
- * Default client. Reads config from environment variables on first
- * property access (so test setups that mutate `process.env` after
- * import work). Use `createClient(...)` when you need an isolated
- * instance with explicit config.
- *
- *   UENGAGE_BASE_URL         defaults to https://api.platform.uengage.io
- *   UENGAGE_AUTH_BASE_URL    auth surface override (default ${baseUrl}/auth/business)
- *   UENGAGE_AUTH_TOKEN       static Bearer token (overrides client_credentials)
- *   UENGAGE_SERVICE_ID       OAuth2 client_credentials clientId
- *   UENGAGE_SERVICE_SECRET   OAuth2 client_credentials clientSecret
- *   UENGAGE_SERVICE_SCOPE    optional space-separated scope list
- */
-export declare const platform: PlatformClient;
-/** Test-only: drop the singleton cache between cases. */
-export declare function _resetPlatformSingleton(): void;
-/**
- * Convenience: shorthand for `platform.withToken(token)`.
- * BFF handlers commonly call this once per request.
- */
-export declare function withToken(token: string | (() => string | Promise<string>)): PlatformClient;