@trillboards/api-client 1.2.0 → 1.2.2

package/dist/generated.d.mts

@@ -431,7 +431,11 @@ type CreatePartnerSensingRouteRequest = {
     profileName?: string;
     /** Screens to watch — all owned by this partner (foreign → 403). Provide EITHER screenMongoIds OR targetGroupId, not both. */
     screenMongoIds?: Array<string>;
+    /** DEPRECATED and rejected on write with 400. A duration expressed as N readings inside a fixed window can only be satisfied by a screen reporting faster than window/(N-1) seconds, and nothing knows that rate when the route is saved - so the route saves cleanly and then never fires at all. Send sustainSeconds instead. Still honoured for rows that already carry it. */
     sustainMinSamples?: number;
+    /** How long the condition must hold before the FIRST alert, in seconds (600 = ten minutes). Omit to alert on the first true reading. Cadence-independent, because the evaluator compares timestamps - correct however often the screen reports, including when that rate changes while the condition holds. */
+    sustainSeconds?: number;
+    /** DEPRECATED and rejected on write with 400. A duration expressed as N readings inside a fixed window can only be satisfied by a screen reporting faster than window/(N-1) seconds, and nothing knows that rate when the route is saved - so the route saves cleanly and then never fires at all. Send sustainSeconds instead. Still honoured for rows that already carry it. */
     sustainWindowSeconds?: number;
     /** A sg_ Screen Group id (owned by this partner) to target instead of an explicit screen set. The route fires on the group's live members. Requires SENSING_ROUTES_GROUP_TARGET_ENABLED. */
     targetGroupId?: string;
@@ -1000,7 +1004,7 @@ type MeasurementMethodology = {
     canonical_path?: string;
     /** What each screen observes and what is dropped at the edge. */
     capture_stack?: Record<string, unknown>;
-    /** Cross-day identity, including measured coverage (~31%). */
+    /** Cross-day identity, including measured coverage (1.6% of identifiable BLE rows). An earlier revision said ~31%; that graded the presence of stable_payload_hash and ignored the sanitizer the identity expression applies, and it is withdrawn. */
     cross_day_matching?: Record<string, unknown>;
     display_exposure_zone?: Record<string, unknown>;
     dwell_qualification_thresholds?: Record<string, unknown>;
@@ -1010,6 +1014,8 @@ type MeasurementMethodology = {
     fallback_path?: string;
     /** How identifiers are keyed, and what erasure means. */
     hashing?: Record<string, unknown>;
+    /** The counting UNIT. Reach and unique-device counts are counts of BLE identifiers, not devices and not people; one device contributes several identifiers per window and the number grows with the window. Carries the measured identifiers-per-device per fleet type and the controlled comparison it was derived from. */
+    identifier_inflation?: Record<string, unknown>;
     mrc_ooh_phase2_alignment: Record<string, unknown>;
     parser_versions?: Record<string, unknown>;
     /** k-anonymity floor and differential-privacy budget. */
@@ -1967,7 +1973,11 @@ type SensingRoute = {
     profileName?: string | null;
     routeId?: string;
     screenMongoIds?: Array<string>;
+    /** DEPRECATED and rejected on write with 400. A duration expressed as N readings inside a fixed window can only be satisfied by a screen reporting faster than window/(N-1) seconds, and nothing knows that rate when the route is saved - so the route saves cleanly and then never fires at all. Send sustainSeconds instead. Still honoured for rows that already carry it. */
     sustainMinSamples?: number;
+    /** How long the condition must hold before the FIRST alert, in seconds (600 = ten minutes). Omit to alert on the first true reading. Cadence-independent, because the evaluator compares timestamps - correct however often the screen reports, including when that rate changes while the condition holds. */
+    sustainSeconds?: number | null;
+    /** DEPRECATED and rejected on write with 400. A duration expressed as N readings inside a fixed window can only be satisfied by a screen reporting faster than window/(N-1) seconds, and nothing knows that rate when the route is saved - so the route saves cleanly and then never fires at all. Send sustainSeconds instead. Still honoured for rows that already carry it. */
     sustainWindowSeconds?: number;
     /** The sg_ Screen Group this route targets. When set, the route fires on the group's LIVE members (screenMongoIds reflects the resolved members at read time) and no explicit screens are stored. */
     targetGroupId?: string | null;
@@ -2138,7 +2148,11 @@ type UpdatePartnerSensingRouteRequest = {
     name?: string;
     profileName?: string | null;
     screenMongoIds?: Array<string>;
+    /** DEPRECATED and rejected on write with 400. A duration expressed as N readings inside a fixed window can only be satisfied by a screen reporting faster than window/(N-1) seconds, and nothing knows that rate when the route is saved - so the route saves cleanly and then never fires at all. Send sustainSeconds instead. Still honoured for rows that already carry it. */
     sustainMinSamples?: number;
+    /** How long the condition must hold before the FIRST alert, in seconds (600 = ten minutes). Omit to alert on the first true reading. Cadence-independent, because the evaluator compares timestamps - correct however often the screen reports, including when that rate changes while the condition holds. */
+    sustainSeconds?: number;
+    /** DEPRECATED and rejected on write with 400. A duration expressed as N readings inside a fixed window can only be satisfied by a screen reporting faster than window/(N-1) seconds, and nothing knows that rate when the route is saved - so the route saves cleanly and then never fires at all. Send sustainSeconds instead. Still honoured for rows that already carry it. */
     sustainWindowSeconds?: number;
     /** Set to a sg_ group id to (re)target the group's live members, or null to switch back to an explicit screenMongoIds set. Mutually exclusive with screenMongoIds in one request. */
     targetGroupId?: string | null;

package/dist/generated.d.ts

@@ -431,7 +431,11 @@ type CreatePartnerSensingRouteRequest = {
     profileName?: string;
     /** Screens to watch — all owned by this partner (foreign → 403). Provide EITHER screenMongoIds OR targetGroupId, not both. */
     screenMongoIds?: Array<string>;
+    /** DEPRECATED and rejected on write with 400. A duration expressed as N readings inside a fixed window can only be satisfied by a screen reporting faster than window/(N-1) seconds, and nothing knows that rate when the route is saved - so the route saves cleanly and then never fires at all. Send sustainSeconds instead. Still honoured for rows that already carry it. */
     sustainMinSamples?: number;
+    /** How long the condition must hold before the FIRST alert, in seconds (600 = ten minutes). Omit to alert on the first true reading. Cadence-independent, because the evaluator compares timestamps - correct however often the screen reports, including when that rate changes while the condition holds. */
+    sustainSeconds?: number;
+    /** DEPRECATED and rejected on write with 400. A duration expressed as N readings inside a fixed window can only be satisfied by a screen reporting faster than window/(N-1) seconds, and nothing knows that rate when the route is saved - so the route saves cleanly and then never fires at all. Send sustainSeconds instead. Still honoured for rows that already carry it. */
     sustainWindowSeconds?: number;
     /** A sg_ Screen Group id (owned by this partner) to target instead of an explicit screen set. The route fires on the group's live members. Requires SENSING_ROUTES_GROUP_TARGET_ENABLED. */
     targetGroupId?: string;
@@ -1000,7 +1004,7 @@ type MeasurementMethodology = {
     canonical_path?: string;
     /** What each screen observes and what is dropped at the edge. */
     capture_stack?: Record<string, unknown>;
-    /** Cross-day identity, including measured coverage (~31%). */
+    /** Cross-day identity, including measured coverage (1.6% of identifiable BLE rows). An earlier revision said ~31%; that graded the presence of stable_payload_hash and ignored the sanitizer the identity expression applies, and it is withdrawn. */
     cross_day_matching?: Record<string, unknown>;
     display_exposure_zone?: Record<string, unknown>;
     dwell_qualification_thresholds?: Record<string, unknown>;
@@ -1010,6 +1014,8 @@ type MeasurementMethodology = {
     fallback_path?: string;
     /** How identifiers are keyed, and what erasure means. */
     hashing?: Record<string, unknown>;
+    /** The counting UNIT. Reach and unique-device counts are counts of BLE identifiers, not devices and not people; one device contributes several identifiers per window and the number grows with the window. Carries the measured identifiers-per-device per fleet type and the controlled comparison it was derived from. */
+    identifier_inflation?: Record<string, unknown>;
     mrc_ooh_phase2_alignment: Record<string, unknown>;
     parser_versions?: Record<string, unknown>;
     /** k-anonymity floor and differential-privacy budget. */
@@ -1967,7 +1973,11 @@ type SensingRoute = {
     profileName?: string | null;
     routeId?: string;
     screenMongoIds?: Array<string>;
+    /** DEPRECATED and rejected on write with 400. A duration expressed as N readings inside a fixed window can only be satisfied by a screen reporting faster than window/(N-1) seconds, and nothing knows that rate when the route is saved - so the route saves cleanly and then never fires at all. Send sustainSeconds instead. Still honoured for rows that already carry it. */
     sustainMinSamples?: number;
+    /** How long the condition must hold before the FIRST alert, in seconds (600 = ten minutes). Omit to alert on the first true reading. Cadence-independent, because the evaluator compares timestamps - correct however often the screen reports, including when that rate changes while the condition holds. */
+    sustainSeconds?: number | null;
+    /** DEPRECATED and rejected on write with 400. A duration expressed as N readings inside a fixed window can only be satisfied by a screen reporting faster than window/(N-1) seconds, and nothing knows that rate when the route is saved - so the route saves cleanly and then never fires at all. Send sustainSeconds instead. Still honoured for rows that already carry it. */
     sustainWindowSeconds?: number;
     /** The sg_ Screen Group this route targets. When set, the route fires on the group's LIVE members (screenMongoIds reflects the resolved members at read time) and no explicit screens are stored. */
     targetGroupId?: string | null;
@@ -2138,7 +2148,11 @@ type UpdatePartnerSensingRouteRequest = {
     name?: string;
     profileName?: string | null;
     screenMongoIds?: Array<string>;
+    /** DEPRECATED and rejected on write with 400. A duration expressed as N readings inside a fixed window can only be satisfied by a screen reporting faster than window/(N-1) seconds, and nothing knows that rate when the route is saved - so the route saves cleanly and then never fires at all. Send sustainSeconds instead. Still honoured for rows that already carry it. */
     sustainMinSamples?: number;
+    /** How long the condition must hold before the FIRST alert, in seconds (600 = ten minutes). Omit to alert on the first true reading. Cadence-independent, because the evaluator compares timestamps - correct however often the screen reports, including when that rate changes while the condition holds. */
+    sustainSeconds?: number;
+    /** DEPRECATED and rejected on write with 400. A duration expressed as N readings inside a fixed window can only be satisfied by a screen reporting faster than window/(N-1) seconds, and nothing knows that rate when the route is saved - so the route saves cleanly and then never fires at all. Send sustainSeconds instead. Still honoured for rows that already carry it. */
     sustainWindowSeconds?: number;
     /** Set to a sg_ group id to (re)target the group's live members, or null to switch back to an explicit screenMongoIds set. Mutually exclusive with screenMongoIds in one request. */
     targetGroupId?: string | null;