@trillboards/api-client 0.3.0 → 1.0.0

package/dist/index.d.mts

@@ -1,8 +1,26 @@
+import { Screen, PartnerDeviceRegistrationInput, DisplaySettingsResponse, DisplaySettingsInput, Device, PartnerDeviceBatchRegistrationInput, Impression, AnalyticsData, EarningsData, ErrorEntry, Webhook, FleetCommand, AudienceData, BillingInfo, CreatePartnerSensingRouteRequest, SensingRoute, UpdatePartnerSensingRouteRequest, WebhookEvent } from './generated.mjs';
+export { BleScanResultData, ContentFitSettings, DeviceCapabilityPayload, GeneratedOperationName, GeneratedSchemaName, HttpProbeResult, MdnsNetworkDevice, PartnerAdDeliveryProfile, PartnerDeviceHeartbeatBody, PartnerHeartbeatMeasurementMetadata, PartnerHeartbeatQueryData, PartnerHeartbeatQueryResponse, PartnerHeartbeatRequest, PartnerHeartbeatResponse, PartnerSafeHeartbeatTelemetry, SsdpDeviceInfo, WifiEnvironmentSnapshot, WifiScanResult, generatedTypes, getDeviceHeartbeatOperation, heartbeatOperation } from './generated.mjs';
+
 /**
- * Core type definitions for the Trillboards API Client SDK.
- *
- * Mirrors the canonical error contract from trillboard-api/utils/apiErrors.ts
- * and the OpenAPI schema at trillboard-api/docs/openapi/partner-api.yaml.
+ * Non-wire type definitions for the Trillboards API Client SDK.
+ *
+ * This file is DELIBERATELY narrow. Every type that has an on-the-wire peer in
+ * the OpenAPI contract lives in `./generated` (emitted from
+ * trillboard-api/docs/openapi/merged/partner-api.json via `npm run generate`)
+ * and is re-exported from `./index`. What remains here is the set of types that
+ * CANNOT be generated from the spec and are the SDK's own hand-crafted surface:
+ *
+ *   - the error contract (mirrors trillboard-api/utils/apiErrors.ts),
+ *   - client/request ergonomics (`ClientOptions`, `RequestOptions`),
+ *   - the generic pagination envelope (`ListResponse<T>`),
+ *   - the Sense Anything "Route" ergonomics + the FLAT route-fire webhook body
+ *     (richer than the spec can express — the digest summary is a typed object,
+ *     not the spec's `observed: unknown`),
+ *   - the `ContentFitMode` literal helper.
+ *
+ * Entity/wire types (`Screen`, `Device`, `Webhook`, `WebhookEvent`, `SensingRoute`,
+ * display-settings + device-registration inputs, etc.) are NOT here — import them
+ * from `@trillboards/api-client` (re-exported from `./generated`).
  */
 type ApiErrorType = 'invalid_request_error' | 'authentication_error' | 'permission_error' | 'rate_limit_error' | 'idempotency_error' | 'api_error';
 interface ErrorDetail {
@@ -45,120 +63,88 @@ interface ListResponse<T> {
         has_more: boolean;
     };
 }
-interface Screen {
-    screen_id: string;
-    name: string;
-    status: string;
-    device_id?: string;
-    venue_type?: string;
-    country?: string;
-    city?: string;
-    timezone?: string;
-    resolution?: string;
-    embed_url?: string;
-    created_at: string;
-    updated_at: string;
-}
-interface Device {
-    device_id: string;
-    device_name: string;
-    device_type?: string;
-    platform?: string;
-    screen_id?: string;
-    status: string;
-    last_heartbeat?: string;
-    created_at: string;
-    updated_at: string;
-}
-interface Impression {
-    impression_id: string;
-    screen_id: string;
-    device_id: string;
-    ad_type?: string;
-    advertiser_name?: string;
-    cpm?: number;
-    earnings?: number;
-    played_at: string;
-    duration_seconds?: number;
-}
-interface AnalyticsData {
-    period: string;
-    total_impressions: number;
-    total_earnings: number;
-    average_cpm: number;
-    fill_rate: number;
-    screens_active: number;
-    screens_total: number;
-    by_screen?: Array<{
-        screen_id: string;
-        name: string;
-        impressions: number;
-        earnings: number;
-    }>;
-}
-interface EarningsData {
-    period: string;
-    total_earnings: number;
-    total_impressions: number;
-    average_cpm: number;
-    daily?: Array<{
-        date: string;
-        earnings: number;
-        impressions: number;
-    }>;
-    pending_payout: number;
-    last_payout_date?: string;
-    last_payout_amount?: number;
-}
-interface WebhookEvent {
-    id: string;
-    type: string;
-    created_at: string;
-    data: Record<string, unknown>;
-    partner_id: string;
-}
-interface Webhook {
-    id: string;
-    url: string;
-    events: string[];
-    status: string;
-    secret: string;
-    created_at: string;
-    updated_at: string;
-}
-interface ErrorEntry {
-    id: string;
-    code: string;
-    type: ApiErrorType;
-    message: string;
-    param?: string;
-    doc_url: string;
-    timestamp: string;
-    request_id: string;
-    endpoint: string;
-    method: string;
+/**
+ * Per-content-type sizing mode. `fit` preserves the entire creative and may
+ * letterbox; `fill` covers the screen and may crop edges. A convenience literal
+ * for callers building `ContentFitSettings` values; the spec inlines this union.
+ */
+type ContentFitMode = 'fit' | 'fill';
+/**
+ * Comparison operators accepted for a Route threshold condition — the same set
+ * the API validates against (services/fein/clipTriggerSchema VALID_OPERATORS).
+ */
+type RouteConditionOp = 'gt' | 'gte' | 'lt' | 'lte' | 'eq' | 'neq';
+/** A threshold condition: fires when `field` crosses `value` via `op`. */
+interface RouteCondition {
+    field: string;
+    op?: RouteConditionOp;
+    value?: number | string | boolean;
+}
+/** Channels a Route action can fire on. */
+type RouteChannel = 'webhook' | 'whatsapp' | 'sms' | 'slack' | 'email' | 'clip';
+/** One channel action fired when a Route matches. */
+interface RouteAction {
+    channel: RouteChannel;
+    webhookId?: string;
+    recipientE164?: string;
+    recipientEmail?: string;
+    slackChannelId?: string;
+    templateName?: string;
+    attachClip?: boolean;
+}
+/** Scheduled-digest config (mode = 'digest'). */
+interface RouteDigest {
+    metric: 'count' | 'avg' | 'max';
+    windowMinutes: number;
+    intervalMinutes: number;
+    nextRunAt?: string;
 }
-interface FleetCommand {
-    command_id: string;
-    command: string;
-    status: string;
-    target_screens: string[];
-    created_at: string;
-    completed_at?: string;
+/**
+ * The webhook events a Route fire can deliver. The event type is in the
+ * `X-Trillboards-Event` request header: a custom sensed field delivers
+ * `sensing.threshold_crossed`, a known semantic delivers the matching
+ * `audience.*` / `venue.*` event, and a scheduled digest delivers
+ * `venue.traffic_summary`.
+ */
+type RouteWebhookEvent = 'sensing.threshold_crossed' | 'audience.spike' | 'audience.venue_busy' | 'audience.purchase_intent' | 'audience.demographics_update' | 'venue.traffic_summary';
+/**
+ * The aggregate summary delivered as the `observed` value of a digest Route fire
+ * (`venue.traffic_summary`). The digest runner builds it over the Route's window.
+ */
+interface RouteDigestSummary {
+    metric: 'count' | 'avg' | 'max';
+    field: string | null;
+    /** The headline value for `metric`. null for an avg/max window with no samples. */
+    value: number | null;
+    count: number;
+    avg: number | null;
+    max: number | null;
+    window_minutes: number;
+    window_end: string;
 }
-interface AudienceData {
+/**
+ * The FLAT webhook request body delivered when a Route fires. Unlike the
+ * device/programmatic events there is NO `{event,timestamp,data}` wrapper — the
+ * event type rides the `X-Trillboards-Event` header. Verify the
+ * `X-Trillboards-Signature` header over the raw body before trusting it.
+ *
+ * `observed` is a scalar for threshold Routes; for a digest Route
+ * (`venue.traffic_summary`) it is a {@link RouteDigestSummary} object.
+ *
+ * Kept hand-authored (not routed to the generated `SensingThresholdCrossedEvent`)
+ * because the emitter's flat-property-bag walker can only type `observed`/`threshold`
+ * as `unknown`; the typed unions here are a deliberate ergonomic improvement.
+ */
+interface SensingThresholdCrossedEvent {
+    route_id: string;
+    route_name: string;
+    owner_kind: 'earner_user' | 'partner';
     screen_id: string;
-    timestamp: string;
-    attention_count: number;
-    dwell_time_avg: number;
-    demographics?: Record<string, unknown>;
-}
-interface BillingInfo {
-    plan: string;
-    credits_remaining: number;
-    credits_used: number;
-    usage_this_month: Record<string, number>;
-    stripe_connected: boolean;
+    field: string | null;
+    op: RouteConditionOp | null;
+    threshold: number | string | boolean | null;
+    observed: number | string | boolean | RouteDigestSummary | null;
+    fired_at: string;
 }
 
 /**
@@ -256,18 +242,18 @@ declare class ScreensClient {
         data: Screen;
     }>;
     /** Register a new device/screen. */
-    create(body: {
-        device_name: string;
-        device_type?: string;
-        venue_type?: string;
-        country?: string;
-        city?: string;
-        timezone?: string;
-        resolution?: string;
-    }): Promise<{
+    create(body: PartnerDeviceRegistrationInput): Promise<{
         success: boolean;
         data: Screen;
     }>;
+    /** Get the resolved display settings for one screen. */
+    getDisplaySettings(screenId: string): Promise<DisplaySettingsResponse>;
+    /** Partially update display settings; omitted content-fit keys are preserved. */
+    patchDisplaySettings(screenId: string, settings: DisplaySettingsInput): Promise<DisplaySettingsResponse>;
+    /** Update display settings through the PUT endpoint. */
+    updateDisplaySettings(screenId: string, settings: DisplaySettingsInput): Promise<DisplaySettingsResponse>;
+    /** Apply a partial display-settings update to up to 100 screens. */
+    batchUpdateDisplaySettings(screenIds: string[], settings: DisplaySettingsInput): Promise<Record<string, unknown>>;
     /** Delete a screen/device. */
     delete(screenId: string): Promise<{
         success: boolean;
@@ -294,14 +280,17 @@ declare class DevicesClient {
         data: Device;
     }>;
     /** Register a new device. */
-    create(body: {
-        device_name: string;
-        device_type?: string;
-        platform?: string;
-    }): Promise<{
+    create(body: PartnerDeviceRegistrationInput): Promise<{
         success: boolean;
         data: Device;
     }>;
+    /** Register or re-register up to 100 devices with optional fleet defaults. */
+    createBatch(body: PartnerDeviceBatchRegistrationInput): Promise<{
+        success: boolean;
+        summary: Record<string, number>;
+        devices: Array<Record<string, unknown>>;
+        errors: Array<Record<string, unknown>>;
+    }>;
     /** Delete a device. */
     delete(deviceId: string): Promise<{
         success: boolean;
@@ -436,7 +425,14 @@ declare class WebhooksClient {
     constructor(http: HttpClient);
     /** List all webhook subscriptions. */
     list(): Promise<ListResponse<Webhook>>;
-    /** Create a new webhook subscription. */
+    /**
+     * Create a new webhook subscription.
+     *
+     * The created `Webhook` carries its signing `secret` (`whsec_…`) — this is the
+     * ONLY time it is returned. Persist it securely and pass it to
+     * `Webhooks.constructEvent()` to verify the compound `X-Trillboards-Signature`
+     * header over the raw delivery body.
+     */
     create(body: {
         url: string;
         events: string[];
@@ -573,6 +569,57 @@ declare class BillingClient {
     }>;
 }
 
+/**
+ * RoutesClient — Sense Anything "Routes": alerting + automation on the sensing
+ * stream. A Route fires channel actions (webhook / managed WhatsApp / SMS /
+ * Slack / email) when a sensed field crosses a threshold on a set of your
+ * screens, or on a scheduled digest.
+ *
+ * Base path: /v1/partner/sensing/routes
+ */
+
+declare class RoutesClient {
+    private readonly http;
+    constructor(http: HttpClient);
+    /** Create a Route. Every screen in `screenMongoIds` must be one you own. */
+    create(body: CreatePartnerSensingRouteRequest): Promise<{
+        success: boolean;
+        data: {
+            route: SensingRoute;
+        };
+    }>;
+    /** List your Routes. Pass `includeDisabled: false` to return only enabled Routes. */
+    list(params?: {
+        includeDisabled?: boolean;
+    }): Promise<{
+        success: boolean;
+        data: {
+            routes: SensingRoute[];
+        };
+    }>;
+    /** Get one Route by id. */
+    get(routeId: string): Promise<{
+        success: boolean;
+        data: {
+            route: SensingRoute;
+        };
+    }>;
+    /** Update a Route (partial, non-clobbering — only the fields you send change). */
+    update(routeId: string, body: UpdatePartnerSensingRouteRequest): Promise<{
+        success: boolean;
+        data: {
+            route: SensingRoute;
+        };
+    }>;
+    /** Soft-delete a Route. */
+    delete(routeId: string): Promise<{
+        success: boolean;
+        data: {
+            routeId: string;
+        };
+    }>;
+}
+
 /**
  * TrillboardsClient — main entry point for the Trillboards Partner API SDK.
  *
@@ -595,6 +642,7 @@ declare class TrillboardsClient {
     readonly data: DataClient;
     readonly errors: ErrorsClient;
     readonly billing: BillingClient;
+    readonly routes: RoutesClient;
     /** The underlying HTTP client (exposed for advanced use cases). */
     readonly _http: HttpClient;
     constructor(options: ClientOptions);
@@ -750,7 +798,7 @@ declare function parseSignatureHeader(rawSig: string): ParsedSignatureHeader;
  *       req.headers,                           // IncomingHttpHeaders
  *       process.env.WEBHOOK_SECRET!,           // your subscription secret
  *     );
- *     console.log('Received', event.type);
+ *     console.log('Received', event.event);
  *     res.sendStatus(200);
  *   } catch (err) {
  *     // TrillboardsError with code "webhook_signature_invalid"
@@ -784,391 +832,6 @@ declare const Webhooks: {
  * SDK version constant. Sent in User-Agent and X-Trillboards-Client headers.
  * Keep in sync with package.json version.
  */
-declare const VERSION = "0.1.3";
-
-type BleScanResultData = {
-    appleContinuitySubtype?: number | null;
-    deviceType?: number | null;
-    ibeaconMajor?: number | null;
-    ibeaconMinor?: number | null;
-    ibeaconUuid?: string | null;
-    manufacturerCompanyId?: number | null;
-    rawAddress: string;
-    rssi: number;
-    serviceUuids?: Array<string> | null;
-    stableManufacturerPayloadHex?: string | null;
-    txPowerDbm?: number | null;
-    [key: string]: unknown;
-};
-type DeviceCapabilityPayload = {
-    agentType?: string | null;
-    agentVersion?: string | null;
-    audienceSensing?: {
-        cameraAvailable?: boolean | null;
-        cameraCount?: number | null;
-        cameraHealth?: {
-            lastFailureClass?: string | null;
-            lastFailureMessage?: string | null;
-            lastFrameAtMs?: number | null;
-            retryCount?: number | null;
-            state?: string | null;
-            [key: string]: unknown;
-        } | null;
-        cameraType?: string | null;
-        microphoneAvailable?: boolean | null;
-        sensingMode?: string | null;
-        [key: string]: unknown;
-    } | null;
-    audioControl?: {
-        mute?: boolean | null;
-        volume?: boolean | null;
-        [key: string]: unknown;
-    } | null;
-    capabilitiesVersion?: number | null;
-    environmentSensors?: {
-        ambientLight?: boolean | null;
-        temperature?: boolean | null;
-        [key: string]: unknown;
-    } | null;
-    inputControl?: {
-        appSwitch?: boolean | null;
-        hdmi?: boolean | null;
-        [key: string]: unknown;
-    } | null;
-    isDeviceOwner?: boolean | null;
-    managementCapabilities?: {
-        clearCache?: boolean | null;
-        installApk?: boolean | null;
-        kioskMode?: boolean | null;
-        reboot?: boolean | null;
-        restart?: boolean | null;
-        screenshot?: boolean | null;
-        wipe?: boolean | null;
-        [key: string]: unknown;
-    } | null;
-    mlCapabilities?: {
-        availableRamMb?: number | null;
-        chipsetName?: string | null;
-        chipsetVendor?: string | null;
-        cpuAbi?: string | null;
-        densityDpi?: number | null;
-        gpuDelegateSupported?: boolean | null;
-        gpuName?: string | null;
-        hasNpu?: boolean | null;
-        maxVlmSizeMb?: number | null;
-        nnapiSupported?: boolean | null;
-        npuName?: string | null;
-        osApiLevel?: number | null;
-        recommendedModelTier?: string | null;
-        screenHeightPx?: number | null;
-        screenWidthPx?: number | null;
-        totalRamMb?: number | null;
-        [key: string]: unknown;
-    } | null;
-    powerControl?: {
-        cec?: boolean | null;
-        softBlackout?: boolean | null;
-        wol?: boolean | null;
-        [key: string]: unknown;
-    } | null;
-    wifiCsiSensing?: {
-        csiAvailable?: boolean | null;
-        csiHardwareType?: string | null;
-        csiNodeCount?: number | null;
-        [key: string]: unknown;
-    } | null;
-    [key: string]: unknown;
-};
-type HttpProbeResult = {
-    host: string;
-    port?: number | null;
-    server?: string | null;
-    [key: string]: unknown;
-};
-type MdnsNetworkDevice = {
-    host?: string | null;
-    instanceName: string;
-    mdnsModel?: string | null;
-    mdnsSoftwareVersion?: string | null;
-    mdnsVendor?: string | null;
-    port?: number | null;
-    serviceType: string;
-    [key: string]: unknown;
-};
-type PartnerAdDeliveryProfile = {
-    android_api_level?: number | null;
-    auto_recovery_enabled?: boolean;
-    ima_integration?: "android_native" | "html5_webview" | "disabled" | "unknown";
-    mode?: "ima_sdk" | "vast_fallback";
-    notes?: Array<string>;
-    reason?: string;
-    webview_chromium_major?: number | null;
-};
-/**
- * Heartbeat payload from agent-core / agent-core-lite Android partner
- * SDKs. Only includes fields verified populated in production
- * `signal_observations` (last 30 days). Stub fields wired in Kotlin but
- * never observed in CH are intentionally excluded; re-add only after
- * telemetry confirms >1% population over 7 days.
- *
- */
-type PartnerDeviceHeartbeatBody = {
-    advertisingId?: string | null;
-    advertisingIdType?: "gaid" | "idfa" | null | null;
-    bleDeviceCount?: number;
-    capabilities?: DeviceCapabilityPayload;
-    discoveredNetworkDevices?: Array<MdnsNetworkDevice> | null;
-    fingerprint?: string;
-    gatewayIpHash?: string | null;
-    httpProbes?: Array<HttpProbeResult> | null;
-    limitAdTracking?: boolean | null;
-    metadata?: Record<string, unknown>;
-    /** Capped at 50 devices (RSSI-sorted, strongest first). */
-    nearbyBleDevices?: Array<BleScanResultData> | null;
-    nearbyWifiNetworks?: Array<WifiScanResult> | null;
-    networkDeviceCount?: number;
-    /** Heartbeat schema version (1=baseline, 2=nativeSensorSnapshot) */
-    schemaVersion?: number;
-    screenId?: string | null;
-    /** Per-source skip-reason counter map. Shape `{source: {reason: count}}`. */
-    skipReasonCounts?: Record<string, Record<string, number>>;
-    ssdpDevices?: Array<SsdpDeviceInfo> | null;
-    status?: string;
-    wifiBssidHash?: string | null;
-    wifiEnvironment?: WifiEnvironmentSnapshot;
-    wifiNetworkCount?: number;
-    wifiSsidHash?: string | null;
-    [key: string]: unknown;
-};
-type PartnerHeartbeatCommand = {
-    /** Command normalized for partner SDK compatibility. */
-    command?: string;
-    id?: string;
-    payload?: Record<string, unknown>;
-    queued_at?: string;
-};
-type PartnerHeartbeatData = {
-    ad_delivery_profile?: PartnerAdDeliveryProfile;
-    commands?: Array<PartnerHeartbeatCommand>;
-    last_seen_at?: string;
-    status?: "online" | "offline";
-};
-type PartnerHeartbeatMeasurementMetadata = {
-    ageSeconds?: number | null;
-    cachedAt?: string | null;
-    receivedAt?: string | null;
-    source?: "redis_twin" | "pg_fallback" | "unknown";
-    [key: string]: unknown;
-};
-type PartnerHeartbeatQueryData = {
-    adDeliveryProfile?: PartnerAdDeliveryProfile;
-    deviceId: string;
-    lastHeartbeatAt?: string | null;
-    measurementMetadata?: PartnerHeartbeatMeasurementMetadata;
-    stalenessSeconds?: number | null;
-    telemetry?: PartnerSafeHeartbeatTelemetry;
-    [key: string]: unknown;
-};
-type PartnerHeartbeatQueryResponse = {
-    data?: PartnerHeartbeatQueryData;
-    success?: boolean;
-};
-/**
- * Optional heartbeat payload. Nested telemetry objects are preferred; legacy flat keys
- * are still accepted for backward compatibility.
- *
- */
-type PartnerHeartbeatRequest = {
-    ad?: {
-        last_vast_request_at?: string;
-        last_vast_response_at?: string;
-        proof_of_play_enabled?: boolean;
-    };
-    agent_status?: string;
-    agent_version?: string;
-    android_api_level?: number;
-    brightness?: number;
-    desugaring_enabled?: boolean;
-    device?: {
-        android_api_level?: number;
-        make?: string;
-        model?: string;
-        os?: string;
-        osv?: string;
-        webview_chromium_major?: number;
-    };
-    ima_integration?: "android_native" | "html5_webview" | "disabled" | "unknown";
-    ima_sdk_version?: string;
-    ima_support_reason?: string;
-    ima_supported?: boolean;
-    input_source?: string;
-    last_ima_error_code?: number;
-    last_vast_error_code?: number;
-    last_vast_request_at?: string;
-    last_vast_response_at?: string;
-    /** Alternate namespace for telemetry keys (legacy support). */
-    metadata?: Record<string, unknown>;
-    muted?: boolean;
-    network?: {
-        bandwidthMbps?: number;
-        connectionType?: string;
-        downlinkMbps?: number;
-        effectiveType?: string;
-        latencyRtt?: number;
-        rtt?: number;
-        saveData?: boolean;
-    };
-    network_strength_dbm?: number;
-    power_state?: "on" | "standby" | "off" | "unknown";
-    proof_of_play_enabled?: boolean;
-    sdk?: {
-        android_api_level?: number;
-        desugaring_enabled?: boolean;
-        ima_integration?: "android_native" | "html5_webview" | "disabled" | "unknown";
-        ima_sdk_version?: string;
-        ima_supported?: boolean;
-        version?: string;
-        webview_chromium_major?: number;
-    };
-    sdk_version?: string;
-    telemetry?: PartnerHeartbeatTelemetry;
-    temperature_c?: number;
-    uptime_seconds?: number;
-    volume?: number;
-    webview_chromium_major?: number;
-};
-type PartnerHeartbeatResponse = {
-    data?: PartnerHeartbeatData;
-    success?: boolean;
-};
-type PartnerHeartbeatTelemetry = {
-    agentStatus?: string;
-    agentVersion?: string;
-    android_api_level?: number;
-    bandwidthMbps?: number;
-    brightness?: number;
-    connectionType?: string;
-    desugaring_enabled?: boolean;
-    downlinkMbps?: number;
-    ima_integration?: "android_native" | "html5_webview" | "disabled" | "unknown";
-    ima_sdk_version?: string;
-    ima_support_reason?: string;
-    ima_supported?: boolean;
-    inputSource?: string;
-    last_ima_error_code?: number;
-    last_vast_error_code?: number;
-    last_vast_request_at?: string;
-    last_vast_response_at?: string;
-    latencyRtt?: number;
-    make?: string;
-    model?: string;
-    muted?: boolean;
-    networkConnectionType?: string;
-    networkEffectiveType?: string;
-    networkStrengthDbm?: number;
-    os?: string;
-    osVersion?: string;
-    osv?: string;
-    powerState?: "on" | "standby" | "off" | "unknown";
-    proof_of_play_enabled?: boolean;
-    rtt?: number;
-    saveData?: boolean;
-    temperatureC?: number;
-    uptimeSeconds?: number;
-    volume?: number;
-    webview_chromium_major?: number;
-    [key: string]: unknown;
-};
-/**
- * Partner-safe subset of device telemetry. Strips MDM compliance,
- * Vertex embeddings, identity-correction internals, partner identifiers,
- * and Mongo `_id` so partners only see what they need to decide
- * whether a device is healthy enough to receive ads.
- *
- */
-type PartnerSafeHeartbeatTelemetry = {
-    agentStatus?: string | null;
-    agentVersion?: string | null;
-    bandwidthMbps?: number | null;
-    brightness?: number | null;
-    connectionType?: string | null;
-    consecutiveAdFailures?: number | null;
-    effectiveType?: string | null;
-    latencyRtt?: number | null;
-    make?: string | null;
-    model?: string | null;
-    muted?: boolean | null;
-    networkStrengthDbm?: number | null;
-    onlineStatus?: "online" | "offline" | "standby" | "unknown" | null;
-    os?: string | null;
-    osv?: string | null;
-    powerState?: string | null;
-    temperatureC?: number | null;
-    ua?: string | null;
-    uptimeSeconds?: number | null;
-    visibilityState?: string | null;
-    volume?: number | null;
-    [key: string]: unknown;
-};
-type SsdpDeviceInfo = {
-    friendlyName?: string | null;
-    location: string;
-    manufacturer?: string | null;
-    modelName?: string | null;
-    server?: string | null;
-    st: string;
-    udn?: string | null;
-    [key: string]: unknown;
-};
-type WifiEnvironmentSnapshot = {
-    channelCongestionRatio?: number | null;
-    connectedChannelWidthMhz?: number | null;
-    connectedFrequencyMhz?: number | null;
-    connectedLinkSpeedMbps?: number | null;
-    connectedSignalDbm?: number | null;
-    frequencyBand?: string | null;
-    medianSignalDbm?: number | null;
-    networkCount?: number | null;
-    rssiVariance?: number | null;
-    scanTimestampMs?: number | null;
-    signalSpreadDbm?: number | null;
-    uniqueBssidCount?: number | null;
-    [key: string]: unknown;
-} | null;
-type WifiScanResult = {
-    channelWidthMhz?: number | null;
-    frequencyMhz: number;
-    rawBssid: string;
-    signalStrengthDbm: number;
-    [key: string]: unknown;
-};
-/**
- * Read live device heartbeat state
- * GET /device/{deviceId}/heartbeat
- */
-interface getDeviceHeartbeatOperation {
-    readonly path: "/device/{deviceId}/heartbeat";
-    readonly method: "GET";
-    request: never;
-    response: PartnerHeartbeatQueryResponse;
-}
-/**
- * Device heartbeat
- * POST /device/{deviceId}/heartbeat
- */
-interface heartbeatOperation {
-    readonly path: "/device/{deviceId}/heartbeat";
-    readonly method: "POST";
-    request: PartnerHeartbeatRequest | PartnerDeviceHeartbeatBody;
-    response: PartnerHeartbeatResponse;
-}
-declare const generatedTypes: {
-    readonly schemaCount: 71;
-    readonly operationCount: 175;
-    readonly schemas: readonly ["Ad", "AdSettings", "AudienceAnalyticsResponse", "AudienceAttentionPrediction", "AudienceExportResponse", "AudienceLoyaltyFeaturesRow", "AudienceMetricsResponse", "AudienceSegment", "AudienceSocialAttention", "BatchResult", "BleScanResultData", "ChangelogEntry", "ChangelogResponse", "ContentPreferencesInput", "ContentPreferencesResponse", "ContentPreset", "DashboardResponse", "DataExportSummaryResponse", "DemographicsResponse", "Device", "DeviceCapabilityPayload", "DeviceSummary", "DisplaySettingsInput", "DisplaySettingsResponse", "EarningsBreakdownResponse", "EarningsResponse", "Error", "HeaderBiddingSettings", "HttpProbeResult", "MdnsNetworkDevice", "Pagination", "Partner", "PartnerAdDeliveryProfile", "PartnerDefaultStream", "PartnerDefaultStreamCreate", "PartnerDefaultStreamUpdate", "PartnerDeviceHeartbeatBody", "PartnerHeartbeatCommand", "PartnerHeartbeatData", "PartnerHeartbeatMeasurementMetadata", "PartnerHeartbeatQueryData", "PartnerHeartbeatQueryResponse", "PartnerHeartbeatRequest", "PartnerHeartbeatResponse", "PartnerHeartbeatTelemetry", "PartnerLBarContent", "PartnerLBarDisplayPreferences", "PartnerLBarSettings", "PartnerSafeHeartbeatTelemetry", "PartnerSelfPromoAd", "PartnerSelfPromoCreate", "PartnerSelfPromoPlacement", "PartnerStats", "PayoutResponse", "PlaygroundResult", "PlaygroundValidationError", "ProgrammaticSettingsInput", "ProgrammaticSettingsResponse", "RequestMetadataResponse", "RolePermissions", "SDKConfig", "ScreenAnalyticsResponse", "SsdpDeviceInfo", "TeamInviteResponse", "TeamMember", "Transaction", "Webhook", "WebhookDelivery", "WebhookEvent", "WifiEnvironmentSnapshot", "WifiScanResult"];
-    readonly operations: readonly ["listPartnerSelfPromoAds", "createPartnerSelfPromoAd", "listPartnerSelfPromoPlacements", "schedulePartnerSelfPromo", "createPartnerSelfPromoUpload", "disableSelfPromoAd", "registerAgent", "getAnalytics", "getAudienceContinuity", "getAudienceProfile", "getBleSummary", "getContentPerformance", "searchCreativeCatalog", "getCreativeScenes", "getCrossScreenFlow", "getPartnerAnalyticsDashboard", "getDeviceSuiteSignature", "exportPartnerAnalytics", "exportPartnerAdsByDay", "getFleetHourly", "getHaloFunnel", "getLoyaltyClock", "getNetworkSummary", "getNetworkTrend", "getProximitySummary", "getRevenueAttentionCorrelation", "getSceneFeed", "getSceneIntelligence", "rotateApiKey", "getAudienceAnalytics", "exportAudienceData", "getAudienceHeatmap", "getLiveAudience", "getLookalikeScreens", "predictScreenAudience", "getResolvedHouseholdReach", "listAudienceSegments", "createAudienceSegment", "deleteAudienceSegment", "getAudienceSegment", "updateAudienceSegment", "matchAudienceSegment", "estimateSegmentReach", "generateSegmentVastTag", "getAudienceStats", "cancelBillingSubscription", "purchaseCredits", "createCreditCheckout", "listBillingPlans", "setupBilling", "createBillingSubscription", "getBillingSubscription", "getBillingUsage", "getUsageSummary", "stripeWebhookCallback", "getConnectDashboard", "getConnectEarningsChart", "getConnectScreenHealth", "listContentPresets", "getContentPreset", "getDashboard", "exportProximityGraphEdges", "getDataExportSummary", "exportDataset", "getGeohashAudiencePanel", "registerDevice", "deleteDevice", "getDevice", "updateDevice", "getAdsForDevice", "ackDeviceCommand", "getDeviceHeartbeat", "heartbeat", "recordProgrammaticEvent", "listDevices", "registerDevicesBatch", "batchUpdateDeviceOrientation", "partnerDocsBrowser", "getEarnings", "getEarningsBreakdown", "requestPayout", "getTransactions", "getActiveSSEConnections", "subscribeToEvents", "getFleetAnalytics", "pushFleetCommand", "getFleetOverview", "updateFleetSettings", "recordImpressionGet", "recordImpressionPost", "recordImpressionsBatch", "getPartnerInfo", "listIntentCategories", "getIntentCategory", "getIntentPricing", "getMeasurementMethodology", "getNetworkConfig", "patchNetworkConfig", "updateNetworkConfig", "getNetworkTrends", "partnerPing", "partnerPingAuth", "getPricing", "quickStart", "registerPartner", "generateSandboxEvent", "resetSandbox", "createSandboxScreen", "getSandboxStatus", "getScreenAudienceSegments", "batchUpdateContentPreferences", "batchUpdateDisplaySettings", "batchUpdateProgrammaticSettings", "resolvePartnerScreen", "getScreenAnalytics", "getPartnerScreenAtmosphere", "getPartnerScreenIntelligence", "getPartnerScreenTasteProfile", "getPartnerScreenTraffic", "getPartnerScreenVAS", "applyContentPreset", "getAudienceMetrics", "getContentPreferences", "patchContentPreferences", "updateContentPreferences", "listPartnerDefaultStreams", "createPartnerDefaultStream", "createPartnerDefaultStreamImages", "reorderPartnerDefaultStreams", "createPartnerDefaultStreamUpload", "deletePartnerDefaultStream", "updatePartnerDefaultStream", "getScreenDemographics", "getDisplaySettings", "patchDisplaySettings", "updateDisplaySettings", "getPartnerLBarSettings", "updatePartnerLBarSettings", "updatePartnerLBarLiveUpdates", "getProgrammaticSettings", "patchProgrammaticSettings", "updateProgrammaticSettings", "createStripeConnectAccount", "getStripeLoginLink", "getStripeOnboardingLink", "requestStripePayout", "getStripePayoutHistory", "getStripeAccountStatus", "handleStripeWebhook", "listTeamMembers", "acceptInvitation", "inviteTeamMember", "getInvitationByToken", "resendInvitation", "removeTeamMember", "changeTeamMemberRole", "getTrackingPublicKey", "recordTrackingBatch", "getUsageSummary__get__usage", "getUsageDashboard", "getRateLimitStatus", "queryChangelog", "playgroundDryRun", "getRequestMetadata", "getVastConfig", "getVenuesNearby", "getVenueAtmosphere", "getVenueTraffic", "getVenueIntelligence", "listWebhooks", "createWebhook", "deleteWebhook", "updateWebhook", "getWebhookDeliveries", "testWebhook"];
-};
-type GeneratedSchemaName = (typeof generatedTypes.schemas)[number];
-type GeneratedOperationName = (typeof generatedTypes.operations)[number];
+declare const VERSION = "1.0.0";
 
-export { AnalyticsClient, type AnalyticsData, type ApiErrorType, AudienceClient, type AudienceData, BillingClient, type BillingInfo, type BleScanResultData, type ClientOptions, type ConstructEventOptions, DataClient, type Device, type DeviceCapabilityPayload, DevicesClient, EarningsClient, type EarningsData, type ErrorDetail, type ErrorEntry, type ErrorResponseBody, ErrorsClient, FleetClient, type FleetCommand, type GeneratedOperationName, type GeneratedSchemaName, type HttpProbeResult, type Impression, ImpressionsClient, type ListResponse, type MdnsNetworkDevice, type ParsedSignatureHeader, type PartnerAdDeliveryProfile, type PartnerDeviceHeartbeatBody, type PartnerHeartbeatMeasurementMetadata, type PartnerHeartbeatQueryData, type PartnerHeartbeatQueryResponse, type PartnerHeartbeatRequest, type PartnerHeartbeatResponse, type PartnerSafeHeartbeatTelemetry, type RequestOptions, type RetryOptions, type Screen, ScreensClient, type SsdpDeviceInfo, TrillboardsClient, TrillboardsError, type TrillboardsErrorOptions, VERSION, type Webhook, type WebhookEvent, type WebhookHeaders, Webhooks, WebhooksClient, type WifiEnvironmentSnapshot, type WifiScanResult, constructEvent, constructEventLegacy, generatedTypes, type getDeviceHeartbeatOperation, type heartbeatOperation, parseSignatureHeader, retryWithBackoff };
+export { AnalyticsClient, AnalyticsData, type ApiErrorType, AudienceClient, AudienceData, BillingClient, BillingInfo, type ClientOptions, type ConstructEventOptions, type ContentFitMode, CreatePartnerSensingRouteRequest, DataClient, Device, DevicesClient, DisplaySettingsInput, DisplaySettingsResponse, EarningsClient, EarningsData, type ErrorDetail, ErrorEntry, type ErrorResponseBody, ErrorsClient, FleetClient, FleetCommand, Impression, ImpressionsClient, type ListResponse, type ParsedSignatureHeader, PartnerDeviceBatchRegistrationInput, PartnerDeviceRegistrationInput, type RequestOptions, type RetryOptions, type RouteAction, type RouteChannel, type RouteCondition, type RouteConditionOp, type RouteDigest, type RouteDigestSummary, type RouteWebhookEvent, RoutesClient, Screen, ScreensClient, SensingRoute, type SensingThresholdCrossedEvent, TrillboardsClient, TrillboardsError, type TrillboardsErrorOptions, UpdatePartnerSensingRouteRequest, VERSION, Webhook, WebhookEvent, type WebhookHeaders, Webhooks, WebhooksClient, constructEvent, constructEventLegacy, parseSignatureHeader, retryWithBackoff };