@adcp/client 2.0.2 → 2.3.0

package/dist/lib/types/tools.generated.d.ts

@@ -1050,19 +1050,19 @@ export interface Format {
         }[]
     ];
     /**
-     * Array of required assets or asset groups for this format. Can contain individual assets or repeatable asset sequences (e.g., carousel products, slideshow frames).
+     * Array of required assets or asset groups for this format. Each asset is identified by its asset_id, which must be used as the key in creative manifests. Can contain individual assets or repeatable asset sequences (e.g., carousel products, slideshow frames).
      */
     assets_required?: ({
         /**
-         * Identifier for this asset in the format
+         * Unique identifier for this asset. Creative manifests MUST use this exact value as the key in the assets object.
          */
         asset_id: string;
         /**
          * Type of asset
          */
-        asset_type: 'image' | 'video' | 'audio' | 'text' | 'html' | 'javascript' | 'url' | 'brand_manifest';
+        asset_type: 'image' | 'video' | 'audio' | 'vast' | 'daast' | 'text' | 'html' | 'css' | 'javascript' | 'url' | 'webhook' | 'promoted_offerings';
         /**
-         * Purpose of this asset (e.g., 'hero_image', 'logo', 'headline', 'cta_button')
+         * Optional descriptive label for this asset's purpose (e.g., 'hero_image', 'logo'). Not used for referencing assets in manifests—use asset_id instead. This field is for human-readable documentation and UI display only.
          */
         asset_role?: string;
         /**
@@ -1103,9 +1103,9 @@ export interface Format {
             /**
              * Type of asset
              */
-            asset_type: 'image' | 'video' | 'audio' | 'text' | 'html' | 'javascript' | 'url' | 'brand_manifest';
+            asset_type: 'image' | 'video' | 'audio' | 'vast' | 'daast' | 'text' | 'html' | 'css' | 'javascript' | 'url' | 'webhook' | 'promoted_offerings';
             /**
-             * Purpose of this asset
+             * Optional descriptive label for this asset's purpose (e.g., 'hero_image', 'logo'). Not used for referencing assets in manifests—use asset_id instead. This field is for human-readable documentation and UI display only.
              */
             asset_role?: string;
             /**
@@ -1174,7 +1174,11 @@ export type DAASTAsset2 = {
     [k: string]: unknown;
 };
 /**
- * Brand information manifest serving as the namespace and identity for this media buy. Provides brand context, assets, and product catalog. Can be provided inline or as a URL reference to a hosted manifest. Can be cached and reused across multiple requests.
+ * Brand information manifest containing assets, themes, and guidelines. Can be provided inline or as a URL reference to a hosted manifest.
+ */
+export type BrandManifestReference1 = BrandManifest1 | string;
+/**
+ * Campaign start timing: 'asap' or ISO 8601 date-time
  */
 export type StartTiming = 'asap' | string;
 /**
@@ -1189,7 +1193,7 @@ export interface CreateMediaBuyRequest {
      * Array of package configurations
      */
     packages: PackageRequest[];
-    brand_manifest: BrandManifestReference;
+    brand_manifest: BrandManifestReference1;
     /**
      * Purchase order number for tracking
      */
@@ -1309,7 +1313,7 @@ export interface CreativeAsset {
          * This interface was referenced by `undefined`'s JSON-Schema definition
          * via the `patternProperty` "^[a-zA-Z0-9_-]+$".
          */
-        [k: string]: ImageAsset | VideoAsset | AudioAsset | TextAsset | HTMLAsset | CSSAsset | JavaScriptAsset | VASTAsset | DAASTAsset | PromotedOfferingsAsset | URLAsset;
+        [k: string]: ImageAsset | VideoAsset | AudioAsset | TextAsset | HTMLAsset | CSSAsset | JavaScriptAsset | VASTAsset | DAASTAsset | PromotedOfferings | URLAsset;
     };
     /**
      * Preview contexts for generative formats - defines what scenarios to generate previews for
@@ -1343,7 +1347,6 @@ export interface CreativeAsset {
  * Structured format identifier with agent URL and format name
  */
 export interface ImageAsset {
-    asset_type: 'image';
     /**
      * URL to the image asset
      */
@@ -1369,7 +1372,6 @@ export interface ImageAsset {
  * Video asset with URL and specifications
  */
 export interface VideoAsset {
-    asset_type: 'video';
     /**
      * URL to the video asset
      */
@@ -1399,7 +1401,6 @@ export interface VideoAsset {
  * Audio asset with URL and specifications
  */
 export interface AudioAsset {
-    asset_type: 'audio';
     /**
      * URL to the audio asset
      */
@@ -1421,15 +1422,10 @@ export interface AudioAsset {
  * Text content asset
  */
 export interface TextAsset {
-    asset_type: 'text';
     /**
      * Text content
      */
     content: string;
-    /**
-     * Maximum character length constraint
-     */
-    max_length?: number;
     /**
      * Language code (e.g., 'en', 'es', 'fr')
      */
@@ -1439,7 +1435,6 @@ export interface TextAsset {
  * HTML content asset
  */
 export interface HTMLAsset {
-    asset_type: 'html';
     /**
      * HTML content
      */
@@ -1453,7 +1448,6 @@ export interface HTMLAsset {
  * CSS stylesheet asset
  */
 export interface CSSAsset {
-    asset_type: 'css';
     /**
      * CSS content
      */
@@ -1467,7 +1461,6 @@ export interface CSSAsset {
  * JavaScript code asset
  */
 export interface JavaScriptAsset {
-    asset_type: 'javascript';
     /**
      * JavaScript content
      */
@@ -1478,7 +1471,6 @@ export interface JavaScriptAsset {
     module_type?: 'esm' | 'commonjs' | 'script';
 }
 export interface VASTAsset1 {
-    asset_type?: 'vast';
     /**
      * URL endpoint that returns VAST XML
      */
@@ -1495,10 +1487,6 @@ export interface VASTAsset1 {
      * Whether VPAID (Video Player-Ad Interface Definition) is supported
      */
     vpaid_enabled?: boolean;
-    /**
-     * Maximum allowed wrapper/redirect depth
-     */
-    max_wrapper_depth?: number;
     /**
      * Expected video duration in milliseconds (if known)
      */
@@ -1509,7 +1497,6 @@ export interface VASTAsset1 {
     tracking_events?: ('start' | 'firstQuartile' | 'midpoint' | 'thirdQuartile' | 'complete' | 'impression' | 'click' | 'pause' | 'resume' | 'skip' | 'mute' | 'unmute' | 'fullscreen' | 'exitFullscreen' | 'playerExpand' | 'playerCollapse')[];
 }
 export interface DAASTAsset1 {
-    asset_type?: 'daast';
     /**
      * URL endpoint that returns DAAST XML
      */
@@ -1536,36 +1523,70 @@ export interface DAASTAsset1 {
     companion_ads?: boolean;
 }
 /**
- * Reference to promoted offerings specification
+ * Complete offering specification combining brand manifest, product selectors, and asset filters. Provides all context needed for creative generation about what is being promoted.
  */
-export interface PromotedOfferingsAsset {
-    asset_type: 'promoted_offerings';
+export interface PromotedOfferings {
+    brand_manifest: BrandManifestReference;
+    product_selectors?: PromotedProducts;
     /**
-     * URL of the advertiser's brand or offering (e.g., https://retailer.com)
+     * Inline offerings for campaigns without a product catalog. Each offering has a name, description, and associated assets.
      */
-    url?: string;
+    offerings?: {
+        /**
+         * Offering name (e.g., 'Winter Sale', 'New Product Launch')
+         */
+        name: string;
+        /**
+         * Description of what's being offered
+         */
+        description?: string;
+        /**
+         * Assets specific to this offering
+         */
+        assets?: {
+            [k: string]: unknown;
+        }[];
+    }[];
     /**
-     * Brand colors
+     * Selectors to choose specific assets from the brand manifest
      */
-    colors?: {
-        primary?: string;
-        secondary?: string;
-        accent?: string;
+    asset_selectors?: {
+        /**
+         * Select assets with specific tags (e.g., ['holiday', 'premium'])
+         */
+        tags?: string[];
+        /**
+         * Filter by asset type (e.g., ['image', 'video'])
+         */
+        asset_types?: ('image' | 'video' | 'audio' | 'vast' | 'daast' | 'text' | 'url' | 'html' | 'css' | 'javascript' | 'webhook')[];
+        /**
+         * Exclude assets with these tags
+         */
+        exclude_tags?: string[];
     };
+}
+export interface PromotedProducts {
     /**
-     * Brand fonts
+     * Direct product SKU references from the brand manifest product catalog
      */
-    fonts?: string[];
+    manifest_skus?: string[];
     /**
-     * Brand tone/voice
+     * Select products by tags from the brand manifest product catalog (e.g., 'organic', 'sauces', 'holiday')
      */
-    tone?: string;
+    manifest_tags?: string[];
+    /**
+     * Select products from a specific category in the brand manifest product catalog (e.g., 'beverages/soft-drinks', 'food/sauces')
+     */
+    manifest_category?: string;
+    /**
+     * Natural language query to select products from the brand manifest (e.g., 'all Kraft Heinz pasta sauces', 'organic products under $20')
+     */
+    manifest_query?: string;
 }
 /**
  * URL reference asset
  */
 export interface URLAsset {
-    asset_type: 'url';
     /**
      * URL reference
      */
@@ -1575,6 +1596,9 @@ export interface URLAsset {
      */
     description?: string;
 }
+/**
+ * Webhook configuration for asynchronous task notifications. Uses A2A-compatible PushNotificationConfig structure. Supports Bearer tokens (simple) or HMAC signatures (production-recommended).
+ */
 export interface PushNotificationConfig {
     /**
      * Webhook endpoint URL for task status notifications
@@ -1962,7 +1986,7 @@ export interface ListCreativesResponse {
              * This interface was referenced by `undefined`'s JSON-Schema definition
              * via the `patternProperty` "^[a-zA-Z0-9_-]+$".
              */
-            [k: string]: ImageAsset | VideoAsset | AudioAsset | TextAsset | HTMLAsset | CSSAsset | JavaScriptAsset | VASTAsset | DAASTAsset | PromotedOfferingsAsset | URLAsset;
+            [k: string]: ImageAsset | VideoAsset | AudioAsset | TextAsset | HTMLAsset | CSSAsset | JavaScriptAsset | VASTAsset | DAASTAsset | PromotedOfferings | URLAsset;
         };
         /**
          * Landing page URL for the creative
@@ -2605,6 +2629,386 @@ export interface ProvidePerformanceFeedbackResponse {
 /**
  * Standard error structure for task-specific errors and warnings
  */
+/**
+ * VAST (Video Ad Serving Template) tag for third-party video ad serving
+ */
+export interface BuildCreativeRequest {
+    /**
+     * Natural language instructions for the transformation or generation. For pure generation, this is the creative brief. For transformation, this provides guidance on how to adapt the creative.
+     */
+    message?: string;
+    creative_manifest?: CreativeManifest;
+    target_format_id: FormatID1;
+}
+/**
+ * Creative manifest to transform or generate from. For pure generation, this should include the target format_id and any required input assets (e.g., promoted_offerings for generative formats). For transformation (e.g., resizing, reformatting), this is the complete creative to adapt.
+ */
+export interface CreativeManifest {
+    format_id: FormatID;
+    /**
+     * Product name or offering being advertised. Maps to promoted_offerings in create_media_buy request to associate creative with the product being promoted.
+     */
+    promoted_offering?: string;
+    /**
+     * Map of asset IDs to actual asset content. Each key MUST match an asset_id from the format's assets_required array (e.g., 'banner_image', 'clickthrough_url', 'video_file', 'vast_tag'). The asset_id is the technical identifier used to match assets to format requirements.
+     *
+     * IMPORTANT: Creative manifest validation MUST be performed in the context of the format specification. The format defines what type each asset_id should be, which eliminates any validation ambiguity.
+     */
+    assets: {
+        /**
+         * This interface was referenced by `undefined`'s JSON-Schema definition
+         * via the `patternProperty` "^[a-z0-9_]+$".
+         */
+        [k: string]: ImageAsset | VideoAsset | AudioAsset | VASTAsset | TextAsset | URLAsset | HTMLAsset | JavaScriptAsset | WebhookAsset | CSSAsset | DAASTAsset | PromotedOfferings;
+    };
+}
+/**
+ * Format identifier this manifest is for
+ */
+export interface WebhookAsset {
+    /**
+     * Webhook URL to call for dynamic content
+     */
+    url: string;
+    /**
+     * HTTP method
+     */
+    method?: 'GET' | 'POST';
+    /**
+     * Maximum time to wait for response in milliseconds
+     */
+    timeout_ms?: number;
+    /**
+     * Universal macros that can be passed to webhook (e.g., {DEVICE_TYPE}, {COUNTRY})
+     */
+    supported_macros?: string[];
+    /**
+     * Universal macros that must be provided for webhook to function
+     */
+    required_macros?: string[];
+    /**
+     * Expected content type of webhook response
+     */
+    response_type: 'html' | 'json' | 'xml' | 'javascript';
+    /**
+     * Security configuration for webhook calls
+     */
+    security: {
+        /**
+         * Authentication method
+         */
+        method: 'hmac_sha256' | 'api_key' | 'none';
+        /**
+         * Header name for HMAC signature (e.g., 'X-Signature')
+         */
+        hmac_header?: string;
+        /**
+         * Header name for API key (e.g., 'X-API-Key')
+         */
+        api_key_header?: string;
+    };
+}
+/**
+ * CSS stylesheet asset
+ */
+/**
+ * VAST (Video Ad Serving Template) tag for third-party video ad serving
+ */
+export interface BuildCreativeResponse {
+    creative_manifest: CreativeManifest;
+    /**
+     * Task-specific errors and warnings
+     */
+    errors?: Error[];
+}
+/**
+ * The generated or transformed creative manifest
+ */
+/**
+ * VAST (Video Ad Serving Template) tag for third-party video ad serving
+ */
+export interface PreviewCreativeRequest {
+    format_id: FormatID;
+    creative_manifest: CreativeManifest;
+    /**
+     * Array of input sets for generating multiple preview variants. Each input set defines macros and context values for one preview rendering. If not provided, creative agent will generate default previews.
+     */
+    inputs?: {
+        /**
+         * Human-readable name for this input set (e.g., 'Sunny morning on mobile', 'Evening podcast ad', 'Desktop dark mode')
+         */
+        name: string;
+        /**
+         * Macro values to use for this preview. Supports all universal macros from the format's supported_macros list. See docs/media-buy/creatives/universal-macros.md for available macros.
+         */
+        macros?: {
+            [k: string]: string;
+        };
+        /**
+         * Natural language description of the context for AI-generated content (e.g., 'User just searched for running shoes', 'Podcast discussing weather patterns', 'Article about electric vehicles')
+         */
+        context_description?: string;
+    }[];
+    /**
+     * Specific template ID for custom format rendering
+     */
+    template_id?: string;
+}
+/**
+ * Format identifier for rendering the preview
+ */
+/**
+ * Response containing preview links for a creative. Each preview URL returns an HTML page that can be embedded in an iframe to display the rendered creative.
+ */
+export interface PreviewCreativeResponse {
+    /**
+     * Array of preview variants. Each preview corresponds to an input set from the request. If no inputs were provided, returns a single default preview.
+     *
+     * @minItems 1
+     */
+    previews: [
+        {
+            /**
+             * Unique identifier for this preview variant
+             */
+            preview_id: string;
+            /**
+             * Array of rendered pieces for this preview variant. Most formats render as a single piece. Companion ad formats (video + banner), multi-placement formats, and adaptive formats render as multiple pieces.
+             *
+             * @minItems 1
+             */
+            renders: [
+                {
+                    /**
+                     * Unique identifier for this rendered piece within the variant
+                     */
+                    render_id: string;
+                    /**
+                     * URL to an HTML page that renders this piece. Can be embedded in an iframe. Handles all rendering complexity internally (images, video players, audio players, interactive content, etc.).
+                     */
+                    preview_url: string;
+                    /**
+                     * Semantic role of this rendered piece. Use 'primary' for main content, 'companion' for associated banners, descriptive strings for device variants or custom roles.
+                     */
+                    role: string;
+                    /**
+                     * Dimensions for this rendered piece. For companion ads with multiple sizes, this specifies which size this piece is.
+                     */
+                    dimensions?: {
+                        width: number;
+                        height: number;
+                    };
+                    /**
+                     * Optional security and embedding metadata for safe iframe integration
+                     */
+                    embedding?: {
+                        /**
+                         * Recommended iframe sandbox attribute value (e.g., 'allow-scripts allow-same-origin')
+                         */
+                        recommended_sandbox?: string;
+                        /**
+                         * Whether this output requires HTTPS for secure embedding
+                         */
+                        requires_https?: boolean;
+                        /**
+                         * Whether this output supports fullscreen mode
+                         */
+                        supports_fullscreen?: boolean;
+                        /**
+                         * Content Security Policy requirements for embedding
+                         */
+                        csp_policy?: string;
+                    };
+                },
+                ...{
+                    /**
+                     * Unique identifier for this rendered piece within the variant
+                     */
+                    render_id: string;
+                    /**
+                     * URL to an HTML page that renders this piece. Can be embedded in an iframe. Handles all rendering complexity internally (images, video players, audio players, interactive content, etc.).
+                     */
+                    preview_url: string;
+                    /**
+                     * Semantic role of this rendered piece. Use 'primary' for main content, 'companion' for associated banners, descriptive strings for device variants or custom roles.
+                     */
+                    role: string;
+                    /**
+                     * Dimensions for this rendered piece. For companion ads with multiple sizes, this specifies which size this piece is.
+                     */
+                    dimensions?: {
+                        width: number;
+                        height: number;
+                    };
+                    /**
+                     * Optional security and embedding metadata for safe iframe integration
+                     */
+                    embedding?: {
+                        /**
+                         * Recommended iframe sandbox attribute value (e.g., 'allow-scripts allow-same-origin')
+                         */
+                        recommended_sandbox?: string;
+                        /**
+                         * Whether this output requires HTTPS for secure embedding
+                         */
+                        requires_https?: boolean;
+                        /**
+                         * Whether this output supports fullscreen mode
+                         */
+                        supports_fullscreen?: boolean;
+                        /**
+                         * Content Security Policy requirements for embedding
+                         */
+                        csp_policy?: string;
+                    };
+                }[]
+            ];
+            /**
+             * The input parameters that generated this preview variant. Echoes back the request input or shows defaults used.
+             */
+            input: {
+                /**
+                 * Human-readable name for this variant
+                 */
+                name: string;
+                /**
+                 * Macro values applied to this variant
+                 */
+                macros?: {
+                    [k: string]: string;
+                };
+                /**
+                 * Context description applied to this variant
+                 */
+                context_description?: string;
+            };
+        },
+        ...{
+            /**
+             * Unique identifier for this preview variant
+             */
+            preview_id: string;
+            /**
+             * Array of rendered pieces for this preview variant. Most formats render as a single piece. Companion ad formats (video + banner), multi-placement formats, and adaptive formats render as multiple pieces.
+             *
+             * @minItems 1
+             */
+            renders: [
+                {
+                    /**
+                     * Unique identifier for this rendered piece within the variant
+                     */
+                    render_id: string;
+                    /**
+                     * URL to an HTML page that renders this piece. Can be embedded in an iframe. Handles all rendering complexity internally (images, video players, audio players, interactive content, etc.).
+                     */
+                    preview_url: string;
+                    /**
+                     * Semantic role of this rendered piece. Use 'primary' for main content, 'companion' for associated banners, descriptive strings for device variants or custom roles.
+                     */
+                    role: string;
+                    /**
+                     * Dimensions for this rendered piece. For companion ads with multiple sizes, this specifies which size this piece is.
+                     */
+                    dimensions?: {
+                        width: number;
+                        height: number;
+                    };
+                    /**
+                     * Optional security and embedding metadata for safe iframe integration
+                     */
+                    embedding?: {
+                        /**
+                         * Recommended iframe sandbox attribute value (e.g., 'allow-scripts allow-same-origin')
+                         */
+                        recommended_sandbox?: string;
+                        /**
+                         * Whether this output requires HTTPS for secure embedding
+                         */
+                        requires_https?: boolean;
+                        /**
+                         * Whether this output supports fullscreen mode
+                         */
+                        supports_fullscreen?: boolean;
+                        /**
+                         * Content Security Policy requirements for embedding
+                         */
+                        csp_policy?: string;
+                    };
+                },
+                ...{
+                    /**
+                     * Unique identifier for this rendered piece within the variant
+                     */
+                    render_id: string;
+                    /**
+                     * URL to an HTML page that renders this piece. Can be embedded in an iframe. Handles all rendering complexity internally (images, video players, audio players, interactive content, etc.).
+                     */
+                    preview_url: string;
+                    /**
+                     * Semantic role of this rendered piece. Use 'primary' for main content, 'companion' for associated banners, descriptive strings for device variants or custom roles.
+                     */
+                    role: string;
+                    /**
+                     * Dimensions for this rendered piece. For companion ads with multiple sizes, this specifies which size this piece is.
+                     */
+                    dimensions?: {
+                        width: number;
+                        height: number;
+                    };
+                    /**
+                     * Optional security and embedding metadata for safe iframe integration
+                     */
+                    embedding?: {
+                        /**
+                         * Recommended iframe sandbox attribute value (e.g., 'allow-scripts allow-same-origin')
+                         */
+                        recommended_sandbox?: string;
+                        /**
+                         * Whether this output requires HTTPS for secure embedding
+                         */
+                        requires_https?: boolean;
+                        /**
+                         * Whether this output supports fullscreen mode
+                         */
+                        supports_fullscreen?: boolean;
+                        /**
+                         * Content Security Policy requirements for embedding
+                         */
+                        csp_policy?: string;
+                    };
+                }[]
+            ];
+            /**
+             * The input parameters that generated this preview variant. Echoes back the request input or shows defaults used.
+             */
+            input: {
+                /**
+                 * Human-readable name for this variant
+                 */
+                name: string;
+                /**
+                 * Macro values applied to this variant
+                 */
+                macros?: {
+                    [k: string]: string;
+                };
+                /**
+                 * Context description applied to this variant
+                 */
+                context_description?: string;
+            };
+        }[]
+    ];
+    /**
+     * Optional URL to an interactive testing page that shows all preview variants with controls to switch between them, modify macro values, and test different scenarios.
+     */
+    interactive_url?: string;
+    /**
+     * ISO 8601 timestamp when preview links expire
+     */
+    expires_at: string;
+}
 /**
  * Request parameters for discovering signals based on description
  */