@adcp/sdk 5.25.1 → 6.1.0

package/dist/lib/schemas-data/v2.5/media-buy/build-creative-response.json

@@ -0,0 +1,65 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/media-buy/build-creative-response.json",
+  "title": "Build Creative Response",
+  "description": "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.",
+  "type": "object",
+  "oneOf": [
+    {
+      "title": "BuildCreativeSuccess",
+      "description": "Success response - creative manifest generated successfully",
+      "type": "object",
+      "properties": {
+        "creative_manifest": {
+          "$ref": "/schemas/core/creative-manifest.json",
+          "description": "The generated or transformed creative manifest"
+        },
+        "context": {
+          "$ref": "/schemas/core/context.json"
+        },
+        "ext": {
+          "$ref": "/schemas/core/ext.json"
+        }
+      },
+      "required": [
+        "creative_manifest"
+      ],
+      "additionalProperties": true,
+      "not": {
+        "required": [
+          "errors"
+        ]
+      }
+    },
+    {
+      "title": "BuildCreativeError",
+      "description": "Error response - creative generation failed",
+      "type": "object",
+      "properties": {
+        "errors": {
+          "type": "array",
+          "description": "Array of errors explaining why creative generation failed",
+          "items": {
+            "$ref": "/schemas/core/error.json"
+          },
+          "minItems": 1
+        },
+        "context": {
+          "$ref": "/schemas/core/context.json"
+        },
+        "ext": {
+          "$ref": "/schemas/core/ext.json"
+        }
+      },
+      "required": [
+        "errors"
+      ],
+      "additionalProperties": true,
+      "not": {
+        "required": [
+          "creative_manifest"
+        ]
+      }
+    }
+  ]
+}

package/dist/lib/schemas-data/v2.5/media-buy/create-media-buy-async-response-input-required.json

@@ -0,0 +1,31 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/media-buy/create-media-buy-async-response-input-required.json",
+  "title": "Create Media Buy - Input Required",
+  "description": "Payload when task is paused waiting for user input or approval.",
+  "type": "object",
+  "properties": {
+    "reason": {
+      "type": "string",
+      "enum": [
+        "APPROVAL_REQUIRED",
+        "BUDGET_EXCEEDS_LIMIT"
+      ],
+      "description": "Reason code indicating why input is needed"
+    },
+    "errors": {
+      "type": "array",
+      "description": "Optional validation errors or warnings for debugging purposes. Helps explain why input is required.",
+      "items": {
+        "$ref": "/schemas/core/error.json"
+      }
+    },
+    "context": {
+      "$ref": "/schemas/core/context.json"
+    },
+    "ext": {
+      "$ref": "/schemas/core/ext.json"
+    }
+  },
+  "additionalProperties": true
+}

package/dist/lib/schemas-data/v2.5/media-buy/create-media-buy-async-response-submitted.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/media-buy/create-media-buy-async-response-submitted.json",
+  "title": "Create Media Buy - Submitted",
+  "description": "Payload acknowledging the task is queued. Usually empty or just context.",
+  "type": "object",
+  "properties": {
+    "context": {
+      "$ref": "/schemas/core/context.json"
+    },
+    "ext": {
+      "$ref": "/schemas/core/ext.json"
+    }
+  },
+  "additionalProperties": true
+}

package/dist/lib/schemas-data/v2.5/media-buy/create-media-buy-async-response-working.json

@@ -0,0 +1,36 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/media-buy/create-media-buy-async-response-working.json",
+  "title": "Create Media Buy - Working",
+  "description": "Progress payload for active create_media_buy task.",
+  "type": "object",
+  "properties": {
+    "percentage": {
+      "type": "number",
+      "minimum": 0,
+      "maximum": 100,
+      "description": "Completion percentage (0-100)"
+    },
+    "current_step": {
+      "type": "string",
+      "description": "Current step or phase of the operation"
+    },
+    "total_steps": {
+      "type": "integer",
+      "minimum": 1,
+      "description": "Total number of steps in the operation"
+    },
+    "step_number": {
+      "type": "integer",
+      "minimum": 1,
+      "description": "Current step number"
+    },
+    "context": {
+      "$ref": "/schemas/core/context.json"
+    },
+    "ext": {
+      "$ref": "/schemas/core/ext.json"
+    }
+  },
+  "additionalProperties": true
+}

package/dist/lib/schemas-data/v2.5/media-buy/create-media-buy-request.json

@@ -0,0 +1,126 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/media-buy/create-media-buy-request.json",
+  "title": "Create Media Buy Request",
+  "description": "Request parameters for creating a media buy",
+  "type": "object",
+  "properties": {
+    "buyer_ref": {
+      "type": "string",
+      "description": "Buyer's reference identifier for this media buy"
+    },
+    "packages": {
+      "type": "array",
+      "description": "Array of package configurations",
+      "items": {
+        "$ref": "/schemas/media-buy/package-request.json"
+      }
+    },
+    "brand_manifest": {
+      "$ref": "/schemas/core/brand-manifest-ref.json",
+      "description": "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."
+    },
+    "po_number": {
+      "type": "string",
+      "description": "Purchase order number for tracking"
+    },
+    "start_time": {
+      "$ref": "/schemas/core/start-timing.json"
+    },
+    "end_time": {
+      "type": "string",
+      "format": "date-time",
+      "description": "Campaign end date/time in ISO 8601 format"
+    },
+    "reporting_webhook": {
+      "$comment": "Fields url, token, and authentication mirror push-notification-config.json. Inlined here because allOf + additionalProperties:false doesn't work in JSON Schema (additionalProperties can't see $ref properties). See CLAUDE.md 'Avoiding allOf with additionalProperties'.",
+      "type": "object",
+      "description": "Optional webhook configuration for automated reporting delivery. Combines push_notification_config structure with reporting-specific fields.",
+      "properties": {
+        "url": {
+          "type": "string",
+          "format": "uri",
+          "description": "Webhook endpoint URL for reporting notifications"
+        },
+        "token": {
+          "type": "string",
+          "description": "Optional client-provided token for webhook validation. Echoed back in webhook payload to validate request authenticity.",
+          "minLength": 16
+        },
+        "authentication": {
+          "type": "object",
+          "description": "Authentication configuration for webhook delivery (A2A-compatible)",
+          "properties": {
+            "schemes": {
+              "type": "array",
+              "description": "Array of authentication schemes. Supported: ['Bearer'] for simple token auth, ['HMAC-SHA256'] for signature verification (recommended for production)",
+              "items": {
+                "$ref": "/schemas/enums/auth-scheme.json"
+              },
+              "minItems": 1,
+              "maxItems": 1
+            },
+            "credentials": {
+              "type": "string",
+              "description": "Credentials for authentication. For Bearer: token sent in Authorization header. For HMAC-SHA256: shared secret used to generate signature. Minimum 32 characters. Exchanged out-of-band during onboarding.",
+              "minLength": 32
+            }
+          },
+          "required": [
+            "schemes",
+            "credentials"
+          ],
+          "additionalProperties": false
+        },
+        "reporting_frequency": {
+          "type": "string",
+          "enum": [
+            "hourly",
+            "daily",
+            "monthly"
+          ],
+          "description": "Frequency for automated reporting delivery. Must be supported by all products in the media buy."
+        },
+        "requested_metrics": {
+          "type": "array",
+          "description": "Optional list of metrics to include in webhook notifications. If omitted, all available metrics are included. Must be subset of product's available_metrics.",
+          "items": {
+            "type": "string",
+            "enum": [
+              "impressions",
+              "spend",
+              "clicks",
+              "ctr",
+              "video_completions",
+              "completion_rate",
+              "conversions",
+              "viewability",
+              "engagement_rate"
+            ]
+          },
+          "uniqueItems": true
+        }
+      },
+      "required": [
+        "url",
+        "authentication",
+        "reporting_frequency"
+      ],
+      "additionalProperties": true
+    },
+    "context": {
+      "$ref": "/schemas/core/context.json"
+    },
+    "ext": {
+      "$ref": "/schemas/core/ext.json"
+    }
+  },
+  "required": [
+    "buyer_ref",
+    "packages",
+    "brand_manifest",
+    "start_time",
+    "end_time"
+  ],
+  "additionalProperties": true
+}

package/dist/lib/schemas-data/v2.5/media-buy/create-media-buy-response.json

@@ -0,0 +1,97 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/media-buy/create-media-buy-response.json",
+  "title": "Create Media Buy Response",
+  "description": "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.",
+  "type": "object",
+  "oneOf": [
+    {
+      "title": "CreateMediaBuySuccess",
+      "description": "Success response - media buy created successfully",
+      "type": "object",
+      "properties": {
+        "media_buy_id": {
+          "type": "string",
+          "description": "Publisher's unique identifier for the created media buy"
+        },
+        "buyer_ref": {
+          "type": "string",
+          "description": "Buyer's reference identifier for this media buy"
+        },
+        "creative_deadline": {
+          "type": "string",
+          "format": "date-time",
+          "description": "ISO 8601 timestamp for creative upload deadline"
+        },
+        "packages": {
+          "type": "array",
+          "description": "Array of created packages with complete state information",
+          "items": {
+            "$ref": "/schemas/core/package.json"
+          }
+        },
+        "context": {
+          "$ref": "/schemas/core/context.json"
+        },
+        "ext": {
+          "$ref": "/schemas/core/ext.json"
+        }
+      },
+      "required": [
+        "media_buy_id",
+        "buyer_ref",
+        "packages"
+      ],
+      "additionalProperties": true,
+      "not": {
+        "required": [
+          "errors"
+        ]
+      }
+    },
+    {
+      "title": "CreateMediaBuyError",
+      "description": "Error response - operation failed, no media buy created",
+      "type": "object",
+      "properties": {
+        "errors": {
+          "type": "array",
+          "description": "Array of errors explaining why the operation failed",
+          "items": {
+            "$ref": "/schemas/core/error.json"
+          },
+          "minItems": 1
+        },
+        "context": {
+          "$ref": "/schemas/core/context.json"
+        },
+        "ext": {
+          "$ref": "/schemas/core/ext.json"
+        }
+      },
+      "required": [
+        "errors"
+      ],
+      "additionalProperties": true,
+      "not": {
+        "anyOf": [
+          {
+            "required": [
+              "media_buy_id"
+            ]
+          },
+          {
+            "required": [
+              "buyer_ref"
+            ]
+          },
+          {
+            "required": [
+              "packages"
+            ]
+          }
+        ]
+      }
+    }
+  ]
+}

package/dist/lib/schemas-data/v2.5/media-buy/get-media-buy-delivery-request.json

@@ -0,0 +1,54 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/media-buy/get-media-buy-delivery-request.json",
+  "title": "Get Media Buy Delivery Request",
+  "description": "Request parameters for retrieving comprehensive delivery metrics",
+  "type": "object",
+  "properties": {
+    "media_buy_ids": {
+      "type": "array",
+      "description": "Array of publisher media buy IDs to get delivery data for",
+      "items": {
+        "type": "string"
+      }
+    },
+    "buyer_refs": {
+      "type": "array",
+      "description": "Array of buyer reference IDs to get delivery data for",
+      "items": {
+        "type": "string"
+      }
+    },
+    "status_filter": {
+      "oneOf": [
+        {
+          "$ref": "/schemas/enums/media-buy-status.json"
+        },
+        {
+          "type": "array",
+          "items": {
+            "$ref": "/schemas/enums/media-buy-status.json"
+          }
+        }
+      ],
+      "description": "Filter by status. Can be a single status or array of statuses"
+    },
+    "start_date": {
+      "type": "string",
+      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
+      "description": "Start date for reporting period (YYYY-MM-DD)"
+    },
+    "end_date": {
+      "type": "string",
+      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
+      "description": "End date for reporting period (YYYY-MM-DD)"
+    },
+    "context": {
+      "$ref": "/schemas/core/context.json"
+    },
+    "ext": {
+      "$ref": "/schemas/core/ext.json"
+    }
+  },
+  "additionalProperties": true
+}