@trillboards/api-client 3.2.32 → 3.2.34

package/dist/generated.d.mts

@@ -589,7 +589,7 @@ type CreatePartnerSensingRouteRequest = {
     /** IANA zone name (e.g. `America/New_York`) the active window is evaluated in, trimmed to 64 characters. Omitting it makes `activeStartMinute`, `activeEndMinute` and `activeDaysMask` inert — the route is then always active — and an unparseable zone fails open. */
     activeTz?: string;
     condition?: SensingRouteCondition;
-    /** Minimum gap in seconds between alerts for the same (route, screen) episode; clamped to 0..86400, default 300. It also bounds the falling-edge clear window at 60 s, so a value below that re-arms the route faster too. */
+    /** Minimum gap in seconds between alerts for the same (route, screen) episode; clamped to 0..86400, default 300. It also bounds the falling-edge clear window at 60 s (unless `episodeClearSeconds` is set), so a value below that re-arms the route faster too. */
     debounceSeconds?: number;
     /** Required when mode=digest. `field` is required for avg/max. */
     digest?: {
@@ -600,6 +600,8 @@ type CreatePartnerSensingRouteRequest = {
     };
     /** Only the JSON literal `false` creates the route disabled — any other value, including `0` and the string `"false"`, creates it enabled. Note the update endpoint inverts this test, so send a real boolean on both. */
     enabled?: boolean;
+    /** Seconds the condition must read false before this alert can send again (its episode ends); 1..86400. Omit for the default, min(debounceSeconds, 60). Use it to send once per event that stays in view: 600 holds a parked car through a misread, 3600 sends once per stretch of activity in a back room. */
+    episodeClearSeconds?: number;
     /** `threshold` (the default) needs a `condition` and evaluates every incoming observation. `digest` needs a `digest` block instead, sends on a schedule, and rejects `screenFocusRegions` and explicit review timing. Only the exact string `digest` selects digest mode; anything else falls back to `threshold`. */
     mode?: "threshold" | "digest";
     /** Operator-supplied label, required, trimmed and capped at 200 characters. It is delivered as `route_name` on every fire and shown in operator surfaces; it is not the alert text. */
@@ -8950,7 +8952,7 @@ type SensingRoute = {
     /** `null` on a `count`-metric digest route (there is nothing to aggregate over). On an `avg`/`max` digest it carries only `field`, with `op` and `value` absent — only a `threshold`-mode route has a complete condition. */
     condition?: SensingRouteCondition | null;
     createdAt?: string;
-    /** Minimum gap in seconds between alerts for the same (route, screen) episode; clamped to 0..86400 and defaulting to 300. It also caps the falling-edge clear window (60 s maximum), so a shorter debounce re-arms the route sooner as well as spacing alerts more tightly. */
+    /** Minimum gap in seconds between alerts for the same (route, screen) episode; clamped to 0..86400 and defaulting to 300. It also caps the falling-edge clear window (60 s maximum) unless `episodeClearSeconds` is set, so a shorter debounce re-arms the route sooner as well as spacing alerts more tightly. */
     debounceSeconds?: number;
     /** Scheduled-aggregate configuration; `null` on `threshold` routes. `nextRunAt` is a server-held cursor the digest cron advances after every send, so it moves on its own without any edit from you. */
     digest?: {
@@ -8961,6 +8963,8 @@ type SensingRoute = {
     } | null;
     /** Whether the evaluator considers this route at all. A disabled route keeps its condition, actions and screen set and is simply skipped by every hot-path read; deleting a route also sets this `false` (rows are soft-deleted, never removed). */
     enabled?: boolean;
+    /** Seconds the condition must read false before this alert can send again (its episode ends). `null` = the default: min(debounceSeconds, 60). Set it for an event that stays in view and can misread for over a minute while it is still there, such as a parked car. */
+    episodeClearSeconds?: number | null;
     /** `threshold` evaluates `condition` against each incoming observation. `digest` ignores the condition and instead sends a scheduled aggregate driven by the `digest.nextRunAt` cursor; focus regions and explicit review timing are rejected on digest routes. */
     mode?: "threshold" | "digest";
     /** Operator-supplied label, trimmed and capped at 200 characters. It is delivered verbatim as `route_name` on every fire but is not the alert text — the human-readable message is composed separately from the screen's sensing intent. */
@@ -9259,6 +9263,8 @@ type UpdatePartnerSensingRouteRequest = {
     };
     /** Only the JSON literal `true` enables the route here — every other value, including the string `"true"` and `1`, is written as `false`. This is the mirror image of create, where only the literal `false` disables, so send a real boolean. */
     enabled?: boolean;
+    /** Seconds the condition must read false before this alert can send again (1..86400); send `null` to return to the default, min(debounceSeconds, 60). Changing it keeps an open episode. */
+    episodeClearSeconds?: number | null;
     /** Replaces the label. Must be a non-empty string after trimming and at most 200 characters; sending an empty or whitespace-only name is a 400 rather than a clear. */
     name?: string;
     /** Rebinds the route to a different named sensing profile; send `null` (or an empty/whitespace string) to unbind it. Always a profile NAME — a `profile_id` is re-minted on every redeploy and would orphan the binding. */
@@ -10153,7 +10159,7 @@ interface getMetricDemographicShareOperation {
     query: {
         /** One day (YYYY-MM-DD). Give day or window; neither is the last settled day. */
         day?: string;
-        /** Comma-separated dimensions (dimension= is the one-value spelling): the audience dimensions of a demographics metric (default all), or the slices creative_brand_history cuts its rows by (category, parent, agency, media_owner, format, surface, board, cbsa; default none), every share over its slice. This metric's: `activity_state`, `age`, `apparel_tier`, `attire`, `carried_items`, `cohort`, `device_engagement`, `diet`, `exposure_quality`, `gender`, `head_turn`, `income`, `intent`, `lifestage`, `lifestyle`, `mood`, `occupant_position`, `seatbelt_state`, `tech`, `venue`. */
+        /** Comma-separated dimensions (dimension= is the one-value spelling): the audience dimensions of a demographics metric (default all), or the slices creative_brand_history cuts its rows by (category, parent, agency, media_owner, format, surface, board, cbsa; default none), every share over its slice. This metric's: `activity_state`, `age`, `apparel_tier`, `attire`, `carried_items`, `cohort`, `device_engagement`, `diet`, `gender`, `head_turn`, `income`, `intent`, `lifestage`, `lifestyle`, `mood`, `occupant_position`, `seatbelt_state`, `tech`, `venue`. */
         dimensions?: string;
         /** The answer grain; default `screen_day`. */
         grain?: "screen_hour" | "screen_day" | "screen_daypart_local" | "screen_window" | "fleet_hour" | "fleet_day" | "fleet_daypart_local" | "fleet_window";

package/dist/generated.d.ts

@@ -589,7 +589,7 @@ type CreatePartnerSensingRouteRequest = {
     /** IANA zone name (e.g. `America/New_York`) the active window is evaluated in, trimmed to 64 characters. Omitting it makes `activeStartMinute`, `activeEndMinute` and `activeDaysMask` inert — the route is then always active — and an unparseable zone fails open. */
     activeTz?: string;
     condition?: SensingRouteCondition;
-    /** Minimum gap in seconds between alerts for the same (route, screen) episode; clamped to 0..86400, default 300. It also bounds the falling-edge clear window at 60 s, so a value below that re-arms the route faster too. */
+    /** Minimum gap in seconds between alerts for the same (route, screen) episode; clamped to 0..86400, default 300. It also bounds the falling-edge clear window at 60 s (unless `episodeClearSeconds` is set), so a value below that re-arms the route faster too. */
     debounceSeconds?: number;
     /** Required when mode=digest. `field` is required for avg/max. */
     digest?: {
@@ -600,6 +600,8 @@ type CreatePartnerSensingRouteRequest = {
     };
     /** Only the JSON literal `false` creates the route disabled — any other value, including `0` and the string `"false"`, creates it enabled. Note the update endpoint inverts this test, so send a real boolean on both. */
     enabled?: boolean;
+    /** Seconds the condition must read false before this alert can send again (its episode ends); 1..86400. Omit for the default, min(debounceSeconds, 60). Use it to send once per event that stays in view: 600 holds a parked car through a misread, 3600 sends once per stretch of activity in a back room. */
+    episodeClearSeconds?: number;
     /** `threshold` (the default) needs a `condition` and evaluates every incoming observation. `digest` needs a `digest` block instead, sends on a schedule, and rejects `screenFocusRegions` and explicit review timing. Only the exact string `digest` selects digest mode; anything else falls back to `threshold`. */
     mode?: "threshold" | "digest";
     /** Operator-supplied label, required, trimmed and capped at 200 characters. It is delivered as `route_name` on every fire and shown in operator surfaces; it is not the alert text. */
@@ -8950,7 +8952,7 @@ type SensingRoute = {
     /** `null` on a `count`-metric digest route (there is nothing to aggregate over). On an `avg`/`max` digest it carries only `field`, with `op` and `value` absent — only a `threshold`-mode route has a complete condition. */
     condition?: SensingRouteCondition | null;
     createdAt?: string;
-    /** Minimum gap in seconds between alerts for the same (route, screen) episode; clamped to 0..86400 and defaulting to 300. It also caps the falling-edge clear window (60 s maximum), so a shorter debounce re-arms the route sooner as well as spacing alerts more tightly. */
+    /** Minimum gap in seconds between alerts for the same (route, screen) episode; clamped to 0..86400 and defaulting to 300. It also caps the falling-edge clear window (60 s maximum) unless `episodeClearSeconds` is set, so a shorter debounce re-arms the route sooner as well as spacing alerts more tightly. */
     debounceSeconds?: number;
     /** Scheduled-aggregate configuration; `null` on `threshold` routes. `nextRunAt` is a server-held cursor the digest cron advances after every send, so it moves on its own without any edit from you. */
     digest?: {
@@ -8961,6 +8963,8 @@ type SensingRoute = {
     } | null;
     /** Whether the evaluator considers this route at all. A disabled route keeps its condition, actions and screen set and is simply skipped by every hot-path read; deleting a route also sets this `false` (rows are soft-deleted, never removed). */
     enabled?: boolean;
+    /** Seconds the condition must read false before this alert can send again (its episode ends). `null` = the default: min(debounceSeconds, 60). Set it for an event that stays in view and can misread for over a minute while it is still there, such as a parked car. */
+    episodeClearSeconds?: number | null;
     /** `threshold` evaluates `condition` against each incoming observation. `digest` ignores the condition and instead sends a scheduled aggregate driven by the `digest.nextRunAt` cursor; focus regions and explicit review timing are rejected on digest routes. */
     mode?: "threshold" | "digest";
     /** Operator-supplied label, trimmed and capped at 200 characters. It is delivered verbatim as `route_name` on every fire but is not the alert text — the human-readable message is composed separately from the screen's sensing intent. */
@@ -9259,6 +9263,8 @@ type UpdatePartnerSensingRouteRequest = {
     };
     /** Only the JSON literal `true` enables the route here — every other value, including the string `"true"` and `1`, is written as `false`. This is the mirror image of create, where only the literal `false` disables, so send a real boolean. */
     enabled?: boolean;
+    /** Seconds the condition must read false before this alert can send again (1..86400); send `null` to return to the default, min(debounceSeconds, 60). Changing it keeps an open episode. */
+    episodeClearSeconds?: number | null;
     /** Replaces the label. Must be a non-empty string after trimming and at most 200 characters; sending an empty or whitespace-only name is a 400 rather than a clear. */
     name?: string;
     /** Rebinds the route to a different named sensing profile; send `null` (or an empty/whitespace string) to unbind it. Always a profile NAME — a `profile_id` is re-minted on every redeploy and would orphan the binding. */
@@ -10153,7 +10159,7 @@ interface getMetricDemographicShareOperation {
     query: {
         /** One day (YYYY-MM-DD). Give day or window; neither is the last settled day. */
         day?: string;
-        /** Comma-separated dimensions (dimension= is the one-value spelling): the audience dimensions of a demographics metric (default all), or the slices creative_brand_history cuts its rows by (category, parent, agency, media_owner, format, surface, board, cbsa; default none), every share over its slice. This metric's: `activity_state`, `age`, `apparel_tier`, `attire`, `carried_items`, `cohort`, `device_engagement`, `diet`, `exposure_quality`, `gender`, `head_turn`, `income`, `intent`, `lifestage`, `lifestyle`, `mood`, `occupant_position`, `seatbelt_state`, `tech`, `venue`. */
+        /** Comma-separated dimensions (dimension= is the one-value spelling): the audience dimensions of a demographics metric (default all), or the slices creative_brand_history cuts its rows by (category, parent, agency, media_owner, format, surface, board, cbsa; default none), every share over its slice. This metric's: `activity_state`, `age`, `apparel_tier`, `attire`, `carried_items`, `cohort`, `device_engagement`, `diet`, `gender`, `head_turn`, `income`, `intent`, `lifestage`, `lifestyle`, `mood`, `occupant_position`, `seatbelt_state`, `tech`, `venue`. */
         dimensions?: string;
         /** The answer grain; default `screen_day`. */
         grain?: "screen_hour" | "screen_day" | "screen_daypart_local" | "screen_window" | "fleet_hour" | "fleet_day" | "fleet_daypart_local" | "fleet_window";