@encorekit/web-sdk 2.3.0 → 2.4.0

package/types/api/generated/types.d.ts

@@ -143,9 +143,10 @@ export interface paths {
                                     ctaText: string;
                                     /**
                                      * Format: uri
-                                     * @description Optional override for campaign destinationUrl
+                                     * @description The campaign's destination, on a served creative; null where not served
                                      */
                                     destinationUrl: string | null;
+                                    /** @description The campaign's claim tracking, on a served creative; null where not served */
                                     trackingParameters: {
                                         [key: string]: unknown;
                                     } | null;
@@ -291,6 +292,9 @@ export interface paths {
                             latitude?: string;
                             /** @description Decimal degrees as string (e.g., "-122.4194") */
                             longitude?: string;
+                            /** @description Whole years, as an integer. If you hold only a RANGE, send its LOWEST end: "13-17" is sent as 13. Under 18 restricts this request to offers rated for that age, with no per-user personalisation. Used for this request only and never stored. Lower than an age stored through /users/attributes, it wins; higher, the stored one does. A fraction is rounded down, also as a decimal string ("17.9" is 17), a whole-number string is read as its number, and a range string as its lowest end ("13-17" is 13, "65+" is 65); any other value is ignored, never a 400. */
+                            age?: number;
+                            /** @description Deprecated: send age instead. A YYYY-MM-DD date, or an ISO 8601 date-time with a zone, is turned into an age for this request only, then discarded; never stored or logged. If age is also sent, the younger of the two is used. An unreadable date is ignored, never a 400. */
                             dateOfBirth?: string;
                             gender?: string;
                             /** @description BCP 47 language tag; only the language subtag is used for creative locale resolution, and only when the app has that language enabled. Falls back to Accept-Language, then the app default locale. */
@@ -343,6 +347,8 @@ export interface paths {
                         maxPostbackTimeMs?: number;
                         /** @description Send only when this placement carries the app's own prize for a reward-for-trying Yes: the app's daily prize limit from its SDK configuration (PublisherRewardPolicy), clamped server-side to 1..10. The response then carries publisherRewardPromise. Omit it and nothing changes. */
                         publisherRewardDailyLimit?: number;
+                        /** @description Why the client is searching. `purpose: "prefetch"` marks a search the SDK runs before any sheet is shown (a GiftsButton or ClaimReminder checking that offers exist). Its result may later back the sheet the user opens with a tap, so it is a served request like any other, not an impression. It is stamped as purpose on sdk_offer_requested so a report can split these out. Any other value is ignored, never a 400. Serving is identical either way. */
+                        purpose?: string;
                         /** @description Request-scoped serving context. Unknown keys are ignored. */
                         context?: {
                             /** @description Request-scoped activity the user is engaged in at serve time (what the surface is being used for, not a persisted user property). Recognized values: laundry, vending, car_wash, air_vacuum, amusement. Any other value is accepted and recorded on serve analytics, so unrecognized activities show up in reporting rather than failing the request. Does not change which offers are served today. */
@@ -464,9 +470,10 @@ export interface paths {
                                     ctaText: string;
                                     /**
                                      * Format: uri
-                                     * @description Optional override for campaign destinationUrl
+                                     * @description The campaign's destination, on a served creative; null where not served
                                      */
                                     destinationUrl: string | null;
+                                    /** @description The campaign's claim tracking, on a served creative; null where not served */
                                     trackingParameters: {
                                         [key: string]: unknown;
                                     } | null;
@@ -554,15 +561,22 @@ export interface paths {
                                     medianSeconds: number;
                                     p90Seconds: number;
                                 } | null;
-                                /** @description Campaign claim-URL query parameters, keys verbatim (e.g. {"af_rid":"TRANSACTION_ID"}); equals the served creative's whenever one exists. Always pair it with the offer's destinationUrl, never with a creative's, and never build a claim URL from an absent or empty value. Absent unless the campaign offer fields flag is on; null means the campaign has none. */
+                                /** @description This offer's per-offer reward. Present only for an app with reward settings; null when the offer carries no value: in on_yes show the placement's flat prize, in on_verified show no prize (a null value is never paid). Absent: the app has no per-offer rewards. /offers/search only. */
+                                publisherRewardValue?: {
+                                    /** @description Tokens this offer is worth in the app's own unit. The offer_completed webhook's reward.amount carries the value frozen when the user claimed. */
+                                    amount: number;
+                                    /** @description Ready-to-render card text, e.g. "1,500 tokens". Show it in place of the flat PublisherReward title. */
+                                    label: string;
+                                } | null;
+                                /** @description Campaign claim-URL query parameters, keys verbatim (e.g. {"af_rid":"TRANSACTION_ID"}); equals the served creative's whenever one exists. Always pair it with the offer's destinationUrl, never with a creative's, and never build a claim URL from an absent or empty value. Absent from servers that predate it; null means the campaign has none. */
                                 trackingParameters?: {
                                     [key: string]: unknown;
                                 } | null;
-                                /** @description Campaign call-to-action text. Absent unless the campaign offer fields flag is on; null means the campaign has none. */
+                                /** @description Campaign call-to-action text. Absent from servers that predate it; null means the campaign has none. */
                                 ctaText?: string | null;
-                                /** @description Campaign description, localized like creatives. Absent unless the campaign offer fields flag is on; null means the campaign has none. */
+                                /** @description Campaign description, localized like creatives. Absent from servers that predate it; null means the campaign has none. */
                                 description?: string | null;
-                                /** @description Campaign step-by-step instructions, same shape as a creative's. Absent unless the campaign offer fields flag is on; null means the campaign has none. */
+                                /** @description Campaign step-by-step instructions, same shape as a creative's. Absent from servers that predate it; null means the campaign has none. */
                                 instructions?: {
                                     title: string;
                                     subtitle: string;
@@ -570,15 +584,15 @@ export interface paths {
                                     /** @description Optional https image for this step. Absent: the step has none. */
                                     imageUrl?: string;
                                 }[] | null;
-                                /** @description Campaign one-line instructions. Absent unless the campaign offer fields flag is on; null means the campaign has none. */
+                                /** @description Campaign one-line instructions. Absent from servers that predate it; null means the campaign has none. */
                                 quickInstructions?: string | null;
-                                /** @description Campaign logo override; null means use organization.logoUrl. Plain string, not format: uri, so one bad value cannot fail a whole Android decode. Absent unless the campaign offer fields flag is on; null means the campaign has none. */
+                                /** @description Campaign logo override; null means use organization.logoUrl. Plain string, not format: uri, so one bad value cannot fail a whole Android decode. Absent from servers that predate it; null means the campaign has none. */
                                 logoUrl?: string | null;
-                                /** @description Campaign card title. Absent unless the campaign offer fields flag is on; null means the campaign has none. */
+                                /** @description Campaign card title. Absent from servers that predate it; null means the campaign has none. */
                                 title?: string | null;
-                                /** @description Campaign card subtitle. Absent unless the campaign offer fields flag is on; null means the campaign has none. */
+                                /** @description Campaign card subtitle. Absent from servers that predate it; null means the campaign has none. */
                                 subtitle?: string | null;
-                                /** @description Campaign tooltip text. Absent unless the campaign offer fields flag is on; null means the campaign has none. */
+                                /** @description Campaign tooltip text. Absent from servers that predate it; null means the campaign has none. */
                                 tooltipText?: string | null;
                             }[];
                             metadata: {
@@ -597,8 +611,13 @@ export interface paths {
                             };
                             /** @description Resolved locale served in this response (language-only, e.g. 'es'). Absent on pre-localization responses. */
                             locale?: string;
-                            /** @description Whether this user may still be granted the app's prize for a reward-for-trying Yes: true while the prizes granted to them in the last 24 hours (rolling) are under publisherRewardDailyLimit. Present only when the request sent publisherRewardDailyLimit. Offers this user already completed or said Yes to are never served, so this answers the daily limit only. Absent (an older backend, or no limit sent) means no promise. Not a grant: the self-report's granted answer is final. */
+                            /** @description Whether this user is still under the app's daily prize limit (publisherRewardDailyLimit, rolling 24 hours). What counts depends on publisherRewardMode. on_yes (or no mode): prizes granted on a reward-for-trying Yes. on_verified: this user's verified completions that carried a reward, by when they verified; a Yes never grants and never counts, and the reward arrives on the offer_completed webhook. Present only when the request sent publisherRewardDailyLimit. Offers this user already completed or said Yes to are never served, so this answers the daily limit only. Absent (an older backend, or no limit sent) means no promise. Not a grant: in on_yes the self-report's granted answer is final. */
                             publisherRewardPromise?: boolean;
+                            /**
+                             * @description How this app pays its prize. on_yes: a reward-for-trying Yes can grant it (self-report granted). on_verified: a Yes never grants; each offer's publisherRewardValue arrives on the offer_completed webhook when the brand confirms. Present only for an app with reward settings (and always when the promise was counted under on_verified). Decode as a string and treat an unknown value as on_yes.
+                             * @enum {string}
+                             */
+                            publisherRewardMode?: "on_yes" | "on_verified";
                             error?: string | null;
                         };
                     };
@@ -890,6 +909,28 @@ export interface paths {
                              * @enum {string}
                              */
                             platform?: "android" | "ios" | "web";
+                            /** @description Device OS version, e.g. '14' or '17.5.1'. Optional; a malformed value is ignored. */
+                            osVersion?: string | null;
+                            /** @description The END DEVICE's user agent, not the caller's. On the API lane the publisher's server calls us, so the header we see is theirs. Optional; a malformed value is ignored. */
+                            userAgent?: string | null;
+                            /** @description Device advertising id, unhashed: IDFA on iOS, GAID/GPID on Android. Optional, and accepted only from an app whose `deviceIdentifiersMode` is enabled and which is not declared for children or likely used by them; ignored otherwise. Must be a UUID; an all-zero id reads as absent. */
+                            advertisingId?: string | null;
+                            /** @description True when the user has limited ad tracking. Accepts OpenRTB's 0/1 integer too. A consent signal, not a device attribute. Optional; a malformed value counts as true. */
+                            limitAdTracking?: (boolean | null) | 0 | 1;
+                            /** @description OpenRTB `device.dnt`. A consent signal like `limitAdTracking`, and equally underivable. Accepts 0/1 too. Optional; a malformed value counts as true. */
+                            doNotTrack?: (boolean | null) | 0 | 1;
+                            /** @description Public IPv4 or IPv6 address of the END DEVICE, never your server's. Same gate as `advertisingId`. Optional; a malformed, private or reserved address is ignored. */
+                            deviceIp?: string | null;
+                            /** @description OpenRTB `regs.gdpr`: true when GDPR applies to this user. Accepts 0/1 too. Optional; a malformed value counts as true. */
+                            gdprApplies?: (boolean | null) | 0 | 1;
+                            /** @description IAB TCF consent string from your consent tool, forwarded as `user.consent`. Optional; a malformed value is ignored. */
+                            consentString?: string | null;
+                            /** @description IAB Global Privacy Platform string, forwarded as `regs.gpp`. Optional; a malformed value counts as an opt-out. */
+                            gpp?: string | null;
+                            /** @description GPP section ids in force, forwarded as `regs.gpp_sid`. Optional; a malformed value counts as an opt-out. */
+                            gppSid?: number[] | null;
+                            /** @description IAB US Privacy string, e.g. '1YNN', forwarded as `regs.us_privacy`. Optional; a malformed value counts as an opt-out. */
+                            usPrivacy?: string | null;
                         };
                         /** @description Optional publisher-defined label for the surface this offer is shown on (e.g. 'cancel_flow', 'home_feed', 'post_purchase'). Stamped onto the impression AND onto the click it produces, so publisher analytics can break the funnel out by placement. Normalised server-side: a blank value is treated as absent, anything longer than 64 characters is TRUNCATED rather than rejected, and the stored label NEVER carries leading or trailing whitespace, including after truncation, so ' my label ' and 'my label' are always one placement and can never show up as two rows. Case IS significant: 'Cancel_Flow' and 'cancel_flow' are different placements. Omit it and this traffic groups under '(unlabeled)', the same bucket as an SDK integration that supplies no placement. An Encore admin can also configure a per-placement offer rule for an app, in which case this label SELECTS and ORDERS the offers returned for that placement; with no rule configured, which is the default for every app, it stays analytics-only and changes nothing about what is served. */
                         placementId?: string;
@@ -1027,6 +1068,28 @@ export interface paths {
                              * @enum {string}
                              */
                             platform?: "android" | "ios" | "web";
+                            /** @description Device OS version, e.g. '14' or '17.5.1'. Optional; a malformed value is ignored. */
+                            osVersion?: string | null;
+                            /** @description The END DEVICE's user agent, not the caller's. On the API lane the publisher's server calls us, so the header we see is theirs. Optional; a malformed value is ignored. */
+                            userAgent?: string | null;
+                            /** @description Device advertising id, unhashed: IDFA on iOS, GAID/GPID on Android. Optional, and accepted only from an app whose `deviceIdentifiersMode` is enabled and which is not declared for children or likely used by them; ignored otherwise. Must be a UUID; an all-zero id reads as absent. */
+                            advertisingId?: string | null;
+                            /** @description True when the user has limited ad tracking. Accepts OpenRTB's 0/1 integer too. A consent signal, not a device attribute. Optional; a malformed value counts as true. */
+                            limitAdTracking?: (boolean | null) | 0 | 1;
+                            /** @description OpenRTB `device.dnt`. A consent signal like `limitAdTracking`, and equally underivable. Accepts 0/1 too. Optional; a malformed value counts as true. */
+                            doNotTrack?: (boolean | null) | 0 | 1;
+                            /** @description Public IPv4 or IPv6 address of the END DEVICE, never your server's. Same gate as `advertisingId`. Optional; a malformed, private or reserved address is ignored. */
+                            deviceIp?: string | null;
+                            /** @description OpenRTB `regs.gdpr`: true when GDPR applies to this user. Accepts 0/1 too. Optional; a malformed value counts as true. */
+                            gdprApplies?: (boolean | null) | 0 | 1;
+                            /** @description IAB TCF consent string from your consent tool, forwarded as `user.consent`. Optional; a malformed value is ignored. */
+                            consentString?: string | null;
+                            /** @description IAB Global Privacy Platform string, forwarded as `regs.gpp`. Optional; a malformed value counts as an opt-out. */
+                            gpp?: string | null;
+                            /** @description GPP section ids in force, forwarded as `regs.gpp_sid`. Optional; a malformed value counts as an opt-out. */
+                            gppSid?: number[] | null;
+                            /** @description IAB US Privacy string, e.g. '1YNN', forwarded as `regs.us_privacy`. Optional; a malformed value counts as an opt-out. */
+                            usPrivacy?: string | null;
                         };
                         /**
                          * @description Maximum number of offers to return (1–25, default 10). The client controls display order and cycles through them one at a time.
@@ -1291,6 +1354,11 @@ export interface paths {
                          * @enum {string}
                          */
                         useCase?: "churn-intervention" | "post-action-reward";
+                        /**
+                         * Format: uuid
+                         * @description The id of the variant whose remote template rendered this sheet. Absent when the embedded floor rendered. A per-offer reward is frozen on the transaction only when this variant shows per-offer reward values; absent, malformed or unknown means none is frozen. Never a 400.
+                         */
+                        variantId?: string;
                     };
                 };
             };
@@ -1399,6 +1467,137 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/publisher/sdk/v1/transactions/preload": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** @description Reserve the transaction id to substitute for TRANSACTION_ID when preloading an offer link before the claim tap. Not a claim: nothing is counted, stamped or frozen until POST /transactions, which returns this same id when it comes within 30 minutes of the last preload. Send the claim's body. 409 with code 'preloadUnsupported' when this offer's link must not be loaded before a tap; 409 'offerAlreadyCompleted' and the trial-limit 409 as on the claim. Treat any non-200 as no preload. */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        campaignId: string;
+                        userId: string;
+                        /**
+                         * @description Accepted so the claim's body can be sent unchanged; ignored. The claim stamps it.
+                         * @enum {string}
+                         */
+                        useCase?: "churn-intervention" | "post-action-reward";
+                        /**
+                         * Format: uuid
+                         * @description Accepted so the claim's body can be sent unchanged; ignored. Never a 400.
+                         */
+                        variantId?: string;
+                    };
+                };
+            };
+            responses: {
+                /** @description Default Response */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @enum {boolean} */
+                            success: true;
+                            /**
+                             * Format: uuid
+                             * @description The id to substitute for TRANSACTION_ID in the preloaded offer link. The claim returns the same id when it comes within 30 minutes of the last preload; any other id means discard the preload.
+                             */
+                            transactionId: string;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            error: string;
+                            details?: unknown;
+                            /** @description Machine-readable reason, set only on the few errors a client must branch on (each route that sets one says so in its description) and absent on every other. Treat an unknown value as absent. */
+                            code?: string;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            error: string;
+                            details?: unknown;
+                            /** @description Machine-readable reason, set only on the few errors a client must branch on (each route that sets one says so in its description) and absent on every other. Treat an unknown value as absent. */
+                            code?: string;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            error: string;
+                            details?: unknown;
+                            /** @description Machine-readable reason, set only on the few errors a client must branch on (each route that sets one says so in its description) and absent on every other. Treat an unknown value as absent. */
+                            code?: string;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                409: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            error: string;
+                            details?: unknown;
+                            /** @description Machine-readable reason, set only on the few errors a client must branch on (each route that sets one says so in its description) and absent on every other. Treat an unknown value as absent. */
+                            code?: string;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                500: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            error: string;
+                            details?: unknown;
+                            /** @description Machine-readable reason, set only on the few errors a client must branch on (each route that sets one says so in its description) and absent on every other. Treat an unknown value as absent. */
+                            code?: string;
+                        };
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/publisher/sdk/v1/transactions/{transactionId}/signals": {
         parameters: {
             query?: never;
@@ -1572,7 +1771,7 @@ export interface paths {
                              * @description Present when granted is false.
                              * @enum {string}
                              */
-                            reason?: "per_offer" | "daily_cap" | "no_prize";
+                            reason?: "per_offer" | "daily_cap" | "no_prize" | "pays_on_verification";
                             /**
                              * Format: date-time
                              * @description When the server recorded this person's Yes for this offer (the first one, on a retry or a second device).
@@ -2499,6 +2698,11 @@ export interface paths {
                                 variantId: string;
                                 /** @description The name of the selected variant */
                                 variantName: string;
+                                /**
+                                 * Format: uuid
+                                 * @description The SDUI experiment that assigned this variant. Echo it as experiment_id on offer events beside variant_id. Null or absent when no experiment decided the variant.
+                                 */
+                                experimentId?: string | null;
                                 /** @description The minimum SDK version required for this variant */
                                 minSdkVersion: string;
                                 /** @description The SDUI JSON layout configuration */
@@ -2613,7 +2817,7 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** @description Get unified SDK configuration including SDUI, entitlements, experiments, and remote config. This endpoint replaces /ui-config with a cleaner structure. Entitlement mode is implicit: if entitlements.iap.productId exists, use IAP mode; otherwise use Native mode. Pass `useCase` to configure a surface other than churn-intervention; the response echoes it as ui.useCase. `demoVariant` names an SDUI variant to serve for this request. It is honoured on a TEST key (pk_test_*) for any app, and on a live key only for Encore's own demo apps; for every other app it is ignored silently (never an error). It exists for demos and previews: Encore's own demo pages, and a publisher who wants to see the other variants against their own test key. `placementId` selects a variant an admin pinned to that placement, in `ui` only; any label without a pin resolves as before. Requesting a surface is all it takes to be served it — no setup call is required. A surface Encore has explicitly switched off for this app, or one with no variant available, returns ui.template: null — clients must no-op, never reuse another use case's template. */
+        /** @description Get unified SDK configuration including SDUI, entitlements, experiments, and remote config. This endpoint replaces /ui-config with a cleaner structure. Entitlement mode is implicit: if entitlements.iap.productId exists, use IAP mode; otherwise use Native mode. Pass `useCase` to configure a surface other than churn-intervention; the response echoes it as ui.useCase. `demoVariant` names an SDUI variant to serve for this request. It is honoured on a TEST key (pk_test_*) for any app, and on a live key only for Encore's own demo apps; for every other app it is ignored silently (never an error). It exists for demos and previews: Encore's own demo pages, and a publisher who wants to see the other variants against their own test key. `placementId` selects a variant an admin pinned to that placement, in `ui` only; any label without a pin resolves as before. `trigger` makes this a trigger component request (GiftsButton, ClaimReminder): `useCase` is then required and is the real use case it serves, `layout` pins a look and `autoOpen=off` opts the mount out of looks that open the sheet by itself (any other present value also reads as off); a missing useCase or a malformed trigger or layout is a 400. Without `trigger`, `layout` and `autoOpen` are ignored. Requesting a surface is all it takes to be served it — no setup call is required. A surface Encore has explicitly switched off for this app, or one with no variant available, returns ui.template: null — clients must no-op, never reuse another use case's template. */
         get: {
             parameters: {
                 query: {
@@ -2625,8 +2829,28 @@ export interface paths {
                     language?: string;
                     /** @description Which Encore surface is being configured. Omit for today's behaviour. Requesting a surface is all it takes to be served it — no setup call is required. A surface Encore has explicitly switched off for this app, or one with no variant available, resolves to template: null — it NEVER falls back to another use case's template. */
                     useCase?: "churn-intervention" | "post-action-reward";
-                    /** @description Demos and previews only. The SDUI variant file stem to serve for this request, e.g. 'giftUnwrap'. Honoured on a TEST key (pk_test_*) for any app. On a live key it is honoured only for Encore's own demo apps; for every other app it is ignored silently and resolution is unchanged, never an error. Intended for Encore's internal demos and for a publisher previewing the other variants against their own test key. An honoured value bypasses app targeting, experiments and arm weights, and WIDENS the status filter from 'active' to 'active' or 'valid' — the filter is widened, not removed, so a draft, testing, invalid or archived variant is still refused. The use-case partition, the per-app kill switch and the SDK version gate all still apply. Note that a test key also serves the demo campaign catalog rather than live advertiser inventory, and tags the request as test traffic in analytics. */
+                    /** @description Demos and previews only. The SDUI variant file stem to serve for this request, e.g. 'giftUnwrap'. Honoured on a TEST key (pk_test_*) for any app. On a live key it is honoured only for Encore's own demo apps; for every other app it is ignored silently and resolution is unchanged, never an error. On a trigger request with autoOpen=off, an honoured look that opens the sheet by itself is served with behavior.autoOpen 'off'. Intended for Encore's internal demos and for a publisher previewing the other variants against their own test key. An honoured value bypasses app targeting, experiments and arm weights, and WIDENS the status filter from 'active' to 'active' or 'valid' — the filter is widened, not removed, so a draft, testing, invalid or archived variant is still refused. The use-case partition, the per-app kill switch and the SDK version gate all still apply. Note that a test key also serves the demo campaign catalog rather than live advertiser inventory, and tags the request as test traffic in analytics. */
                     demoVariant?: string;
+                    /** @description Present = a trigger component request (GiftsButton, ClaimReminder, customClaim): the camelCase trigger id, e.g. 'giftsButton'. Absent = a sheet request, unchanged. `useCase` is then REQUIRED and names the real use case the trigger serves (a missing useCase or a malformed trigger is a 400). The response's `ui.template` is that trigger's config (`ui.template.trigger` equals this id) or null, and `ui.useCase` echoes the requested use case. Its `root` is an SDUI element tree the SDK draws inline at `root`'s `style.frame.height` (the trigger's height), filling `${...}` from `ui.template.strings` and host values. customClaim (the custom-UI handle, which draws the app's own view) is answered with a rules-only look: layout 'behavior', no `root` or strings, minimal `ui.values`. `ui.template.behavior` names the look's step rules; `behavior.autoOpen` 'on' (an experiment arm only) opens the sheet once by itself, then draws the same look. A holdout carries `ui.experimentId` beside a null template, and `useCases` is always empty. */
+                    trigger?: string;
+                    /** @description Trigger requests only (ignored otherwise): pin the look, a camelCase layout name such as 'card' or 'pill' (malformed = 400). Serves the trigger's variant file marked pin for that layout, never enrolls in an experiment, and returns template null when there is none. */
+                    layout?: string;
+                    /** @description Trigger requests only (ignored otherwise): what happened on the device. 'claimOpen' = an eligible open claim; 'completed' = an offer finished on this local day, none claimed since, its thanks not tapped. The served look's behavior then picks the step's look: claimOpen on a gifts button whose behavior.afterClaim is showReminder is answered with the reminder look (ui.template.trigger claimReminder); completed applies behavior.afterComplete (gifts serves the look, hide serves template null, thanks serves the trigger's thanks look). Any other value is served as no state, and customClaim ignores every state (the device applies its rules). */
+                    state?: string;
+                    /** @description Trigger requests only (ignored otherwise): the mount's opt-out from looks that open the sheet by itself. Send 'off', and only when the mount forbids it; absent means allowed. Any other present value (another case, empty, repeated) is read as 'off', never as allowed, and is never a 400. With it, an experiment with any arm whose behavior.autoOpen is 'on', or whose file cannot be read, is skipped (the request gets the trigger's default look, never a lower experiment, and records no assignment), and any look served to the request carries behavior.autoOpen 'off'. */
+                    autoOpen?: string;
+                    /** @description GiftsButton requests without a layout pin only (ignored otherwise): Distinct local days this placement's button counted an impression, before this request; 0 to 30. Part of the exposure tally the served look's behavior.ifIgnored reads (seenDays, taps and firstSeenDaysAgo are required for it). A value that is not a whole number in range is dropped, never a 400. */
+                    seenDays?: string;
+                    /** @description GiftsButton requests without a layout pin only (ignored otherwise): Mounts at this placement whose impression fired, before this request; 0 to 5. Not used by today's rule. Part of the exposure tally the served look's behavior.ifIgnored reads (seenDays, taps and firstSeenDaysAgo are required for it). A value that is not a whole number in range is dropped, never a 400. */
+                    seenCount?: string;
+                    /** @description GiftsButton requests without a layout pin only (ignored otherwise): User taps on the button (auto pops do not count); 0 to 3. Part of the exposure tally the served look's behavior.ifIgnored reads (seenDays, taps and firstSeenDaysAgo are required for it). A value that is not a whole number in range is dropped, never a 400. */
+                    taps?: string;
+                    /** @description GiftsButton requests without a layout pin only (ignored otherwise): Local days since the first counted impression, 0 when never seen; 0 to 60. Part of the exposure tally the served look's behavior.ifIgnored reads (seenDays, taps and firstSeenDaysAgo are required for it). A value that is not a whole number in range is dropped, never a 400. */
+                    firstSeenDaysAgo?: string;
+                    /** @description GiftsButton requests without a layout pin only (ignored otherwise): Local days since the last user tap, absent when never tapped; 0 to 60. Not used by today's rule. Part of the exposure tally the served look's behavior.ifIgnored reads (seenDays, taps and firstSeenDaysAgo are required for it). A value that is not a whole number in range is dropped, never a 400. */
+                    lastTapDaysAgo?: string;
+                    /** @description GiftsButton requests without a layout pin only (ignored otherwise): ifIgnored answers this device already showed at this placement; 0 to 3, absent reads 0. Part of the exposure tally the served look's behavior.ifIgnored reads (seenDays, taps and firstSeenDaysAgo are required for it). A value that is not a whole number in range is dropped, never a 400. */
+                    nudges?: string;
                     /** @description The publisher's placement label for the surface being configured, e.g. 'email_code'. Optional. When an admin has pinned an SDUI variant to this (app, placement), `ui` serves that variant instead of the experiment assignment, provided it is active or valid, matches the requested use case and passes its SDK version gate and app targeting. Otherwise, and for any label with no pin, resolution is unchanged. Never a 4xx on any input. Applies to `ui` only; the `useCases` prefetch block is never pinned. */
                     placementId?: string;
                 };
@@ -2653,11 +2877,20 @@ export interface paths {
                                 useCase: "churn-intervention" | "post-action-reward";
                                 /**
                                  * Format: uuid
-                                 * @description Selected variant ID
+                                 * @description Selected variant ID. On a trigger step answer that draws nothing (template null with a step: a hide, or thanks with no thanks look), the look whose behavior decided it, so after_complete_hide can name it.
                                  */
                                 variantId?: string | null;
                                 /** @description Selected variant name */
                                 variantName?: string | null;
+                                /**
+                                 * Format: uuid
+                                 * @description The SDUI experiment that assigned this variant. Echo it as experiment_id on offer events beside variant_id. Null or absent when no experiment decided the variant. On a trigger response it is also present when the user was held out (template null), so a trigger can tell a holdout from no experiment; a sheet response never carries it beside a null template.
+                                 */
+                                experimentId?: string | null;
+                                /** @description Trigger responses only: set when the look served (or template null) was chosen by a behavior for the request's `state`, or by the look's behavior.ifIgnored for a gifts button's exposure tally (a non-clicker). Values today: afterClaim, afterComplete, ifIgnored; more may be added, and an SDK treats a value it does not know as no step. With template null and an experimentId, it tells a behavior's hide apart from a holdout (an unknown step with template null is reported as reason unknown_step). Stamp it as step on the trigger events. */
+                                step?: string;
+                                /** @description Trigger responses with a `step` only: the experiment whose look's behavior chose the step (for a reminder in a gifts button spot, the gifts button's), beside experimentId (the drawn look's own; on an afterComplete step, the deciding look's, as a thanks look is in no arm). An opaque id (a UUID today). Stamp it as step_experiment_id on the trigger events. */
+                                stepExperimentId?: string | null;
                                 /** @description Minimum SDK version for this variant */
                                 minSdkVersion?: string | null;
                                 /** @description SDUI template with placeholders */
@@ -2753,6 +2986,11 @@ export interface paths {
                                     variantId: string | null;
                                     /** @description Default variant name; null alongside a null variantId. */
                                     variantName: string | null;
+                                    /**
+                                     * Format: uuid
+                                     * @description The SDUI experiment that assigned this variant, as on `ui.experimentId`. Null or absent when no experiment decided it.
+                                     */
+                                    experimentId?: string | null;
                                     /** @description The default variant's SDUI template. NULL means 'enabled, but nothing to render' — the SDK must no-op on this surface. It must NEVER substitute another use case's template. */
                                     template: {
                                         [key: string]: unknown;
@@ -2844,6 +3082,11 @@ export interface paths {
                                     variantId: string | null;
                                     /** @description Default variant name; null alongside a null variantId. */
                                     variantName: string | null;
+                                    /**
+                                     * Format: uuid
+                                     * @description The SDUI experiment that assigned this variant, as on `ui.experimentId`. Null or absent when no experiment decided it.
+                                     */
+                                    experimentId?: string | null;
                                     /** @description The default variant's SDUI template. NULL means 'enabled, but nothing to render' — the SDK must no-op on this surface. It must NEVER substitute another use case's template. */
                                     template: {
                                         [key: string]: unknown;
@@ -2973,6 +3216,20 @@ export interface paths {
                     };
                 };
                 /** @description Default Response */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            error: string;
+                            details?: unknown;
+                            /** @description Machine-readable reason, set only on the few errors a client must branch on (each route that sets one says so in its description) and absent on every other. Treat an unknown value as absent. */
+                            code?: string;
+                        };
+                    };
+                };
+                /** @description Default Response */
                 401: {
                     headers: {
                         [name: string]: unknown;
@@ -4909,11 +5166,20 @@ export interface components {
                 useCase: "churn-intervention" | "post-action-reward";
                 /**
                  * Format: uuid
-                 * @description Selected variant ID
+                 * @description Selected variant ID. On a trigger step answer that draws nothing (template null with a step: a hide, or thanks with no thanks look), the look whose behavior decided it, so after_complete_hide can name it.
                  */
                 variantId?: string | null;
                 /** @description Selected variant name */
                 variantName?: string | null;
+                /**
+                 * Format: uuid
+                 * @description The SDUI experiment that assigned this variant. Echo it as experiment_id on offer events beside variant_id. Null or absent when no experiment decided the variant. On a trigger response it is also present when the user was held out (template null), so a trigger can tell a holdout from no experiment; a sheet response never carries it beside a null template.
+                 */
+                experimentId?: string | null;
+                /** @description Trigger responses only: set when the look served (or template null) was chosen by a behavior for the request's `state`, or by the look's behavior.ifIgnored for a gifts button's exposure tally (a non-clicker). Values today: afterClaim, afterComplete, ifIgnored; more may be added, and an SDK treats a value it does not know as no step. With template null and an experimentId, it tells a behavior's hide apart from a holdout (an unknown step with template null is reported as reason unknown_step). Stamp it as step on the trigger events. */
+                step?: string;
+                /** @description Trigger responses with a `step` only: the experiment whose look's behavior chose the step (for a reminder in a gifts button spot, the gifts button's), beside experimentId (the drawn look's own; on an afterComplete step, the deciding look's, as a thanks look is in no arm). An opaque id (a UUID today). Stamp it as step_experiment_id on the trigger events. */
+                stepExperimentId?: string | null;
                 /** @description Minimum SDK version for this variant */
                 minSdkVersion?: string | null;
                 /** @description SDUI template with placeholders */
@@ -5009,6 +5275,11 @@ export interface components {
                     variantId: string | null;
                     /** @description Default variant name; null alongside a null variantId. */
                     variantName: string | null;
+                    /**
+                     * Format: uuid
+                     * @description The SDUI experiment that assigned this variant, as on `ui.experimentId`. Null or absent when no experiment decided it.
+                     */
+                    experimentId?: string | null;
                     /** @description The default variant's SDUI template. NULL means 'enabled, but nothing to render' — the SDK must no-op on this surface. It must NEVER substitute another use case's template. */
                     template: {
                         [key: string]: unknown;
@@ -5100,6 +5371,11 @@ export interface components {
                     variantId: string | null;
                     /** @description Default variant name; null alongside a null variantId. */
                     variantName: string | null;
+                    /**
+                     * Format: uuid
+                     * @description The SDUI experiment that assigned this variant, as on `ui.experimentId`. Null or absent when no experiment decided it.
+                     */
+                    experimentId?: string | null;
                     /** @description The default variant's SDUI template. NULL means 'enabled, but nothing to render' — the SDK must no-op on this surface. It must NEVER substitute another use case's template. */
                     template: {
                         [key: string]: unknown;
@@ -5226,6 +5502,89 @@ export interface components {
             /** @description Placement labels for this app that carry a placement rule or pinned variant. Present whenever the app's placement rules can be read; empty when none. Clients scope their offers cache by placement only for labels in this list; when the field is absent (older server) clients keep their pre-2.4 behaviour. */
             ruledPlacements?: string[];
         };
+        OffersSearchRequest: {
+            userId: string;
+            /** @description Optional user attributes for offer selection */
+            attributes?: {
+                email?: string;
+                firstName?: string;
+                lastName?: string;
+                mobile?: string;
+                phoneNumber?: string;
+                postcode?: string;
+                postalCode?: string;
+                city?: string;
+                state?: string;
+                region?: string;
+                /** @description ISO 3166-1 alpha-2 country code (e.g., "US", "GB", "CA"). */
+                countryCode?: string;
+                /** @description Decimal degrees as string (e.g., "37.7749") */
+                latitude?: string;
+                /** @description Decimal degrees as string (e.g., "-122.4194") */
+                longitude?: string;
+                /** @description Whole years, as an integer. If you hold only a RANGE, send its LOWEST end: "13-17" is sent as 13. Under 18 restricts this request to offers rated for that age, with no per-user personalisation. Used for this request only and never stored. Lower than an age stored through /users/attributes, it wins; higher, the stored one does. A fraction is rounded down, also as a decimal string ("17.9" is 17), a whole-number string is read as its number, and a range string as its lowest end ("13-17" is 13, "65+" is 65); any other value is ignored, never a 400. */
+                age?: number;
+                /** @description Deprecated: send age instead. A YYYY-MM-DD date, or an ISO 8601 date-time with a zone, is turned into an age for this request only, then discarded; never stored or logged. If age is also sent, the younger of the two is used. An unreadable date is ignored, never a 400. */
+                dateOfBirth?: string;
+                gender?: string;
+                /** @description BCP 47 language tag; only the language subtag is used for creative locale resolution, and only when the app has that language enabled. Falls back to Accept-Language, then the app default locale. */
+                language?: string;
+                subscriptionTier?: string;
+                monthsSubscribed?: string;
+                billingCycle?: string;
+                lastPaymentAmount?: string;
+                lastActiveDate?: string;
+                totalSessions?: string;
+                custom?: {
+                    [key: string]: string;
+                };
+            };
+            /**
+             * @description Number of campaigns to fetch (default: 10)
+             * @default 50
+             */
+            limit: number;
+            /**
+             * @description Pagination offset (default: 0)
+             * @default 0
+             */
+            offset: number;
+            /**
+             * Format: uuid
+             * @description Session ID for deterministic pagination - if not provided, server will generate one
+             */
+            requestId?: string;
+            /** @description SDK version in semver format (e.g., "1.2.3") */
+            sdkVersion?: string;
+            /**
+             * @description Client platform: android, ios, or web
+             * @enum {string}
+             */
+            platform?: "android" | "ios" | "web";
+            /**
+             * Format: uuid
+             * @description SDUI variant ID from frontend config fetch. If provided, filters creatives by variant assignment. If not provided, no variant filtering is applied.
+             */
+            variantId?: string;
+            /** @description Publisher-defined surface label for where the offer is shown (e.g. 'paywall', 'onboarding', 'settings'). Stamped onto the sdk_offer_requested event so publisher analytics can break the funnel out by placement. An Encore admin can also configure a per-placement offer rule for an app, in which case this label SELECTS and ORDERS the offers returned for that placement; with no rule configured, which is the default for every app, it stays analytics-only and changes nothing about what is served. Max 64 chars. SDKs may send their own auto-generated `placement_<8 hex>` id when the publisher supplied none — that is expected and is folded into the '(unlabeled)' bucket at read time; do NOT substitute '(unlabeled)' or an empty string yourself. */
+            placementId?: string;
+            /**
+             * @description Which Encore surface is being filled. Ignored while OFFERS_SEARCH_RESOLVES_SURFACE is off. With it on and no variantId, the server resolves the variant for this use case (and the placementId pin) as GET /config does; a sent variantId always wins. Absent or unrecognised: today's behaviour (churn-intervention). Never a 400.
+             * @enum {string}
+             */
+            useCase?: "churn-intervention" | "post-action-reward";
+            /** @description Strict unlock mode: only include campaigns whose postback latency is less than or equal to this value (in milliseconds). Omit for no filtering. Bounded 1000..120000. */
+            maxPostbackTimeMs?: number;
+            /** @description Send only when this placement carries the app's own prize for a reward-for-trying Yes: the app's daily prize limit from its SDK configuration (PublisherRewardPolicy), clamped server-side to 1..10. The response then carries publisherRewardPromise. Omit it and nothing changes. */
+            publisherRewardDailyLimit?: number;
+            /** @description Why the client is searching. `purpose: "prefetch"` marks a search the SDK runs before any sheet is shown (a GiftsButton or ClaimReminder checking that offers exist). Its result may later back the sheet the user opens with a tap, so it is a served request like any other, not an impression. It is stamped as purpose on sdk_offer_requested so a report can split these out. Any other value is ignored, never a 400. Serving is identical either way. */
+            purpose?: string;
+            /** @description Request-scoped serving context. Unknown keys are ignored. */
+            context?: {
+                /** @description Request-scoped activity the user is engaged in at serve time (what the surface is being used for, not a persisted user property). Recognized values: laundry, vending, car_wash, air_vacuum, amusement. Any other value is accepted and recorded on serve analytics, so unrecognized activities show up in reporting rather than failing the request. Does not change which offers are served today. */
+                activity?: string;
+            };
+        };
         OffersSearchResponse: {
             success: boolean;
             offers: {
@@ -5332,9 +5691,10 @@ export interface components {
                     ctaText: string;
                     /**
                      * Format: uri
-                     * @description Optional override for campaign destinationUrl
+                     * @description The campaign's destination, on a served creative; null where not served
                      */
                     destinationUrl: string | null;
+                    /** @description The campaign's claim tracking, on a served creative; null where not served */
                     trackingParameters: {
                         [key: string]: unknown;
                     } | null;
@@ -5422,15 +5782,22 @@ export interface components {
                     medianSeconds: number;
                     p90Seconds: number;
                 } | null;
-                /** @description Campaign claim-URL query parameters, keys verbatim (e.g. {"af_rid":"TRANSACTION_ID"}); equals the served creative's whenever one exists. Always pair it with the offer's destinationUrl, never with a creative's, and never build a claim URL from an absent or empty value. Absent unless the campaign offer fields flag is on; null means the campaign has none. */
+                /** @description This offer's per-offer reward. Present only for an app with reward settings; null when the offer carries no value: in on_yes show the placement's flat prize, in on_verified show no prize (a null value is never paid). Absent: the app has no per-offer rewards. /offers/search only. */
+                publisherRewardValue?: {
+                    /** @description Tokens this offer is worth in the app's own unit. The offer_completed webhook's reward.amount carries the value frozen when the user claimed. */
+                    amount: number;
+                    /** @description Ready-to-render card text, e.g. "1,500 tokens". Show it in place of the flat PublisherReward title. */
+                    label: string;
+                } | null;
+                /** @description Campaign claim-URL query parameters, keys verbatim (e.g. {"af_rid":"TRANSACTION_ID"}); equals the served creative's whenever one exists. Always pair it with the offer's destinationUrl, never with a creative's, and never build a claim URL from an absent or empty value. Absent from servers that predate it; null means the campaign has none. */
                 trackingParameters?: {
                     [key: string]: unknown;
                 } | null;
-                /** @description Campaign call-to-action text. Absent unless the campaign offer fields flag is on; null means the campaign has none. */
+                /** @description Campaign call-to-action text. Absent from servers that predate it; null means the campaign has none. */
                 ctaText?: string | null;
-                /** @description Campaign description, localized like creatives. Absent unless the campaign offer fields flag is on; null means the campaign has none. */
+                /** @description Campaign description, localized like creatives. Absent from servers that predate it; null means the campaign has none. */
                 description?: string | null;
-                /** @description Campaign step-by-step instructions, same shape as a creative's. Absent unless the campaign offer fields flag is on; null means the campaign has none. */
+                /** @description Campaign step-by-step instructions, same shape as a creative's. Absent from servers that predate it; null means the campaign has none. */
                 instructions?: {
                     title: string;
                     subtitle: string;
@@ -5438,15 +5805,15 @@ export interface components {
                     /** @description Optional https image for this step. Absent: the step has none. */
                     imageUrl?: string;
                 }[] | null;
-                /** @description Campaign one-line instructions. Absent unless the campaign offer fields flag is on; null means the campaign has none. */
+                /** @description Campaign one-line instructions. Absent from servers that predate it; null means the campaign has none. */
                 quickInstructions?: string | null;
-                /** @description Campaign logo override; null means use organization.logoUrl. Plain string, not format: uri, so one bad value cannot fail a whole Android decode. Absent unless the campaign offer fields flag is on; null means the campaign has none. */
+                /** @description Campaign logo override; null means use organization.logoUrl. Plain string, not format: uri, so one bad value cannot fail a whole Android decode. Absent from servers that predate it; null means the campaign has none. */
                 logoUrl?: string | null;
-                /** @description Campaign card title. Absent unless the campaign offer fields flag is on; null means the campaign has none. */
+                /** @description Campaign card title. Absent from servers that predate it; null means the campaign has none. */
                 title?: string | null;
-                /** @description Campaign card subtitle. Absent unless the campaign offer fields flag is on; null means the campaign has none. */
+                /** @description Campaign card subtitle. Absent from servers that predate it; null means the campaign has none. */
                 subtitle?: string | null;
-                /** @description Campaign tooltip text. Absent unless the campaign offer fields flag is on; null means the campaign has none. */
+                /** @description Campaign tooltip text. Absent from servers that predate it; null means the campaign has none. */
                 tooltipText?: string | null;
             }[];
             metadata: {
@@ -5465,8 +5832,13 @@ export interface components {
             };
             /** @description Resolved locale served in this response (language-only, e.g. 'es'). Absent on pre-localization responses. */
             locale?: string;
-            /** @description Whether this user may still be granted the app's prize for a reward-for-trying Yes: true while the prizes granted to them in the last 24 hours (rolling) are under publisherRewardDailyLimit. Present only when the request sent publisherRewardDailyLimit. Offers this user already completed or said Yes to are never served, so this answers the daily limit only. Absent (an older backend, or no limit sent) means no promise. Not a grant: the self-report's granted answer is final. */
+            /** @description Whether this user is still under the app's daily prize limit (publisherRewardDailyLimit, rolling 24 hours). What counts depends on publisherRewardMode. on_yes (or no mode): prizes granted on a reward-for-trying Yes. on_verified: this user's verified completions that carried a reward, by when they verified; a Yes never grants and never counts, and the reward arrives on the offer_completed webhook. Present only when the request sent publisherRewardDailyLimit. Offers this user already completed or said Yes to are never served, so this answers the daily limit only. Absent (an older backend, or no limit sent) means no promise. Not a grant: in on_yes the self-report's granted answer is final. */
             publisherRewardPromise?: boolean;
+            /**
+             * @description How this app pays its prize. on_yes: a reward-for-trying Yes can grant it (self-report granted). on_verified: a Yes never grants; each offer's publisherRewardValue arrives on the offer_completed webhook when the brand confirms. Present only for an app with reward settings (and always when the promise was counted under on_verified). Decode as a string and treat an unknown value as on_yes.
+             * @enum {string}
+             */
+            publisherRewardMode?: "on_yes" | "on_verified";
             error?: string | null;
         };
         Campaign: {
@@ -5573,9 +5945,10 @@ export interface components {
                 ctaText: string;
                 /**
                  * Format: uri
-                 * @description Optional override for campaign destinationUrl
+                 * @description The campaign's destination, on a served creative; null where not served
                  */
                 destinationUrl: string | null;
+                /** @description The campaign's claim tracking, on a served creative; null where not served */
                 trackingParameters: {
                     [key: string]: unknown;
                 } | null;
@@ -5663,15 +6036,22 @@ export interface components {
                 medianSeconds: number;
                 p90Seconds: number;
             } | null;
-            /** @description Campaign claim-URL query parameters, keys verbatim (e.g. {"af_rid":"TRANSACTION_ID"}); equals the served creative's whenever one exists. Always pair it with the offer's destinationUrl, never with a creative's, and never build a claim URL from an absent or empty value. Absent unless the campaign offer fields flag is on; null means the campaign has none. */
+            /** @description This offer's per-offer reward. Present only for an app with reward settings; null when the offer carries no value: in on_yes show the placement's flat prize, in on_verified show no prize (a null value is never paid). Absent: the app has no per-offer rewards. /offers/search only. */
+            publisherRewardValue?: {
+                /** @description Tokens this offer is worth in the app's own unit. The offer_completed webhook's reward.amount carries the value frozen when the user claimed. */
+                amount: number;
+                /** @description Ready-to-render card text, e.g. "1,500 tokens". Show it in place of the flat PublisherReward title. */
+                label: string;
+            } | null;
+            /** @description Campaign claim-URL query parameters, keys verbatim (e.g. {"af_rid":"TRANSACTION_ID"}); equals the served creative's whenever one exists. Always pair it with the offer's destinationUrl, never with a creative's, and never build a claim URL from an absent or empty value. Absent from servers that predate it; null means the campaign has none. */
             trackingParameters?: {
                 [key: string]: unknown;
             } | null;
-            /** @description Campaign call-to-action text. Absent unless the campaign offer fields flag is on; null means the campaign has none. */
+            /** @description Campaign call-to-action text. Absent from servers that predate it; null means the campaign has none. */
             ctaText?: string | null;
-            /** @description Campaign description, localized like creatives. Absent unless the campaign offer fields flag is on; null means the campaign has none. */
+            /** @description Campaign description, localized like creatives. Absent from servers that predate it; null means the campaign has none. */
             description?: string | null;
-            /** @description Campaign step-by-step instructions, same shape as a creative's. Absent unless the campaign offer fields flag is on; null means the campaign has none. */
+            /** @description Campaign step-by-step instructions, same shape as a creative's. Absent from servers that predate it; null means the campaign has none. */
             instructions?: {
                 title: string;
                 subtitle: string;
@@ -5679,15 +6059,15 @@ export interface components {
                 /** @description Optional https image for this step. Absent: the step has none. */
                 imageUrl?: string;
             }[] | null;
-            /** @description Campaign one-line instructions. Absent unless the campaign offer fields flag is on; null means the campaign has none. */
+            /** @description Campaign one-line instructions. Absent from servers that predate it; null means the campaign has none. */
             quickInstructions?: string | null;
-            /** @description Campaign logo override; null means use organization.logoUrl. Plain string, not format: uri, so one bad value cannot fail a whole Android decode. Absent unless the campaign offer fields flag is on; null means the campaign has none. */
+            /** @description Campaign logo override; null means use organization.logoUrl. Plain string, not format: uri, so one bad value cannot fail a whole Android decode. Absent from servers that predate it; null means the campaign has none. */
             logoUrl?: string | null;
-            /** @description Campaign card title. Absent unless the campaign offer fields flag is on; null means the campaign has none. */
+            /** @description Campaign card title. Absent from servers that predate it; null means the campaign has none. */
             title?: string | null;
-            /** @description Campaign card subtitle. Absent unless the campaign offer fields flag is on; null means the campaign has none. */
+            /** @description Campaign card subtitle. Absent from servers that predate it; null means the campaign has none. */
             subtitle?: string | null;
-            /** @description Campaign tooltip text. Absent unless the campaign offer fields flag is on; null means the campaign has none. */
+            /** @description Campaign tooltip text. Absent from servers that predate it; null means the campaign has none. */
             tooltipText?: string | null;
         };
         Creative: {
@@ -5707,9 +6087,10 @@ export interface components {
             ctaText: string;
             /**
              * Format: uri
-             * @description Optional override for campaign destinationUrl
+             * @description The campaign's destination, on a served creative; null where not served
              */
             destinationUrl: string | null;
+            /** @description The campaign's claim tracking, on a served creative; null where not served */
             trackingParameters: {
                 [key: string]: unknown;
             } | null;