@adcp/client 3.3.3 → 3.4.0

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

@@ -1311,44 +1311,6 @@ export interface FormatID3 {
  * Budget pacing strategy
  */
 export type Pacing = 'even' | 'asap' | 'front_loaded';
-/**
- * Image asset with URL and dimensions
- */
-export type ImageAsset = Dimensions & {
-    /**
-     * URL to the image asset
-     */
-    url: string;
-    /**
-     * Image file format (jpg, png, gif, webp, etc.)
-     */
-    format?: string;
-    /**
-     * Alternative text for accessibility
-     */
-    alt_text?: string;
-};
-/**
- * Video asset with URL and specifications
- */
-export type VideoAsset = Dimensions & {
-    /**
-     * URL to the video asset
-     */
-    url: string;
-    /**
-     * Video duration in milliseconds
-     */
-    duration_ms?: number;
-    /**
-     * Video file format (mp4, webm, mov, etc.)
-     */
-    format?: string;
-    /**
-     * Video bitrate in kilobits per second
-     */
-    bitrate_kbps?: number;
-};
 /**
  * JavaScript module type
  */
@@ -1671,7 +1633,36 @@ export interface CreativeAsset {
 /**
  * Structured format identifier with agent URL and format name. Can reference: (1) a concrete format with fixed dimensions (id only), (2) a template format without parameters (id only), or (3) a template format with parameters (id + dimensions/duration). Template formats accept parameters in format_id while concrete formats have fixed dimensions in their definition. Parameterized format IDs create unique, specific format variants.
  */
-export interface Dimensions {
+export interface ImageAsset {
+    /**
+     * URL to the image asset
+     */
+    url: string;
+    /**
+     * Width in pixels
+     */
+    width: number;
+    /**
+     * Height in pixels
+     */
+    height: number;
+    /**
+     * Image file format (jpg, png, gif, webp, etc.)
+     */
+    format?: string;
+    /**
+     * Alternative text for accessibility
+     */
+    alt_text?: string;
+}
+/**
+ * Video asset with URL and specifications
+ */
+export interface VideoAsset {
+    /**
+     * URL to the video asset
+     */
+    url: string;
     /**
      * Width in pixels
      */
@@ -1680,6 +1671,18 @@ export interface Dimensions {
      * Height in pixels
      */
     height: number;
+    /**
+     * Video duration in milliseconds
+     */
+    duration_ms?: number;
+    /**
+     * Video file format (mp4, webm, mov, etc.)
+     */
+    format?: string;
+    /**
+     * Video bitrate in kilobits per second
+     */
+    bitrate_kbps?: number;
 }
 /**
  * Audio asset with URL and specifications
@@ -1864,7 +1867,11 @@ export interface PushNotificationConfig {
 /**
  * Response payload for create_media_buy task. Returns either complete success data OR error information, never both. This enforces atomic operation semantics - the media buy is either fully created or not created at all.
  */
-export type CreateMediaBuyResponse = {
+export type CreateMediaBuyResponse = CreateMediaBuySuccess | CreateMediaBuyError;
+/**
+ * Budget pacing strategy
+ */
+export interface CreateMediaBuySuccess {
     /**
      * Publisher's unique identifier for the created media buy
      */
@@ -1883,18 +1890,9 @@ export type CreateMediaBuyResponse = {
     packages: Package[];
     context?: ContextObject;
     ext?: ExtensionObject;
-} | {
-    /**
-     * Array of errors explaining why the operation failed
-     *
-     * @minItems 1
-     */
-    errors: [Error, ...Error[]];
-    context?: ContextObject;
-    ext?: ExtensionObject;
-};
+}
 /**
- * Budget pacing strategy
+ * A specific product within a media buy (line item)
  */
 export interface Package {
     /**
@@ -1963,8 +1961,21 @@ export interface CreativeAssignment {
 /**
  * Structured format identifier with agent URL and format name. Can reference: (1) a concrete format with fixed dimensions (id only), (2) a template format without parameters (id only), or (3) a template format with parameters (id + dimensions/duration). Template formats accept parameters in format_id while concrete formats have fixed dimensions in their definition. Parameterized format IDs create unique, specific format variants.
  */
+export interface CreateMediaBuyError {
+    /**
+     * Array of errors explaining why the operation failed
+     *
+     * @minItems 1
+     */
+    errors: [Error, ...Error[]];
+    context?: ContextObject;
+    ext?: ExtensionObject;
+}
+/**
+ * Standard error structure for task-specific errors and warnings
+ */
 /**
- * Image asset with URL and dimensions
+ * JavaScript module type
  */
 export type ValidationMode = 'strict' | 'lenient';
 /**
@@ -2014,7 +2025,15 @@ export interface SyncCreativesRequest {
 /**
  * Response from creative sync operation. Returns either per-creative results (best-effort processing) OR operation-level errors (complete failure). This enforces atomic semantics at the operation level while allowing per-item failures within successful operations.
  */
-export type SyncCreativesResponse = {
+export type SyncCreativesResponse = SyncCreativesSuccess | SyncCreativesError;
+/**
+ * Action taken for this creative
+ */
+export type CreativeAction = 'created' | 'updated' | 'unchanged' | 'failed' | 'deleted';
+/**
+ * Success response - sync operation processed creatives (may include per-item failures)
+ */
+export interface SyncCreativesSuccess {
     /**
      * Whether this was a dry run (no actual changes made)
      */
@@ -2071,7 +2090,11 @@ export type SyncCreativesResponse = {
     }[];
     context?: ContextObject;
     ext?: ExtensionObject;
-} | {
+}
+/**
+ * Opaque correlation data that is echoed unchanged in responses. Used for internal tracking, UI session IDs, trace IDs, and other caller-specific identifiers that don't affect protocol behavior. Context data is never parsed by AdCP agents - it's simply preserved and returned.
+ */
+export interface SyncCreativesError {
     /**
      * Operation-level errors that prevented processing any creatives (e.g., authentication failure, service unavailable, invalid request format)
      *
@@ -2080,13 +2103,9 @@ export type SyncCreativesResponse = {
     errors: [Error, ...Error[]];
     context?: ContextObject;
     ext?: ExtensionObject;
-};
-/**
- * Action taken for this creative
- */
-export type CreativeAction = 'created' | 'updated' | 'unchanged' | 'failed' | 'deleted';
+}
 /**
- * Opaque correlation data that is echoed unchanged in responses. Used for internal tracking, UI session IDs, trace IDs, and other caller-specific identifiers that don't affect protocol behavior. Context data is never parsed by AdCP agents - it's simply preserved and returned.
+ * Standard error structure for task-specific errors and warnings
  */
 /**
  * Filter by creative approval status
@@ -2500,7 +2519,11 @@ export interface UpdateMediaBuyRequest1 {
 /**
  * Response payload for update_media_buy task. Returns either complete success data OR error information, never both. This enforces atomic operation semantics - updates are either fully applied or not applied at all.
  */
-export type UpdateMediaBuyResponse = {
+export type UpdateMediaBuyResponse = UpdateMediaBuySuccess | UpdateMediaBuyError;
+/**
+ * Budget pacing strategy
+ */
+export interface UpdateMediaBuySuccess {
     /**
      * Publisher's identifier for the media buy
      */
@@ -2519,7 +2542,11 @@ export type UpdateMediaBuyResponse = {
     affected_packages?: Package[];
     context?: ContextObject;
     ext?: ExtensionObject;
-} | {
+}
+/**
+ * A specific product within a media buy (line item)
+ */
+export interface UpdateMediaBuyError {
     /**
      * Array of errors explaining why the operation failed
      *
@@ -2528,9 +2555,9 @@ export type UpdateMediaBuyResponse = {
     errors: [Error, ...Error[]];
     context?: ContextObject;
     ext?: ExtensionObject;
-};
+}
 /**
- * Budget pacing strategy
+ * Standard error structure for task-specific errors and warnings
  */
 /**
  * Status of a media buy
@@ -2979,14 +3006,22 @@ export interface ProvidePerformanceFeedbackRequest1 {
 /**
  * Response payload for provide_performance_feedback task. Returns either success confirmation OR error information, never both.
  */
-export type ProvidePerformanceFeedbackResponse = {
+export type ProvidePerformanceFeedbackResponse = ProvidePerformanceFeedbackSuccess | ProvidePerformanceFeedbackError;
+/**
+ * Success response - feedback received and processed
+ */
+export interface ProvidePerformanceFeedbackSuccess {
     /**
      * Whether the performance feedback was successfully received
      */
     success: true;
     context?: ContextObject;
     ext?: ExtensionObject;
-} | {
+}
+/**
+ * Opaque correlation data that is echoed unchanged in responses. Used for internal tracking, UI session IDs, trace IDs, and other caller-specific identifiers that don't affect protocol behavior. Context data is never parsed by AdCP agents - it's simply preserved and returned.
+ */
+export interface ProvidePerformanceFeedbackError {
     /**
      * Array of errors explaining why feedback was rejected (e.g., invalid measurement period, missing campaign data)
      *
@@ -2995,12 +3030,12 @@ export type ProvidePerformanceFeedbackResponse = {
     errors: [Error, ...Error[]];
     context?: ContextObject;
     ext?: ExtensionObject;
-};
+}
 /**
- * Opaque correlation data that is echoed unchanged in responses. Used for internal tracking, UI session IDs, trace IDs, and other caller-specific identifiers that don't affect protocol behavior. Context data is never parsed by AdCP agents - it's simply preserved and returned.
+ * Standard error structure for task-specific errors and warnings
  */
 /**
- * Image asset with URL and dimensions
+ * VAST (Video Ad Serving Template) tag for third-party video ad serving
  */
 export type HTTPMethod = 'GET' | 'POST';
 /**
@@ -3090,11 +3125,19 @@ export interface WebhookAsset {
 /**
  * Response containing the transformed or generated creative manifest, ready for use with preview_creative or sync_creatives. Returns either the complete creative manifest OR error information, never both.
  */
-export type BuildCreativeResponse = {
+export type BuildCreativeResponse = BuildCreativeSuccess | BuildCreativeError;
+/**
+ * VAST (Video Ad Serving Template) tag for third-party video ad serving
+ */
+export interface BuildCreativeSuccess {
     creative_manifest: CreativeManifest;
     context?: ContextObject;
     ext?: ExtensionObject;
-} | {
+}
+/**
+ * The generated or transformed creative manifest
+ */
+export interface BuildCreativeError {
     /**
      * Array of errors explaining why creative generation failed
      *
@@ -3103,9 +3146,9 @@ export type BuildCreativeResponse = {
     errors: [Error, ...Error[]];
     context?: ContextObject;
     ext?: ExtensionObject;
-};
+}
 /**
- * Image asset with URL and dimensions
+ * Standard error structure for task-specific errors and warnings
  */
 /**
  * Request to generate previews of one or more creative manifests. Accepts either a single creative request or an array of requests for batch processing.
@@ -3217,7 +3260,7 @@ export type PreviewCreativeRequest = {
     ext?: ExtensionObject;
 };
 /**
- * Image asset with URL and dimensions
+ * VAST (Video Ad Serving Template) tag for third-party video ad serving
  */
 export type PreviewOutputFormat = 'url' | 'html';
 /**
@@ -3254,115 +3297,7 @@ export interface CreativeManifest1 {
 /**
  * Response containing preview links for one or more creatives. Format matches the request: single preview response for single requests, batch results for batch requests.
  */
-export type PreviewCreativeResponse = {
-    /**
-     * Discriminator indicating this is a single preview response
-     */
-    response_type: 'single';
-    /**
-     * 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: [PreviewRender, ...PreviewRender[]];
-            /**
-             * 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: [PreviewRender, ...PreviewRender[]];
-            /**
-             * 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;
-    context?: ContextObject;
-    ext?: ExtensionObject;
-} | {
-    /**
-     * Discriminator indicating this is a batch preview response
-     */
-    response_type: 'batch';
-    /**
-     * Array of preview results corresponding to each request in the same order. results[0] is the result for requests[0], results[1] for requests[1], etc. Order is guaranteed even when some requests fail. Each result contains either a successful preview response or an error.
-     *
-     * @minItems 1
-     */
-    results: [
-        ({
-            success?: true;
-        } | {
-            success?: false;
-        }),
-        ...({
-            success?: true;
-        } | {
-            success?: false;
-        })[]
-    ];
-    context?: ContextObject;
-    ext?: ExtensionObject;
-};
+export type PreviewCreativeResponse = PreviewCreativeSingleResponse | PreviewCreativeBatchResponse;
 /**
  * A single rendered piece of a creative preview with discriminated output format
  */
@@ -3506,9 +3441,120 @@ export type PreviewRender = {
         csp_policy?: string;
     };
 };
+/**
+ * Single preview response - each preview URL returns an HTML page that can be embedded in an iframe
+ */
+export interface PreviewCreativeSingleResponse {
+    /**
+     * Discriminator indicating this is a single preview response
+     */
+    response_type: 'single';
+    /**
+     * 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: [PreviewRender, ...PreviewRender[]];
+            /**
+             * 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: [PreviewRender, ...PreviewRender[]];
+            /**
+             * 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;
+    context?: ContextObject;
+    ext?: ExtensionObject;
+}
 /**
  * Opaque correlation data that is echoed unchanged in responses. Used for internal tracking, UI session IDs, trace IDs, and other caller-specific identifiers that don't affect protocol behavior. Context data is never parsed by AdCP agents - it's simply preserved and returned.
  */
+export interface PreviewCreativeBatchResponse {
+    /**
+     * Discriminator indicating this is a batch preview response
+     */
+    response_type: 'batch';
+    /**
+     * Array of preview results corresponding to each request in the same order. results[0] is the result for requests[0], results[1] for requests[1], etc. Order is guaranteed even when some requests fail. Each result contains either a successful preview response or an error.
+     *
+     * @minItems 1
+     */
+    results: [
+        PreviewBatchResultSuccess | PreviewBatchResultError,
+        ...(PreviewBatchResultSuccess | PreviewBatchResultError)[]
+    ];
+    context?: ContextObject;
+    ext?: ExtensionObject;
+}
+export interface PreviewBatchResultSuccess {
+    success?: true;
+}
+export interface PreviewBatchResultError {
+    success?: false;
+}
 /**
  * A deployment target where signals can be activated (DSP, sales agent, etc.)
  */
@@ -3786,14 +3832,22 @@ export interface ActivateSignalRequest {
 /**
  * Response payload for activate_signal task. Returns either complete success data OR error information, never both. This enforces atomic operation semantics - the signal is either fully activated or not activated at all.
  */
-export type ActivateSignalResponse = {
+export type ActivateSignalResponse = ActivateSignalSuccess | ActivateSignalError;
+/**
+ * A signal deployment to a specific deployment target with activation status and key
+ */
+export interface ActivateSignalSuccess {
     /**
      * Array of deployment results for each deployment target
      */
     deployments: Deployment[];
     context?: ContextObject;
     ext?: ExtensionObject;
-} | {
+}
+/**
+ * Opaque correlation data that is echoed unchanged in responses. Used for internal tracking, UI session IDs, trace IDs, and other caller-specific identifiers that don't affect protocol behavior. Context data is never parsed by AdCP agents - it's simply preserved and returned.
+ */
+export interface ActivateSignalError {
     /**
      * Array of errors explaining why activation failed (e.g., platform connectivity issues, signal definition problems, authentication failures)
      *
@@ -3802,8 +3856,8 @@ export type ActivateSignalResponse = {
     errors: [Error, ...Error[]];
     context?: ContextObject;
     ext?: ExtensionObject;
-};
+}
 /**
- * A signal deployment to a specific deployment target with activation status and key
+ * Standard error structure for task-specific errors and warnings
  */
 //# sourceMappingURL=tools.generated.d.ts.map