@encorekit/web-sdk 2.2.1 → 2.4.0

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

@@ -104,6 +104,10 @@ export interface paths {
                                 heroImageUrl?: string | null;
                                 /** @description https link to the advertiser offer terms. Null or absent: render terms copy as plain text. */
                                 termsUrl?: string | null;
+                                /** @description Display-only strings a variant renders by key, e.g. {"eligibilityNote":"New subscribers only"}. Values are strings; the type is free-form so one unexpected value cannot fail a client decode. Absent or empty: the variant draws none of those lines. */
+                                displayProperties?: {
+                                    [key: string]: unknown;
+                                };
                                 /** Format: date-time */
                                 createdAt: string;
                                 /** Format: date-time */
@@ -139,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;
@@ -152,6 +157,8 @@ export interface paths {
                                         title: string;
                                         subtitle: string;
                                         ctaButtonText?: string;
+                                        /** @description Optional https image for this step. Absent: the step has none. */
+                                        imageUrl?: string;
                                     }[] | null;
                                     /** @description Short, actionable phrases (max 1-3) that guide users. Examples: "sign up, create registry", "add to cart" */
                                     quickInstructions: string | null;
@@ -231,6 +238,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -283,8 +292,12 @@ 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. */
                             language?: string;
                             subscriptionTier?: string;
                             monthsSubscribed?: string;
@@ -325,8 +338,17 @@ export interface paths {
                         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. */
@@ -409,6 +431,10 @@ export interface paths {
                                 heroImageUrl?: string | null;
                                 /** @description https link to the advertiser offer terms. Null or absent: render terms copy as plain text. */
                                 termsUrl?: string | null;
+                                /** @description Display-only strings a variant renders by key, e.g. {"eligibilityNote":"New subscribers only"}. Values are strings; the type is free-form so one unexpected value cannot fail a client decode. Absent or empty: the variant draws none of those lines. */
+                                displayProperties?: {
+                                    [key: string]: unknown;
+                                };
                                 /** Format: date-time */
                                 createdAt: string;
                                 /** Format: date-time */
@@ -444,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;
@@ -457,6 +484,8 @@ export interface paths {
                                         title: string;
                                         subtitle: string;
                                         ctaButtonText?: string;
+                                        /** @description Optional https image for this step. Absent: the step has none. */
+                                        imageUrl?: string;
                                     }[] | null;
                                     /** @description Short, actionable phrases (max 1-3) that guide users. Examples: "sign up, create registry", "add to cart" */
                                     quickInstructions: string | null;
@@ -523,11 +552,48 @@ export interface paths {
                                 category?: string | null;
                                 /** @description The gift-sheet group this campaign files under: "Watch & listen", "Money" or "Everyday". Derived from `category` by the server so a native chip strip shows what web tabs show without holding the taxonomy map. Always set: an absent, blank or unmapped category files under "Everyday", so every offer sits in some group. Whether a strip is worth drawing is the client's call, because only it knows which offers its sheet lists. /offers/search only: web-sdk holds its own copy of the map and groups `category` itself. */
                                 categoryGroup?: string | null;
+                                /** @description `category` in the response locale, for display only. Group and filter on `category`, which stays English. Null when `category` is null. /offers/search only. */
+                                categoryDisplayName?: string | null;
+                                /** @description `categoryGroup` in the response locale, for display only. Group on `categoryGroup`, which stays English. /offers/search only. */
+                                categoryGroupDisplayName?: string | null;
                                 /** @description Estimated time from the user tapping this offer to the reward being confirmed, from recent real conversions (on demo offers, from the demo advertiser's configured behavior instead). Half confirm within medianSeconds, 9 in 10 within p90Seconds. Not a guarantee: to show a wait, use p90Seconds. Null when there is no current estimate (too few recent conversions, data more than 7 days old, or an offer that does not confirm through the advertiser); say nothing about timing then. */
                                 rewardConfirmationTime?: {
                                     medianSeconds: number;
                                     p90Seconds: number;
                                 } | null;
+                                /** @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 from servers that predate it; null means the campaign has none. */
+                                ctaText?: string | null;
+                                /** @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 from servers that predate it; null means the campaign has none. */
+                                instructions?: {
+                                    title: string;
+                                    subtitle: string;
+                                    ctaButtonText?: string;
+                                    /** @description Optional https image for this step. Absent: the step has none. */
+                                    imageUrl?: string;
+                                }[] | null;
+                                /** @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 from servers that predate it; null means the campaign has none. */
+                                logoUrl?: string | null;
+                                /** @description Campaign card title. Absent from servers that predate it; null means the campaign has none. */
+                                title?: string | null;
+                                /** @description Campaign card subtitle. Absent from servers that predate it; null means the campaign has none. */
+                                subtitle?: string | null;
+                                /** @description Campaign tooltip text. Absent from servers that predate it; null means the campaign has none. */
+                                tooltipText?: string | null;
                             }[];
                             metadata: {
                                 /** @description Total offers available */
@@ -545,6 +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 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;
                         };
                     };
@@ -558,6 +631,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -570,6 +645,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -582,6 +659,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -594,6 +673,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -614,7 +695,7 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        /** @description Rebrokering catalog: the full set of offers your app may serve to a given end user, to render on your own surface. Two hard, server-enforced filters always apply: entitlement (your app's opt-outs + whitelist) and geo (offers not redeemable in the end user's country are dropped: non-redeemable offers are never returned). Serve path requires `userId` (a stable end-user identifier) and geo (`countryCode`, or the end user's IP forwarded via X-Forwarded-For); missing either is a 400. Each returned creative carries a tokenized `clickUrl`: route the end user there on tap and it records an attributed transaction (bound to your app, the offer, the creative, and the userId) then 302s to the advertiser. Filter to your curated offer IDs and order CLIENT-SIDE, falling back to other returned offers so your surface is never empty (the server does not narrow to your picks). Set `includeAllRegions: true` for config-time discovery of your full addressable inventory (skips geo, needs no userId, returns no clickUrls; each offer carries targetCountries); not for display. Authentication: publishable key (X-API-Key: pk_live_* / pk_test_*). */
+        /** @description Rebrokering catalog: the full set of offers your app may serve to a given end user, to render on your own surface. Two hard, server-enforced filters always apply: entitlement (your app's opt-outs + whitelist) and geo (offers not redeemable in the end user's country are dropped: non-redeemable offers are never returned). Serve path requires `userId` (a stable end-user identifier) and geo (`countryCode`, or the end user's IP forwarded via X-Forwarded-For); missing either is a 400. On the serve path, offers this end user already completed (a confirmed conversion, or a Yes they reported through an Encore SDK) are left out. Each returned creative carries a tokenized `clickUrl`: route the end user there on tap and it records an attributed transaction (bound to your app, the offer, the creative, and the userId) then 302s to the advertiser. Filter to your curated offer IDs and order CLIENT-SIDE, falling back to other returned offers so your surface is never empty (the server does not narrow to your picks). Set `includeAllRegions: true` for config-time discovery of your full addressable inventory (skips geo, needs no userId, returns no clickUrls; each offer carries targetCountries); not for display. Authentication: publishable key (X-API-Key: pk_live_* / pk_test_*). */
         post: {
             parameters: {
                 query?: never;
@@ -625,7 +706,7 @@ export interface paths {
             requestBody?: {
                 content: {
                     "application/json": {
-                        /** @description Stable identifier for the END USER you are rendering offers to (any opaque string; does not need to be PII). REQUIRED on the serve path — it is bound into each offer's clickUrl so a click records a transaction attributed to (your app, the offer, the creative, this user), and it drives per-user fraud controls (trial caps, retake blocking) at click time. Use the same value across renders for the same user. Not required when includeAllRegions is set (config mode returns no clickUrls). */
+                        /** @description Stable identifier for the END USER you are rendering offers to (any opaque string; does not need to be PII). REQUIRED on the serve path — it is bound into each offer's clickUrl so a click records a transaction attributed to (your app, the offer, the creative, this user), it drives per-user fraud controls (trial caps, retake blocking) at click time, and on the serve path it leaves out offers this user already completed. Use the same value across renders for the same user. Not required when includeAllRegions is set (config mode returns no clickUrls). */
                         userId?: string;
                         /** @description Optional identifier for the operator/sub-publisher on whose behalf offers are shown. Carried through as an analytics dimension. Defaults to userId when omitted. */
                         clientId?: string;
@@ -638,6 +719,8 @@ export interface paths {
                         platform?: "android" | "ios" | "web";
                         /** @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. A per-placement offer rule NEVER applies here. `/offers/catalog` returns inventory rather than a served set, so a rule configured for this label does not select or order what comes back. Scope an inventory pull on your own filters, never on a rule. */
                         placementId?: string;
+                        /** @description Optional BCP 47 language tag (e.g. "es", "pt-BR"), from the host's language override. Wins over Accept-Language; only the language subtag is used (nb is served as no; iw, in, ji, jw as he, id, yi, jv), and only when the app has it enabled, else Accept-Language, then the app default. A tag the SDKs would refuse (malformed, underscores, or an extended language subtag such as zh-yue-HK) is 400 with details.code INVALID_LANGUAGE. */
+                        language?: string;
                         /** @description CONFIG-TIME ONLY. When true, skips geo-filtering and returns the full addressable inventory for your app (entitlement still applies), with each offer's targetCountries — use this to build your curation. Do NOT use for offers displayed to an end user; those must come from a geo-scoped request (countryCode or forwarded IP). When true, no geography signal is required and countryCode is ignored. */
                         includeAllRegions?: boolean;
                         /** @description Optional page size (1..100). OMIT to return ALL eligible offers (the default) — catalogs are small enough that you normally take the whole set and curate client-side. Provide only if you want to page (with offset). */
@@ -680,6 +763,10 @@ export interface paths {
                                 isDemo?: boolean;
                                 /** @description https link to the advertiser offer terms. Null or absent: render terms copy as plain text. */
                                 termsUrl?: string | null;
+                                /** @description Display-only strings a variant renders by key, e.g. {"eligibilityNote":"New subscribers only"}. Values are strings; the type is free-form so one unexpected value cannot fail a client decode. Absent or empty: the variant draws none of those lines. */
+                                displayProperties?: {
+                                    [key: string]: unknown;
+                                };
                                 /** @description Estimated time from the user tapping this offer to the reward being confirmed, from recent real conversions (on demo offers, from the demo advertiser's configured behavior instead). Half confirm within medianSeconds, 9 in 10 within p90Seconds. Not a guarantee: to show a wait, use p90Seconds. Null when there is no current estimate (too few recent conversions, data more than 7 days old, or an offer that does not confirm through the advertiser); say nothing about timing then. */
                                 rewardConfirmationTime?: {
                                     medianSeconds: number;
@@ -712,6 +799,8 @@ export interface paths {
                                         title: string;
                                         subtitle: string;
                                         ctaButtonText?: string;
+                                        /** @description Optional https image for this step. Absent: the step has none. */
+                                        imageUrl?: string;
                                     }[] | null;
                                     /** @description A short one line version of the instructions, e.g. "sign up, complete one survey". Null or absent: the creative has none. */
                                     quickInstructions?: string | null;
@@ -744,6 +833,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -756,6 +847,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -768,6 +861,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -807,13 +902,35 @@ export interface paths {
                         attributes: {
                             /** @description ISO 3166-1 alpha-2 country code (e.g., "US", "GB", "CA"). */
                             countryCode: string;
-                            /** @description BCP 47 language tag — drives creative locale resolution (e.g., 'en', 'es'). */
+                            /** @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;
                             /**
                              * @description Recipient's device platform — drives creative compatibility filtering. Optional: omit for a platform='api' app to receive all eligible offers untrimmed; device-SDK apps always send it. 'api' is not a valid value here.
                              * @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;
@@ -875,6 +992,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -887,6 +1006,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -899,6 +1020,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -938,13 +1061,35 @@ export interface paths {
                         attributes: {
                             /** @description ISO 3166-1 alpha-2 country code (e.g., "US", "GB", "CA"). */
                             countryCode: string;
-                            /** @description BCP 47 language tag — drives creative locale resolution (e.g., 'en', 'es'). */
+                            /** @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;
                             /**
                              * @description Recipient's device platform — drives creative compatibility filtering. Optional: omit for a platform='api' app to receive all eligible offers untrimmed; device-SDK apps always send it. 'api' is not a valid value here.
                              * @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.
@@ -1014,6 +1159,10 @@ export interface paths {
                                 heroImageUrl?: string | null;
                                 /** @description https link to the advertiser offer terms. Null or absent: render terms copy as plain text. */
                                 termsUrl?: string | null;
+                                /** @description Display-only strings a variant renders by key, e.g. {"eligibilityNote":"New subscribers only"}. Values are strings; the type is free-form so one unexpected value cannot fail a client decode. Absent or empty: the variant draws none of those lines. */
+                                displayProperties?: {
+                                    [key: string]: unknown;
+                                };
                                 /** @description Display name of the campaign category, e.g. "Music and Audio". Free string: the taxonomy is admin-editable, so accept any value. */
                                 category?: string | null;
                                 /** @description Step by step instructions from the creative, translated like the title. Null or absent: the creative has none. */
@@ -1021,6 +1170,8 @@ export interface paths {
                                     title: string;
                                     subtitle: string;
                                     ctaButtonText?: string;
+                                    /** @description Optional https image for this step. Absent: the step has none. */
+                                    imageUrl?: string;
                                 }[] | null;
                                 /** @description A short one line version of the instructions, e.g. "sign up, complete one survey". Null or absent: the creative has none. */
                                 quickInstructions?: string | null;
@@ -1042,6 +1193,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -1054,6 +1207,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -1066,6 +1221,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -1129,6 +1286,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -1141,6 +1300,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -1153,6 +1314,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -1173,7 +1336,7 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        /** @description Create a new transaction for a specific campaign */
+        /** @description Create a new transaction for a specific campaign. 409 with code 'offerAlreadyCompleted' when this user already completed the offer, or said Yes to it through a self-report: drop the offer from the list rather than retrying. The app-wide trial-limit 409 carries no code. */
         post: {
             parameters: {
                 query?: never;
@@ -1191,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;
                     };
                 };
             };
@@ -1230,6 +1398,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -1242,6 +1412,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -1254,6 +1426,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -1266,6 +1440,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -1278,6 +1454,139 @@ export interface paths {
                         "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/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;
                         };
                     };
                 };
@@ -1341,6 +1650,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -1353,6 +1664,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -1365,6 +1678,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -1377,6 +1692,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -1389,6 +1706,133 @@ export interface paths {
                         "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}/self-report": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** @description Record that the user answered "Yes, I completed it" to a reward-for-trying offer, and decide whether the app may grant its own prize. Send it on EVERY tapped Yes, prize or not: the Yes is stored per person (the app's user id), so the offer is hidden from that person on every surface and a re-claim is refused (409 offerAlreadyCompleted), including after a reinstall or on a second device. granted is true only for the first Yes per person per offer, while the person is under the app's daily limit (a rolling 24 hours). Treat no answer as no prize. Idempotent on reportId. Never changes the transaction: no status, payout, entitlement or webhook. 404 when the transaction does not belong to this app, or userId is not the current user id of the person who claimed it. The server cannot tell an identified user from an SDK-generated anonymous id: an app that wants prizes kept to signed-in users must gate the promise client-side. */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    transactionId: string;
+                };
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        /** @description The SDK's CURRENT user id at the moment the report is sent (not the id captured when the user tapped Yes). Must equal the current app user id of the user who owns the transaction, or the request is a 404. */
+                        userId: string;
+                        /**
+                         * Format: uuid
+                         * @description Minted once per tapped Yes and reused on every retry of that Yes, with the same body. A retry gets the same granted. On a refused Yes the server keeps only that no prize was granted, so the retry's reason is derived from the retry's own body (daily_cap when it carries publisherRewardId, else no_prize): resend the body unchanged.
+                         */
+                        reportId: string;
+                        /** @description Present only when a prize was promised for this Yes. Absent: the Yes is still recorded (the offer is hidden and cannot be re-claimed) and granted is false with reason no_prize. */
+                        publisherRewardId?: string;
+                        /** @description The app's daily prize limit from its SDK configuration. Required when publisherRewardId is present. Clamped server-side to 1..10. */
+                        dailyLimit?: number;
+                    };
+                };
+            };
+            responses: {
+                /** @description Default Response */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @enum {boolean} */
+                            success: true;
+                            /** @description Whether the app may grant its prize for this Yes. True only for the first Yes per person per offer, under the daily limit. The ONLY source of prize eligibility: no answer (timeout, offline, 5xx, 404) means no prize. */
+                            granted: boolean;
+                            /**
+                             * @description Present when granted is false.
+                             * @enum {string}
+                             */
+                            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).
+                             */
+                            reportedAt: 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 */
+                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;
                         };
                     };
                 };
@@ -1448,6 +1892,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -1460,6 +1906,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -1472,6 +1920,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -1655,6 +2105,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -1667,6 +2119,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -1679,6 +2133,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -1854,6 +2310,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -1866,6 +2324,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -1878,6 +2338,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -2059,6 +2521,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -2071,6 +2535,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -2150,6 +2616,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -2162,6 +2630,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -2174,6 +2644,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -2226,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 */
@@ -2304,6 +2781,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -2316,6 +2795,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -2336,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: {
@@ -2348,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;
                 };
@@ -2376,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 */
@@ -2427,6 +2937,10 @@ export interface paths {
                                         rewardDecline?: string | null;
                                         /** @description Badge on the highlighted offer card, e.g. 'Most claimed'. Same resolution and same null meaning as rewardCta. */
                                         rewardBadge?: string | null;
+                                        /** @description Label on the card that opens the rest of the offer list, e.g. 'Show more gifts'. Same resolution and same null meaning as rewardCta. */
+                                        rewardMoreGifts?: string | null;
+                                        /** @description Header above the rest of the offer list, e.g. 'Other gifts'. Same resolution and same null meaning as rewardCta. */
+                                        rewardOtherGifts?: string | null;
                                     };
                                     /** @description Appearance values */
                                     appearance: {
@@ -2445,6 +2959,21 @@ export interface paths {
                                         /** @description App icon URL (App Store artwork for mobile apps, fetched favicon for web apps). Web SDK uses it as the default host logo when display.logoUrl is not set. */
                                         appstoreIcon: string | null;
                                     };
+                                    /** @description Words the SDK says itself, translated into the response `locale`, by string id (e.g. 'card.claim'). Only ids that locale has; for any other id, and whenever the key is absent, use the SDK's own English. Never served for 'en'. Placeholders use ${name}. Populated in `ui.values` only, not in `useCases`. */
+                                    strings?: {
+                                        [key: string]: string;
+                                    };
+                                    /** @description Count-dependent SDK strings (e.g. 'unit.month'), translated into the response `locale`, by string id. Same id namespace as `strings`; an id appears in only one of the two. Same fallback rules as `strings`. */
+                                    plurals?: {
+                                        [key: string]: {
+                                            zero?: string;
+                                            one?: string;
+                                            two?: string;
+                                            few?: string;
+                                            many?: string;
+                                            other: string;
+                                        };
+                                    };
                                 };
                             };
                             /** @description Assigned variant for every use case this app is enabled for other than the one REQUESTED, so the SDK can cache them at identify(). When the single-enabled-use-case fallback serves a different surface in `ui`, that surface also appears here under its own key, so a client that files `ui` under the requested use case still finds it. `ui` is unchanged; un-upgraded decoders ignore this key. */
@@ -2457,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;
@@ -2501,6 +3035,10 @@ export interface paths {
                                             rewardDecline?: string | null;
                                             /** @description Badge on the highlighted offer card, e.g. 'Most claimed'. Same resolution and same null meaning as rewardCta. */
                                             rewardBadge?: string | null;
+                                            /** @description Label on the card that opens the rest of the offer list, e.g. 'Show more gifts'. Same resolution and same null meaning as rewardCta. */
+                                            rewardMoreGifts?: string | null;
+                                            /** @description Header above the rest of the offer list, e.g. 'Other gifts'. Same resolution and same null meaning as rewardCta. */
+                                            rewardOtherGifts?: string | null;
                                         };
                                         /** @description Appearance values */
                                         appearance: {
@@ -2519,6 +3057,21 @@ export interface paths {
                                             /** @description App icon URL (App Store artwork for mobile apps, fetched favicon for web apps). Web SDK uses it as the default host logo when display.logoUrl is not set. */
                                             appstoreIcon: string | null;
                                         };
+                                        /** @description Words the SDK says itself, translated into the response `locale`, by string id (e.g. 'card.claim'). Only ids that locale has; for any other id, and whenever the key is absent, use the SDK's own English. Never served for 'en'. Placeholders use ${name}. Populated in `ui.values` only, not in `useCases`. */
+                                        strings?: {
+                                            [key: string]: string;
+                                        };
+                                        /** @description Count-dependent SDK strings (e.g. 'unit.month'), translated into the response `locale`, by string id. Same id namespace as `strings`; an id appears in only one of the two. Same fallback rules as `strings`. */
+                                        plurals?: {
+                                            [key: string]: {
+                                                zero?: string;
+                                                one?: string;
+                                                two?: string;
+                                                few?: string;
+                                                many?: string;
+                                                other: string;
+                                            };
+                                        };
                                     };
                                 };
                                 "post-action-reward"?: {
@@ -2529,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;
@@ -2573,6 +3131,10 @@ export interface paths {
                                             rewardDecline?: string | null;
                                             /** @description Badge on the highlighted offer card, e.g. 'Most claimed'. Same resolution and same null meaning as rewardCta. */
                                             rewardBadge?: string | null;
+                                            /** @description Label on the card that opens the rest of the offer list, e.g. 'Show more gifts'. Same resolution and same null meaning as rewardCta. */
+                                            rewardMoreGifts?: string | null;
+                                            /** @description Header above the rest of the offer list, e.g. 'Other gifts'. Same resolution and same null meaning as rewardCta. */
+                                            rewardOtherGifts?: string | null;
                                         };
                                         /** @description Appearance values */
                                         appearance: {
@@ -2591,6 +3153,21 @@ export interface paths {
                                             /** @description App icon URL (App Store artwork for mobile apps, fetched favicon for web apps). Web SDK uses it as the default host logo when display.logoUrl is not set. */
                                             appstoreIcon: string | null;
                                         };
+                                        /** @description Words the SDK says itself, translated into the response `locale`, by string id (e.g. 'card.claim'). Only ids that locale has; for any other id, and whenever the key is absent, use the SDK's own English. Never served for 'en'. Placeholders use ${name}. Populated in `ui.values` only, not in `useCases`. */
+                                        strings?: {
+                                            [key: string]: string;
+                                        };
+                                        /** @description Count-dependent SDK strings (e.g. 'unit.month'), translated into the response `locale`, by string id. Same id namespace as `strings`; an id appears in only one of the two. Same fallback rules as `strings`. */
+                                        plurals?: {
+                                            [key: string]: {
+                                                zero?: string;
+                                                one?: string;
+                                                two?: string;
+                                                few?: string;
+                                                many?: string;
+                                                other: string;
+                                            };
+                                        };
                                     };
                                 };
                             };
@@ -2633,6 +3210,22 @@ export interface paths {
                             };
                             /** @description Resolved locale served in this response (language-only, e.g. 'es'). Absent on pre-localization responses. */
                             locale?: string;
+                            /** @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[];
+                        };
+                    };
+                };
+                /** @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;
                         };
                     };
                 };
@@ -2645,6 +3238,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -2657,6 +3252,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -2729,6 +3326,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -2741,6 +3340,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -2765,7 +3366,7 @@ export interface paths {
         delete?: never;
         options?: never;
         head?: never;
-        /** @description Update user identity (anonymous→identified). Updates the user's app_user_id. Called when developer calls SDK.identify() after login. */
+        /** @description Update user identity (anonymous→identified). Updates the user's app_user_id. Called when developer calls SDK.identify() after login. When newUserId already exists (the person signed in before, e.g. on another device), the anonymous user's completed and self-reported offers are copied onto that account, so they stay hidden and cannot be re-claimed. The copy is taken once, at this call: send any queued self-reports BEFORE it. A report for the anonymous user's claim that arrives afterwards is refused if it carries newUserId (404), and recorded on the anonymous user only, not this account, if it carries currentUserId. */
         patch: {
             parameters: {
                 query?: never;
@@ -2815,6 +3416,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -2827,6 +3430,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -2848,7 +3453,9 @@ export interface paths {
          *
          *     Precedence: an attribute sent on an /offers/search or /offers/feed request always WINS over the stored one. The stored set only fills an attribute the request omits.
          *
-         *     AGE. Send `age` as a whole-number integer. If you hold only a RANGE, send its LOWEST end — "13-17" is sent as 13, never 15 and never 17. Sending the middle of a range silently defeats the under-age check: flooring can never mask a minor, a midpoint can. An age below 18 restricts that user to age-appropriate inventory ranked by the app-level bandit, with NO per-user personalisation — offers are still served. For such a user only `age`, `countryCode` and `language` are STORED — the attributes that decide where an offer may legally appear and which creative locale renders; everything else you sent is discarded, `custom` included, and the response reports `minor`. The instant you sent the set is recorded, so a stored age is aged forward rather than frozen. `dateOfBirth` is refused: `age` carries the same targeting value with far less identifying power.
+         *     LANGUAGE is accepted and ignored: it is never stored. The hosted page and the SDKs send it on each request, else Accept-Language decides.
+         *
+         *     AGE. Send `age` as a whole-number integer. If you hold only a RANGE, send its LOWEST end — "13-17" is sent as 13, never 15 and never 17. Sending the middle of a range silently defeats the under-age check: flooring can never mask a minor, a midpoint can. An age below 18 restricts that user to age-appropriate inventory ranked by the app-level bandit, with NO per-user personalisation — offers are still served. For such a user only `age` and `countryCode` are STORED — the attributes that decide where an offer may legally appear; everything else you sent is discarded, `custom` included, and the response reports `minor`. The instant you sent the set is recorded, so a stored age is aged forward rather than frozen. `dateOfBirth` is refused: `age` carries the same targeting value with far less identifying power.
          *
          *     GATED KEYS. email, firstName, lastName, mobile, phoneNumber, postcode, postalCode, latitude, longitude and gender are accepted ONLY from an app whose audience is declared adults_only (store-rated 18+). Any other status, including the default, is refused with 400. `age` is NOT gated — it is accepted from any app, because it is what restricts what a user is shown rather than something that identifies them. Unrecognised keys are refused rather than ignored. Authentication: publishable key (X-API-Key: pk_live_* / pk_test_*).
          */
@@ -2868,6 +3475,7 @@ export interface paths {
                         attributes: {
                             /** @description ISO 3166-1 alpha-2 country code (e.g., "US", "GB", "CA"). */
                             countryCode?: string;
+                            /** @description Accepted for compatibility and ignored: the language is never stored. Send it on each request (attributes.language, or Accept-Language) instead. */
                             language?: string;
                             city?: string;
                             state?: string;
@@ -2915,7 +3523,7 @@ export interface paths {
                             userId: string;
                             /** @description ISO 8601 instant the set was recorded; what a stored age is aged forward from */
                             storedAt: string;
-                            /** @description True when the supplied age was under 18. Offers are STILL served to this user — from age-appropriate inventory only, ranked by the app-level bandit, with no per-user personalisation. Only `age`, `countryCode` and `language` are kept for this user. Everything else you sent is DISCARDED, including `custom`, `city`, `state`, `region` and the subscription and billing fields — a profile that may not be targeted on has no purpose. Re-send the set once they are 18 and it is stored in full. */
+                            /** @description True when the supplied age was under 18. Offers are STILL served to this user — from age-appropriate inventory only, ranked by the app-level bandit, with no per-user personalisation. Only `age` and `countryCode` are kept for this user. Everything else you sent is DISCARDED, including `custom`, `city`, `state`, `region` and the subscription and billing fields — a profile that may not be targeted on has no purpose. Re-send the set once they are 18 and it is stored in full. */
                             minor: boolean;
                         };
                     };
@@ -2929,6 +3537,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -2941,6 +3551,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -2953,6 +3565,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -3019,6 +3633,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -3031,6 +3647,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -3087,6 +3705,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -3099,6 +3719,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -3111,6 +3733,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -3123,6 +3747,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -3189,6 +3815,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -3201,6 +3829,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -3213,6 +3843,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -3249,6 +3881,8 @@ export interface paths {
                         campaignId: string;
                         /** Format: email */
                         email: string;
+                        /** @description Optional BCP 47 language tag (e.g. "es", "pt-BR"), from the host's language override. Wins over Accept-Language; only the language subtag is used (nb is served as no; iw, in, ji, jw as he, id, yi, jv), and only when the app has it enabled, else Accept-Language, then the app default. A tag the SDKs would refuse (malformed, underscores, or an extended language subtag such as zh-yue-HK) is 400 with details.code INVALID_LANGUAGE. The lead's emails go out in the language served. */
+                        language?: string;
                         /** @description Trial length in days as reported by StoreKit; drives reminder scheduling. */
                         trialDurationDays?: number | null;
                         /**
@@ -3290,6 +3924,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -3302,6 +3938,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -3314,6 +3952,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -3377,6 +4017,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -3389,6 +4031,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -3401,6 +4045,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -3465,6 +4111,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -3477,6 +4125,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -3489,6 +4139,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -3501,6 +4153,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -3513,6 +4167,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -3576,6 +4232,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -3588,6 +4246,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -3600,6 +4260,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -3612,6 +4274,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -3624,6 +4288,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -3636,6 +4302,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -3715,6 +4383,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -3727,6 +4397,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -3739,6 +4411,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -3819,6 +4493,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -3831,6 +4507,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -3843,6 +4521,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -3855,6 +4535,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -3914,6 +4596,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -3926,6 +4610,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -3938,6 +4624,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -3950,6 +4638,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -4014,6 +4704,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -4026,6 +4718,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -4038,6 +4732,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -4050,6 +4746,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -4062,6 +4760,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -4180,6 +4880,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -4192,6 +4894,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -4204,6 +4908,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -4286,6 +4992,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -4298,6 +5006,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -4310,6 +5020,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -4387,6 +5099,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -4399,6 +5113,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -4411,6 +5127,8 @@ export interface paths {
                         "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;
                         };
                     };
                 };
@@ -4448,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 */
@@ -4499,6 +5226,10 @@ export interface components {
                         rewardDecline?: string | null;
                         /** @description Badge on the highlighted offer card, e.g. 'Most claimed'. Same resolution and same null meaning as rewardCta. */
                         rewardBadge?: string | null;
+                        /** @description Label on the card that opens the rest of the offer list, e.g. 'Show more gifts'. Same resolution and same null meaning as rewardCta. */
+                        rewardMoreGifts?: string | null;
+                        /** @description Header above the rest of the offer list, e.g. 'Other gifts'. Same resolution and same null meaning as rewardCta. */
+                        rewardOtherGifts?: string | null;
                     };
                     /** @description Appearance values */
                     appearance: {
@@ -4517,6 +5248,21 @@ export interface components {
                         /** @description App icon URL (App Store artwork for mobile apps, fetched favicon for web apps). Web SDK uses it as the default host logo when display.logoUrl is not set. */
                         appstoreIcon: string | null;
                     };
+                    /** @description Words the SDK says itself, translated into the response `locale`, by string id (e.g. 'card.claim'). Only ids that locale has; for any other id, and whenever the key is absent, use the SDK's own English. Never served for 'en'. Placeholders use ${name}. Populated in `ui.values` only, not in `useCases`. */
+                    strings?: {
+                        [key: string]: string;
+                    };
+                    /** @description Count-dependent SDK strings (e.g. 'unit.month'), translated into the response `locale`, by string id. Same id namespace as `strings`; an id appears in only one of the two. Same fallback rules as `strings`. */
+                    plurals?: {
+                        [key: string]: {
+                            zero?: string;
+                            one?: string;
+                            two?: string;
+                            few?: string;
+                            many?: string;
+                            other: string;
+                        };
+                    };
                 };
             };
             /** @description Assigned variant for every use case this app is enabled for other than the one REQUESTED, so the SDK can cache them at identify(). When the single-enabled-use-case fallback serves a different surface in `ui`, that surface also appears here under its own key, so a client that files `ui` under the requested use case still finds it. `ui` is unchanged; un-upgraded decoders ignore this key. */
@@ -4529,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;
@@ -4573,6 +5324,10 @@ export interface components {
                             rewardDecline?: string | null;
                             /** @description Badge on the highlighted offer card, e.g. 'Most claimed'. Same resolution and same null meaning as rewardCta. */
                             rewardBadge?: string | null;
+                            /** @description Label on the card that opens the rest of the offer list, e.g. 'Show more gifts'. Same resolution and same null meaning as rewardCta. */
+                            rewardMoreGifts?: string | null;
+                            /** @description Header above the rest of the offer list, e.g. 'Other gifts'. Same resolution and same null meaning as rewardCta. */
+                            rewardOtherGifts?: string | null;
                         };
                         /** @description Appearance values */
                         appearance: {
@@ -4591,6 +5346,21 @@ export interface components {
                             /** @description App icon URL (App Store artwork for mobile apps, fetched favicon for web apps). Web SDK uses it as the default host logo when display.logoUrl is not set. */
                             appstoreIcon: string | null;
                         };
+                        /** @description Words the SDK says itself, translated into the response `locale`, by string id (e.g. 'card.claim'). Only ids that locale has; for any other id, and whenever the key is absent, use the SDK's own English. Never served for 'en'. Placeholders use ${name}. Populated in `ui.values` only, not in `useCases`. */
+                        strings?: {
+                            [key: string]: string;
+                        };
+                        /** @description Count-dependent SDK strings (e.g. 'unit.month'), translated into the response `locale`, by string id. Same id namespace as `strings`; an id appears in only one of the two. Same fallback rules as `strings`. */
+                        plurals?: {
+                            [key: string]: {
+                                zero?: string;
+                                one?: string;
+                                two?: string;
+                                few?: string;
+                                many?: string;
+                                other: string;
+                            };
+                        };
                     };
                 };
                 "post-action-reward"?: {
@@ -4601,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;
@@ -4645,6 +5420,10 @@ export interface components {
                             rewardDecline?: string | null;
                             /** @description Badge on the highlighted offer card, e.g. 'Most claimed'. Same resolution and same null meaning as rewardCta. */
                             rewardBadge?: string | null;
+                            /** @description Label on the card that opens the rest of the offer list, e.g. 'Show more gifts'. Same resolution and same null meaning as rewardCta. */
+                            rewardMoreGifts?: string | null;
+                            /** @description Header above the rest of the offer list, e.g. 'Other gifts'. Same resolution and same null meaning as rewardCta. */
+                            rewardOtherGifts?: string | null;
                         };
                         /** @description Appearance values */
                         appearance: {
@@ -4663,6 +5442,21 @@ export interface components {
                             /** @description App icon URL (App Store artwork for mobile apps, fetched favicon for web apps). Web SDK uses it as the default host logo when display.logoUrl is not set. */
                             appstoreIcon: string | null;
                         };
+                        /** @description Words the SDK says itself, translated into the response `locale`, by string id (e.g. 'card.claim'). Only ids that locale has; for any other id, and whenever the key is absent, use the SDK's own English. Never served for 'en'. Placeholders use ${name}. Populated in `ui.values` only, not in `useCases`. */
+                        strings?: {
+                            [key: string]: string;
+                        };
+                        /** @description Count-dependent SDK strings (e.g. 'unit.month'), translated into the response `locale`, by string id. Same id namespace as `strings`; an id appears in only one of the two. Same fallback rules as `strings`. */
+                        plurals?: {
+                            [key: string]: {
+                                zero?: string;
+                                one?: string;
+                                two?: string;
+                                few?: string;
+                                many?: string;
+                                other: string;
+                            };
+                        };
                     };
                 };
             };
@@ -4705,6 +5499,91 @@ export interface components {
             };
             /** @description Resolved locale served in this response (language-only, e.g. 'es'). Absent on pre-localization responses. */
             locale?: string;
+            /** @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;
@@ -4773,6 +5652,10 @@ export interface components {
                 heroImageUrl?: string | null;
                 /** @description https link to the advertiser offer terms. Null or absent: render terms copy as plain text. */
                 termsUrl?: string | null;
+                /** @description Display-only strings a variant renders by key, e.g. {"eligibilityNote":"New subscribers only"}. Values are strings; the type is free-form so one unexpected value cannot fail a client decode. Absent or empty: the variant draws none of those lines. */
+                displayProperties?: {
+                    [key: string]: unknown;
+                };
                 /** Format: date-time */
                 createdAt: string;
                 /** Format: date-time */
@@ -4808,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;
@@ -4821,6 +5705,8 @@ export interface components {
                         title: string;
                         subtitle: string;
                         ctaButtonText?: string;
+                        /** @description Optional https image for this step. Absent: the step has none. */
+                        imageUrl?: string;
                     }[] | null;
                     /** @description Short, actionable phrases (max 1-3) that guide users. Examples: "sign up, create registry", "add to cart" */
                     quickInstructions: string | null;
@@ -4887,11 +5773,48 @@ export interface components {
                 category?: string | null;
                 /** @description The gift-sheet group this campaign files under: "Watch & listen", "Money" or "Everyday". Derived from `category` by the server so a native chip strip shows what web tabs show without holding the taxonomy map. Always set: an absent, blank or unmapped category files under "Everyday", so every offer sits in some group. Whether a strip is worth drawing is the client's call, because only it knows which offers its sheet lists. /offers/search only: web-sdk holds its own copy of the map and groups `category` itself. */
                 categoryGroup?: string | null;
+                /** @description `category` in the response locale, for display only. Group and filter on `category`, which stays English. Null when `category` is null. /offers/search only. */
+                categoryDisplayName?: string | null;
+                /** @description `categoryGroup` in the response locale, for display only. Group on `categoryGroup`, which stays English. /offers/search only. */
+                categoryGroupDisplayName?: string | null;
                 /** @description Estimated time from the user tapping this offer to the reward being confirmed, from recent real conversions (on demo offers, from the demo advertiser's configured behavior instead). Half confirm within medianSeconds, 9 in 10 within p90Seconds. Not a guarantee: to show a wait, use p90Seconds. Null when there is no current estimate (too few recent conversions, data more than 7 days old, or an offer that does not confirm through the advertiser); say nothing about timing then. */
                 rewardConfirmationTime?: {
                     medianSeconds: number;
                     p90Seconds: number;
                 } | null;
+                /** @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 from servers that predate it; null means the campaign has none. */
+                ctaText?: string | null;
+                /** @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 from servers that predate it; null means the campaign has none. */
+                instructions?: {
+                    title: string;
+                    subtitle: string;
+                    ctaButtonText?: string;
+                    /** @description Optional https image for this step. Absent: the step has none. */
+                    imageUrl?: string;
+                }[] | null;
+                /** @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 from servers that predate it; null means the campaign has none. */
+                logoUrl?: string | null;
+                /** @description Campaign card title. Absent from servers that predate it; null means the campaign has none. */
+                title?: string | null;
+                /** @description Campaign card subtitle. Absent from servers that predate it; null means the campaign has none. */
+                subtitle?: string | null;
+                /** @description Campaign tooltip text. Absent from servers that predate it; null means the campaign has none. */
+                tooltipText?: string | null;
             }[];
             metadata: {
                 /** @description Total offers available */
@@ -4909,6 +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 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: {
@@ -4976,6 +5906,10 @@ export interface components {
             heroImageUrl?: string | null;
             /** @description https link to the advertiser offer terms. Null or absent: render terms copy as plain text. */
             termsUrl?: string | null;
+            /** @description Display-only strings a variant renders by key, e.g. {"eligibilityNote":"New subscribers only"}. Values are strings; the type is free-form so one unexpected value cannot fail a client decode. Absent or empty: the variant draws none of those lines. */
+            displayProperties?: {
+                [key: string]: unknown;
+            };
             /** Format: date-time */
             createdAt: string;
             /** Format: date-time */
@@ -5011,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;
@@ -5024,6 +5959,8 @@ export interface components {
                     title: string;
                     subtitle: string;
                     ctaButtonText?: string;
+                    /** @description Optional https image for this step. Absent: the step has none. */
+                    imageUrl?: string;
                 }[] | null;
                 /** @description Short, actionable phrases (max 1-3) that guide users. Examples: "sign up, create registry", "add to cart" */
                 quickInstructions: string | null;
@@ -5090,11 +6027,48 @@ export interface components {
             category?: string | null;
             /** @description The gift-sheet group this campaign files under: "Watch & listen", "Money" or "Everyday". Derived from `category` by the server so a native chip strip shows what web tabs show without holding the taxonomy map. Always set: an absent, blank or unmapped category files under "Everyday", so every offer sits in some group. Whether a strip is worth drawing is the client's call, because only it knows which offers its sheet lists. /offers/search only: web-sdk holds its own copy of the map and groups `category` itself. */
             categoryGroup?: string | null;
+            /** @description `category` in the response locale, for display only. Group and filter on `category`, which stays English. Null when `category` is null. /offers/search only. */
+            categoryDisplayName?: string | null;
+            /** @description `categoryGroup` in the response locale, for display only. Group on `categoryGroup`, which stays English. /offers/search only. */
+            categoryGroupDisplayName?: string | null;
             /** @description Estimated time from the user tapping this offer to the reward being confirmed, from recent real conversions (on demo offers, from the demo advertiser's configured behavior instead). Half confirm within medianSeconds, 9 in 10 within p90Seconds. Not a guarantee: to show a wait, use p90Seconds. Null when there is no current estimate (too few recent conversions, data more than 7 days old, or an offer that does not confirm through the advertiser); say nothing about timing then. */
             rewardConfirmationTime?: {
                 medianSeconds: number;
                 p90Seconds: number;
             } | null;
+            /** @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 from servers that predate it; null means the campaign has none. */
+            ctaText?: string | null;
+            /** @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 from servers that predate it; null means the campaign has none. */
+            instructions?: {
+                title: string;
+                subtitle: string;
+                ctaButtonText?: string;
+                /** @description Optional https image for this step. Absent: the step has none. */
+                imageUrl?: string;
+            }[] | null;
+            /** @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 from servers that predate it; null means the campaign has none. */
+            logoUrl?: string | null;
+            /** @description Campaign card title. Absent from servers that predate it; null means the campaign has none. */
+            title?: string | null;
+            /** @description Campaign card subtitle. Absent from servers that predate it; null means the campaign has none. */
+            subtitle?: string | null;
+            /** @description Campaign tooltip text. Absent from servers that predate it; null means the campaign has none. */
+            tooltipText?: string | null;
         };
         Creative: {
             /** Format: uuid */
@@ -5113,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;
@@ -5126,6 +6101,8 @@ export interface components {
                 title: string;
                 subtitle: string;
                 ctaButtonText?: string;
+                /** @description Optional https image for this step. Absent: the step has none. */
+                imageUrl?: string;
             }[] | null;
             /** @description Short, actionable phrases (max 1-3) that guide users. Examples: "sign up, create registry", "add to cart" */
             quickInstructions: string | null;