@encorekit/web-sdk 1.1.20 → 2.0.0

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

@@ -83,7 +83,7 @@ export interface paths {
                                 /** @description When true, this campaign is auto-granted to every newly created app. Independent of priority (which controls ranking order only). */
                                 defaultCatalog: boolean;
                                 /**
-                                 * @description blacklist (default): all apps eligible; whitelist: only apps in campaign_allowed_apps are eligible
+                                 * @description Deprecated; always 'whitelist'. Retained because iOS/Android SDK decoders require the field. Access is governed solely by campaign_allowed_apps + enabled.
                                  * @enum {string}
                                  */
                                 targetingMode: "blacklist" | "whitelist";
@@ -317,6 +317,8 @@ export interface paths {
                          * @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'). Best-effort analytics context: when supplied it is stamped onto the sdk_offer_requested event so publisher analytics can break the funnel out by placement. Max 64 chars; omit for auto-generated/absent ids (they bucket as '(unlabeled)'). */
+                        placementId?: string;
                         /** @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;
                     };
@@ -375,7 +377,7 @@ export interface paths {
                                 /** @description When true, this campaign is auto-granted to every newly created app. Independent of priority (which controls ranking order only). */
                                 defaultCatalog: boolean;
                                 /**
-                                 * @description blacklist (default): all apps eligible; whitelist: only apps in campaign_allowed_apps are eligible
+                                 * @description Deprecated; always 'whitelist'. Retained because iOS/Android SDK decoders require the field. Access is governed solely by campaign_allowed_apps + enabled.
                                  * @enum {string}
                                  */
                                 targetingMode: "blacklist" | "whitelist";
@@ -737,17 +739,17 @@ export interface paths {
                         clientId: string;
                         /** @description Conversation / thread identifier on the messaging platform. Used as the messaging-surface userId — drives bandit seeding for `/offers/message`, the transaction created at click time, and the userId dimension on the click event. */
                         chatId: string;
-                        /** @description Required targeting attributes — country / language / platform. */
+                        /** @description Targeting attributes — countryCode and language are required; platform is optional (omit for a platform='api' app to receive all offers untrimmed). */
                         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'). */
                             language: string;
                             /**
-                             * @description Recipient's device platform — drives creative compatibility filtering.
+                             * @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";
+                            platform?: "android" | "ios" | "web";
                         };
                     };
                 };
@@ -859,17 +861,17 @@ export interface paths {
                         clientId: string;
                         /** @description End-user identifier on the partner surface. Used as the bandit-seeding userId for ranking and as the userId on the transaction created at click time. */
                         userId: string;
-                        /** @description Required targeting attributes — country / language / platform. */
+                        /** @description Targeting attributes — countryCode and language are required; platform is optional (omit for a platform='api' app to receive all offers untrimmed). */
                         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'). */
                             language: string;
                             /**
-                             * @description Recipient's device platform — drives creative compatibility filtering.
+                             * @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";
+                            platform?: "android" | "ios" | "web";
                         };
                         /**
                          * @description Maximum number of offers to return (1–25, default 10). The client controls display order and cycles through them one at a time.
@@ -1083,6 +1085,11 @@ export interface paths {
                     "application/json": {
                         campaignId: string;
                         userId: string;
+                        /**
+                         * @description Which Encore surface the user claimed from. Persisted on the transaction so the server-side completion — which is built from that row alone and carries no client context — can be split by use case, along with the payout booked on it. Absent means 'churn-intervention'.
+                         * @enum {string}
+                         */
+                        useCase?: "churn-intervention" | "post-action-reward";
                     };
                 };
             };
@@ -2216,7 +2223,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. */
+        /** @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. 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: {
@@ -2226,6 +2233,8 @@ export interface paths {
                     sdkVersion: string;
                     /** @description Optional language hint (e.g. 'es'). Overrides the Accept-Language header; region subtags are stripped. */
                     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";
                 };
                 header?: never;
                 path?: never;
@@ -2243,6 +2252,11 @@ export interface paths {
                             success: boolean;
                             /** @description UI configuration: template + values */
                             ui: {
+                                /**
+                                 * @description The Encore surface this UI config is for
+                                 * @enum {string}
+                                 */
+                                useCase: "churn-intervention" | "post-action-reward";
                                 /**
                                  * Format: uuid
                                  * @description Selected variant ID
@@ -2286,6 +2300,10 @@ export interface paths {
                                         customHeadline?: string | null;
                                         /** @description Custom subheadline text for SDUI variant (falls back to subtitle) */
                                         customSubheadline?: string | null;
+                                        /** @description Headline for the reward template. NON-NULL whenever ui.useCase is 'post-action-reward' — the template references ${rewardHeadline} unconditionally and the substitution engine leaves an unresolved token visible on screen. Resolution: app_use_cases.headline, else the shipped default. */
+                                        rewardHeadline?: string | null;
+                                        /** @description Subheadline for the reward template. NON-NULL whenever ui.useCase is 'post-action-reward', for the same reason as rewardHeadline — the template references ${rewardSubheadline} unconditionally. Resolution: app_use_cases.subheadline, else the shipped default. */
+                                        rewardSubheadline?: string | null;
                                     };
                                     /** @description Appearance values */
                                     appearance: {
@@ -2299,6 +2317,146 @@ export interface paths {
                                         /** @description Accent title color (hex) */
                                         accentTitleColor?: string | null;
                                     };
+                                    /** @description Media values (imagery URLs) */
+                                    media: {
+                                        /** @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 NEW, additive. Default variant for every OTHER use case this app is enabled for, so the SDK can cache them at identify(). `ui` is unchanged; un-upgraded decoders ignore this key. */
+                            useCases: {
+                                "churn-intervention"?: {
+                                    /**
+                                     * Format: uuid
+                                     * @description Default variant ID for this use case; null when the app is enabled for the surface but no default is eligible for it.
+                                     */
+                                    variantId: string | null;
+                                    /** @description Default variant name; null alongside a null variantId. */
+                                    variantName: 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;
+                                    } | null;
+                                    /** @description Values to substitute into this use case's template. Always present, even when template is null — the copy is resolved from app_use_cases regardless. */
+                                    values: {
+                                        /** @description Text values for template substitution */
+                                        text: {
+                                            /** @description App name for ${appName} substitution */
+                                            appName?: string | null;
+                                            /** @description Main title text */
+                                            title?: string | null;
+                                            /** @description Subtitle text */
+                                            subtitle?: string | null;
+                                            /** @description Offer description text */
+                                            offerDescription?: string | null;
+                                            /** @description Instructions title */
+                                            instructionsTitle?: string | null;
+                                            /** @description Last step header text */
+                                            lastStepHeader?: string | null;
+                                            /** @description Last step description */
+                                            lastStepDescription?: string | null;
+                                            /** @description Credit claimed title */
+                                            creditClaimedTitle?: string | null;
+                                            /** @description Credit claimed subtitle */
+                                            creditClaimedSubtitle?: string | null;
+                                            /** @description Apply credits button text */
+                                            applyCreditsButton?: string | null;
+                                            /** @description Accent title text */
+                                            accentTitle?: string | null;
+                                            /** @description Custom headline text for SDUI variant (falls back to title) */
+                                            customHeadline?: string | null;
+                                            /** @description Custom subheadline text for SDUI variant (falls back to subtitle) */
+                                            customSubheadline?: string | null;
+                                            /** @description Headline for the reward template. NON-NULL whenever ui.useCase is 'post-action-reward' — the template references ${rewardHeadline} unconditionally and the substitution engine leaves an unresolved token visible on screen. Resolution: app_use_cases.headline, else the shipped default. */
+                                            rewardHeadline?: string | null;
+                                            /** @description Subheadline for the reward template. NON-NULL whenever ui.useCase is 'post-action-reward', for the same reason as rewardHeadline — the template references ${rewardSubheadline} unconditionally. Resolution: app_use_cases.subheadline, else the shipped default. */
+                                            rewardSubheadline?: string | null;
+                                        };
+                                        /** @description Appearance values */
+                                        appearance: {
+                                            /**
+                                             * @description Appearance mode
+                                             * @enum {string|null}
+                                             */
+                                            mode?: "light" | "dark" | "auto" | null;
+                                            /** @description Primary accent color (hex) */
+                                            accentColor?: string | null;
+                                            /** @description Accent title color (hex) */
+                                            accentTitleColor?: string | null;
+                                        };
+                                        /** @description Media values (imagery URLs) */
+                                        media: {
+                                            /** @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;
+                                        };
+                                    };
+                                };
+                                "post-action-reward"?: {
+                                    /**
+                                     * Format: uuid
+                                     * @description Default variant ID for this use case; null when the app is enabled for the surface but no default is eligible for it.
+                                     */
+                                    variantId: string | null;
+                                    /** @description Default variant name; null alongside a null variantId. */
+                                    variantName: 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;
+                                    } | null;
+                                    /** @description Values to substitute into this use case's template. Always present, even when template is null — the copy is resolved from app_use_cases regardless. */
+                                    values: {
+                                        /** @description Text values for template substitution */
+                                        text: {
+                                            /** @description App name for ${appName} substitution */
+                                            appName?: string | null;
+                                            /** @description Main title text */
+                                            title?: string | null;
+                                            /** @description Subtitle text */
+                                            subtitle?: string | null;
+                                            /** @description Offer description text */
+                                            offerDescription?: string | null;
+                                            /** @description Instructions title */
+                                            instructionsTitle?: string | null;
+                                            /** @description Last step header text */
+                                            lastStepHeader?: string | null;
+                                            /** @description Last step description */
+                                            lastStepDescription?: string | null;
+                                            /** @description Credit claimed title */
+                                            creditClaimedTitle?: string | null;
+                                            /** @description Credit claimed subtitle */
+                                            creditClaimedSubtitle?: string | null;
+                                            /** @description Apply credits button text */
+                                            applyCreditsButton?: string | null;
+                                            /** @description Accent title text */
+                                            accentTitle?: string | null;
+                                            /** @description Custom headline text for SDUI variant (falls back to title) */
+                                            customHeadline?: string | null;
+                                            /** @description Custom subheadline text for SDUI variant (falls back to subtitle) */
+                                            customSubheadline?: string | null;
+                                            /** @description Headline for the reward template. NON-NULL whenever ui.useCase is 'post-action-reward' — the template references ${rewardHeadline} unconditionally and the substitution engine leaves an unresolved token visible on screen. Resolution: app_use_cases.headline, else the shipped default. */
+                                            rewardHeadline?: string | null;
+                                            /** @description Subheadline for the reward template. NON-NULL whenever ui.useCase is 'post-action-reward', for the same reason as rewardHeadline — the template references ${rewardSubheadline} unconditionally. Resolution: app_use_cases.subheadline, else the shipped default. */
+                                            rewardSubheadline?: string | null;
+                                        };
+                                        /** @description Appearance values */
+                                        appearance: {
+                                            /**
+                                             * @description Appearance mode
+                                             * @enum {string|null}
+                                             */
+                                            mode?: "light" | "dark" | "auto" | null;
+                                            /** @description Primary accent color (hex) */
+                                            accentColor?: string | null;
+                                            /** @description Accent title color (hex) */
+                                            accentTitleColor?: string | null;
+                                        };
+                                        /** @description Media values (imagery URLs) */
+                                        media: {
+                                            /** @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 Entitlement configuration (IAP or Native mode) */
@@ -3645,6 +3803,256 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/publisher/sdk/v1/creators/links": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** @description Mint the creator's shareable affiliate links: one stable branded short link per campaign your app is entitled to serve (every enabled campaign, regardless of geo). Idempotent — the same creatorId always returns the same link per campaign. Each link is a single URL clickable by many people; every distinct click is an independent claim tracked as its own transaction. Authentication: publishable key (X-API-Key: pk_live_* / pk_test_*). */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        /** @description Publisher-supplied stable identifier for the creator (opaque to Encore). */
+                        creatorId: string;
+                    };
+                };
+            };
+            responses: {
+                /** @description Default Response */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            creatorId: string;
+                            links: {
+                                name: string;
+                                /** @description User-facing value proposition, e.g., "3 months of Hulu free". Rendered in the deal email. */
+                                perk: string | null;
+                                /**
+                                 * @description Constrained promo badge for in-app offer cards: free_trial | discount. Drives the card pill display AND client-side free-trial-vs-discount logic. Clients map the enum to display text + free-trial boolean. NULL means no badge.
+                                 * @enum {string|null}
+                                 */
+                                badgeLabel: "free_trial" | "discount" | null;
+                                /** @description Original price before discount */
+                                oldPrice: string | null;
+                                /** @description New/discounted price for the offer */
+                                newPrice: string | null;
+                                targetCountries: string[];
+                                /** @description Campaign the link points to. */
+                                campaignId: string;
+                                /**
+                                 * Format: uri
+                                 * @description The shareable branded short link (https://<host>/<slug>).
+                                 */
+                                linkUrl: string;
+                                payout: {
+                                    /** @description Publisher's payout per completion: campaign payout × the app's payout split (raw campaign payout when no split is set). */
+                                    amount: number;
+                                    /** @description ISO-4217 currency. Always USD. */
+                                    currency: string;
+                                    /**
+                                     * @description Campaign payout model (CPA / CPC / CPI / CPM).
+                                     * @enum {string}
+                                     */
+                                    model: "CPA" | "CPC" | "CPI" | "CPM";
+                                };
+                                /** @description The campaign's categories (for offer-wall filter tabs). Empty when the campaign has none. */
+                                categories: {
+                                    id: string;
+                                    name: string;
+                                }[];
+                                organization?: {
+                                    /** Format: uuid */
+                                    id: string;
+                                    name: string;
+                                    description: string | null;
+                                    url: string | null;
+                                    logoUrl: string | null;
+                                };
+                                creatives?: {
+                                    /** Format: uuid */
+                                    id: string;
+                                    title: string;
+                                    subtitle: string | null;
+                                    description: string | null;
+                                    /** Format: uri */
+                                    primaryImageUrl: string;
+                                    /** Format: uri */
+                                    logoUrl: string | null;
+                                    additionalImages: string[] | null;
+                                    ctaText: string;
+                                    /** @description Platforms this creative supports (empty = all platforms) */
+                                    supportedPlatforms: ("android" | "ios" | "web")[] | null;
+                                }[];
+                            }[];
+                        };
+                    };
+                };
+                /** @description Default Response */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            error: string;
+                            details?: unknown;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            error: string;
+                            details?: unknown;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                500: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            error: string;
+                            details?: unknown;
+                        };
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/publisher/sdk/v1/creators/{creatorId}/stats": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description Real-time performance for a creator's links, per campaign and per day: clicks (each click = one claim), completions (verified/final-granted conversions), and earnings (after your app's payout split; USD). Returns rolled-up totals plus a per-day series (`daily`). Optional `startDate`/`endDate` (YYYY-MM-DD, UTC, inclusive; start must be <= end) filter everything; absent = all-time. Clicks attribute by transaction date; completions + earnings by completion date. An unknown creatorId returns 200 with empty campaigns/daily and zeroed totals. Authentication: publishable key (X-API-Key: pk_live_* / pk_test_*). */
+        get: {
+            parameters: {
+                query?: {
+                    startDate?: string;
+                    endDate?: string;
+                };
+                header?: never;
+                path: {
+                    creatorId: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Default Response */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            creatorId: string;
+                            /** @description ISO-4217 currency for every `earnings` figure. Always USD. */
+                            currency: string;
+                            /** @description Echoed applied range start (YYYY-MM-DD), present only when supplied. */
+                            startDate?: string;
+                            /** @description Echoed applied range end (YYYY-MM-DD), present only when supplied. */
+                            endDate?: string;
+                            campaigns: {
+                                campaignId: string;
+                                campaignTitle: string;
+                                /** @description Distinct clicks in range (each click mints one transaction). */
+                                clicks: number;
+                                /** @description Clicks whose transaction reached a completed status (verified / final_granted) in range. */
+                                completions: number;
+                                /** @description Creator/publisher's earnings for this campaign in `currency`, after the app's payout split (raw payout sum if no split is set). */
+                                earnings: number;
+                            }[];
+                            totals: {
+                                clicks: number;
+                                completions: number;
+                                earnings: number;
+                            };
+                            /** @description Per-day series across all campaigns, ascending; days with no activity are omitted. Clicks attributed by transaction created_at (UTC); completions + earnings by completion timestamp (UTC). */
+                            daily: {
+                                /** @description UTC calendar date (YYYY-MM-DD). */
+                                date: string;
+                                clicks: number;
+                                completions: number;
+                                earnings: number;
+                            }[];
+                        };
+                    };
+                };
+                /** @description Default Response */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            error: string;
+                            details?: unknown;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            error: string;
+                            details?: unknown;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                500: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            error: string;
+                            details?: unknown;
+                        };
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/events": {
         parameters: {
             query?: never;
@@ -3763,6 +4171,11 @@ export interface components {
             success: boolean;
             /** @description UI configuration: template + values */
             ui: {
+                /**
+                 * @description The Encore surface this UI config is for
+                 * @enum {string}
+                 */
+                useCase: "churn-intervention" | "post-action-reward";
                 /**
                  * Format: uuid
                  * @description Selected variant ID
@@ -3806,6 +4219,10 @@ export interface components {
                         customHeadline?: string | null;
                         /** @description Custom subheadline text for SDUI variant (falls back to subtitle) */
                         customSubheadline?: string | null;
+                        /** @description Headline for the reward template. NON-NULL whenever ui.useCase is 'post-action-reward' — the template references ${rewardHeadline} unconditionally and the substitution engine leaves an unresolved token visible on screen. Resolution: app_use_cases.headline, else the shipped default. */
+                        rewardHeadline?: string | null;
+                        /** @description Subheadline for the reward template. NON-NULL whenever ui.useCase is 'post-action-reward', for the same reason as rewardHeadline — the template references ${rewardSubheadline} unconditionally. Resolution: app_use_cases.subheadline, else the shipped default. */
+                        rewardSubheadline?: string | null;
                     };
                     /** @description Appearance values */
                     appearance: {
@@ -3819,6 +4236,146 @@ export interface components {
                         /** @description Accent title color (hex) */
                         accentTitleColor?: string | null;
                     };
+                    /** @description Media values (imagery URLs) */
+                    media: {
+                        /** @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 NEW, additive. Default variant for every OTHER use case this app is enabled for, so the SDK can cache them at identify(). `ui` is unchanged; un-upgraded decoders ignore this key. */
+            useCases: {
+                "churn-intervention"?: {
+                    /**
+                     * Format: uuid
+                     * @description Default variant ID for this use case; null when the app is enabled for the surface but no default is eligible for it.
+                     */
+                    variantId: string | null;
+                    /** @description Default variant name; null alongside a null variantId. */
+                    variantName: 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;
+                    } | null;
+                    /** @description Values to substitute into this use case's template. Always present, even when template is null — the copy is resolved from app_use_cases regardless. */
+                    values: {
+                        /** @description Text values for template substitution */
+                        text: {
+                            /** @description App name for ${appName} substitution */
+                            appName?: string | null;
+                            /** @description Main title text */
+                            title?: string | null;
+                            /** @description Subtitle text */
+                            subtitle?: string | null;
+                            /** @description Offer description text */
+                            offerDescription?: string | null;
+                            /** @description Instructions title */
+                            instructionsTitle?: string | null;
+                            /** @description Last step header text */
+                            lastStepHeader?: string | null;
+                            /** @description Last step description */
+                            lastStepDescription?: string | null;
+                            /** @description Credit claimed title */
+                            creditClaimedTitle?: string | null;
+                            /** @description Credit claimed subtitle */
+                            creditClaimedSubtitle?: string | null;
+                            /** @description Apply credits button text */
+                            applyCreditsButton?: string | null;
+                            /** @description Accent title text */
+                            accentTitle?: string | null;
+                            /** @description Custom headline text for SDUI variant (falls back to title) */
+                            customHeadline?: string | null;
+                            /** @description Custom subheadline text for SDUI variant (falls back to subtitle) */
+                            customSubheadline?: string | null;
+                            /** @description Headline for the reward template. NON-NULL whenever ui.useCase is 'post-action-reward' — the template references ${rewardHeadline} unconditionally and the substitution engine leaves an unresolved token visible on screen. Resolution: app_use_cases.headline, else the shipped default. */
+                            rewardHeadline?: string | null;
+                            /** @description Subheadline for the reward template. NON-NULL whenever ui.useCase is 'post-action-reward', for the same reason as rewardHeadline — the template references ${rewardSubheadline} unconditionally. Resolution: app_use_cases.subheadline, else the shipped default. */
+                            rewardSubheadline?: string | null;
+                        };
+                        /** @description Appearance values */
+                        appearance: {
+                            /**
+                             * @description Appearance mode
+                             * @enum {string|null}
+                             */
+                            mode?: "light" | "dark" | "auto" | null;
+                            /** @description Primary accent color (hex) */
+                            accentColor?: string | null;
+                            /** @description Accent title color (hex) */
+                            accentTitleColor?: string | null;
+                        };
+                        /** @description Media values (imagery URLs) */
+                        media: {
+                            /** @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;
+                        };
+                    };
+                };
+                "post-action-reward"?: {
+                    /**
+                     * Format: uuid
+                     * @description Default variant ID for this use case; null when the app is enabled for the surface but no default is eligible for it.
+                     */
+                    variantId: string | null;
+                    /** @description Default variant name; null alongside a null variantId. */
+                    variantName: 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;
+                    } | null;
+                    /** @description Values to substitute into this use case's template. Always present, even when template is null — the copy is resolved from app_use_cases regardless. */
+                    values: {
+                        /** @description Text values for template substitution */
+                        text: {
+                            /** @description App name for ${appName} substitution */
+                            appName?: string | null;
+                            /** @description Main title text */
+                            title?: string | null;
+                            /** @description Subtitle text */
+                            subtitle?: string | null;
+                            /** @description Offer description text */
+                            offerDescription?: string | null;
+                            /** @description Instructions title */
+                            instructionsTitle?: string | null;
+                            /** @description Last step header text */
+                            lastStepHeader?: string | null;
+                            /** @description Last step description */
+                            lastStepDescription?: string | null;
+                            /** @description Credit claimed title */
+                            creditClaimedTitle?: string | null;
+                            /** @description Credit claimed subtitle */
+                            creditClaimedSubtitle?: string | null;
+                            /** @description Apply credits button text */
+                            applyCreditsButton?: string | null;
+                            /** @description Accent title text */
+                            accentTitle?: string | null;
+                            /** @description Custom headline text for SDUI variant (falls back to title) */
+                            customHeadline?: string | null;
+                            /** @description Custom subheadline text for SDUI variant (falls back to subtitle) */
+                            customSubheadline?: string | null;
+                            /** @description Headline for the reward template. NON-NULL whenever ui.useCase is 'post-action-reward' — the template references ${rewardHeadline} unconditionally and the substitution engine leaves an unresolved token visible on screen. Resolution: app_use_cases.headline, else the shipped default. */
+                            rewardHeadline?: string | null;
+                            /** @description Subheadline for the reward template. NON-NULL whenever ui.useCase is 'post-action-reward', for the same reason as rewardHeadline — the template references ${rewardSubheadline} unconditionally. Resolution: app_use_cases.subheadline, else the shipped default. */
+                            rewardSubheadline?: string | null;
+                        };
+                        /** @description Appearance values */
+                        appearance: {
+                            /**
+                             * @description Appearance mode
+                             * @enum {string|null}
+                             */
+                            mode?: "light" | "dark" | "auto" | null;
+                            /** @description Primary accent color (hex) */
+                            accentColor?: string | null;
+                            /** @description Accent title color (hex) */
+                            accentTitleColor?: string | null;
+                        };
+                        /** @description Media values (imagery URLs) */
+                        media: {
+                            /** @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 Entitlement configuration (IAP or Native mode) */
@@ -3907,7 +4464,7 @@ export interface components {
                 /** @description When true, this campaign is auto-granted to every newly created app. Independent of priority (which controls ranking order only). */
                 defaultCatalog: boolean;
                 /**
-                 * @description blacklist (default): all apps eligible; whitelist: only apps in campaign_allowed_apps are eligible
+                 * @description Deprecated; always 'whitelist'. Retained because iOS/Android SDK decoders require the field. Access is governed solely by campaign_allowed_apps + enabled.
                  * @enum {string}
                  */
                 targetingMode: "blacklist" | "whitelist";
@@ -4093,7 +4650,7 @@ export interface components {
             /** @description When true, this campaign is auto-granted to every newly created app. Independent of priority (which controls ranking order only). */
             defaultCatalog: boolean;
             /**
-             * @description blacklist (default): all apps eligible; whitelist: only apps in campaign_allowed_apps are eligible
+             * @description Deprecated; always 'whitelist'. Retained because iOS/Android SDK decoders require the field. Access is governed solely by campaign_allowed_apps + enabled.
              * @enum {string}
              */
             targetingMode: "blacklist" | "whitelist";