adcp 2.18.0__py3-none-any.whl → 2.19.0__py3-none-any.whl

adcp/types/generated_poc/media_buy/update_media_buy_request.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  media_buy/update_media_buy_request.json
-#   timestamp: 2026-01-08T19:25:24+00:00
+#   timestamp: 2026-01-14T17:08:13+00:00
 
 from __future__ import annotations
 
@@ -19,19 +19,19 @@ from ..enums import pacing as pacing_1
 
 class Packages(AdCPBaseModel):
     model_config = ConfigDict(
-        extra='allow',
+        extra="allow",
     )
     bid_price: Annotated[
         float | None,
         Field(
-            description='Updated bid price for auction-based pricing options (only applies when pricing_option is auction-based)',
+            description="Updated bid price for auction-based pricing options (only applies when pricing_option is auction-based)",
             ge=0.0,
         ),
     ] = None
     budget: Annotated[
         float | None,
         Field(
-            description='Updated budget allocation for this package in the currency specified by the pricing option',
+            description="Updated budget allocation for this package in the currency specified by the pricing option",
             ge=0.0,
         ),
     ] = None
@@ -41,44 +41,47 @@ class Packages(AdCPBaseModel):
     creative_assignments: Annotated[
         list[creative_assignment.CreativeAssignment] | None,
         Field(
-            description='Full creative assignment objects with weights and placement targeting (alternative to creative_ids - provides granular control over weights and placement targeting). Uses replacement semantics like creative_ids.'
+            description="Full creative assignment objects with weights and placement targeting (alternative to creative_ids - provides granular control over weights and placement targeting). Uses replacement semantics like creative_ids."
         ),
     ] = None
     creative_ids: Annotated[
         list[str] | None,
-        Field(description='Update creative assignments (references existing library creatives)'),
+        Field(description="Update creative assignments (references existing library creatives)"),
     ] = None
     creatives: Annotated[
         list[creative_asset.CreativeAsset] | None,
         Field(
-            description='Full creative objects to upload and assign to this package (alternative to creative_ids - creatives will be added to library). Supports both static and generative creatives.',
+            description="Full creative objects to upload and assign to this package (alternative to creative_ids - creatives will be added to library). Supports both static and generative creatives.",
             max_length=100,
         ),
     ] = None
+    impressions: Annotated[
+        float | None, Field(description="Updated impression goal for this package", ge=0.0)
+    ] = None
     pacing: pacing_1.Pacing | None = None
     package_id: Annotated[str, Field(description="Publisher's ID of package to update")]
     paused: Annotated[
         bool | None,
-        Field(description='Pause/resume specific package (true = paused, false = active)'),
+        Field(description="Pause/resume specific package (true = paused, false = active)"),
     ] = None
     targeting_overlay: targeting.TargetingOverlay | None = None
 
 
 class Packages1(AdCPBaseModel):
     model_config = ConfigDict(
-        extra='allow',
+        extra="allow",
     )
     bid_price: Annotated[
         float | None,
         Field(
-            description='Updated bid price for auction-based pricing options (only applies when pricing_option is auction-based)',
+            description="Updated bid price for auction-based pricing options (only applies when pricing_option is auction-based)",
             ge=0.0,
         ),
     ] = None
     budget: Annotated[
         float | None,
         Field(
-            description='Updated budget allocation for this package in the currency specified by the pricing option',
+            description="Updated budget allocation for this package in the currency specified by the pricing option",
             ge=0.0,
         ),
     ] = None
@@ -86,90 +89,95 @@ class Packages1(AdCPBaseModel):
     creative_assignments: Annotated[
         list[creative_assignment.CreativeAssignment] | None,
         Field(
-            description='Full creative assignment objects with weights and placement targeting (alternative to creative_ids - provides granular control over weights and placement targeting). Uses replacement semantics like creative_ids.'
+            description="Full creative assignment objects with weights and placement targeting (alternative to creative_ids - provides granular control over weights and placement targeting). Uses replacement semantics like creative_ids."
         ),
     ] = None
     creative_ids: Annotated[
         list[str] | None,
-        Field(description='Update creative assignments (references existing library creatives)'),
+        Field(description="Update creative assignments (references existing library creatives)"),
     ] = None
     creatives: Annotated[
         list[creative_asset.CreativeAsset] | None,
         Field(
-            description='Full creative objects to upload and assign to this package (alternative to creative_ids - creatives will be added to library). Supports both static and generative creatives.',
+            description="Full creative objects to upload and assign to this package (alternative to creative_ids - creatives will be added to library). Supports both static and generative creatives.",
             max_length=100,
         ),
     ] = None
+    impressions: Annotated[
+        float | None, Field(description="Updated impression goal for this package", ge=0.0)
+    ] = None
     pacing: pacing_1.Pacing | None = None
     package_id: Annotated[str | None, Field(description="Publisher's ID of package to update")] = (
         None
     )
     paused: Annotated[
         bool | None,
-        Field(description='Pause/resume specific package (true = paused, false = active)'),
+        Field(description="Pause/resume specific package (true = paused, false = active)"),
     ] = None
     targeting_overlay: targeting.TargetingOverlay | None = None
 
 
 class UpdateMediaBuyRequest1(AdCPBaseModel):
     model_config = ConfigDict(
-        extra='allow',
+        extra="allow",
     )
     buyer_ref: Annotated[
         str | None, Field(description="Buyer's reference for the media buy to update")
     ] = None
     context: context_1.ContextObject | None = None
     end_time: Annotated[
-        AwareDatetime | None, Field(description='New end date/time in ISO 8601 format')
+        AwareDatetime | None, Field(description="New end date/time in ISO 8601 format")
     ] = None
     ext: ext_1.ExtensionObject | None = None
     media_buy_id: Annotated[str, Field(description="Publisher's ID of the media buy to update")]
     packages: Annotated[
-        list[Packages | Packages1] | None, Field(description='Package-specific updates')
+        list[Packages | Packages1] | None, Field(description="Package-specific updates")
     ] = None
     paused: Annotated[
         bool | None,
-        Field(description='Pause/resume the entire media buy (true = paused, false = active)'),
+        Field(description="Pause/resume the entire media buy (true = paused, false = active)"),
     ] = None
     push_notification_config: Annotated[
         push_notification_config_1.PushNotificationConfig | None,
         Field(
-            description='Optional webhook configuration for async update notifications. Publisher will send webhook when update completes if operation takes longer than immediate response time.'
+            description="Optional webhook configuration for async update notifications. Publisher will send webhook when update completes if operation takes longer than immediate response time."
         ),
     ] = None
     start_time: start_timing.StartTiming | None = None
 
 
-Packages2 = Packages
+class Packages2(Packages):
+    pass
 
 
-Packages3 = Packages1
+class Packages3(Packages1):
+    pass
 
 
 class UpdateMediaBuyRequest2(AdCPBaseModel):
     model_config = ConfigDict(
-        extra='allow',
+        extra="allow",
     )
     buyer_ref: Annotated[str, Field(description="Buyer's reference for the media buy to update")]
     context: context_1.ContextObject | None = None
     end_time: Annotated[
-        AwareDatetime | None, Field(description='New end date/time in ISO 8601 format')
+        AwareDatetime | None, Field(description="New end date/time in ISO 8601 format")
     ] = None
     ext: ext_1.ExtensionObject | None = None
     media_buy_id: Annotated[
         str | None, Field(description="Publisher's ID of the media buy to update")
     ] = None
     packages: Annotated[
-        list[Packages2 | Packages3] | None, Field(description='Package-specific updates')
+        list[Packages2 | Packages3] | None, Field(description="Package-specific updates")
     ] = None
     paused: Annotated[
         bool | None,
-        Field(description='Pause/resume the entire media buy (true = paused, false = active)'),
+        Field(description="Pause/resume the entire media buy (true = paused, false = active)"),
     ] = None
     push_notification_config: Annotated[
         push_notification_config_1.PushNotificationConfig | None,
         Field(
-            description='Optional webhook configuration for async update notifications. Publisher will send webhook when update completes if operation takes longer than immediate response time.'
+            description="Optional webhook configuration for async update notifications. Publisher will send webhook when update completes if operation takes longer than immediate response time."
         ),
     ] = None
     start_time: start_timing.StartTiming | None = None
@@ -179,7 +187,7 @@ class UpdateMediaBuyRequest(RootModel[UpdateMediaBuyRequest1 | UpdateMediaBuyReq
     root: Annotated[
         UpdateMediaBuyRequest1 | UpdateMediaBuyRequest2,
         Field(
-            description='Request parameters for updating campaign and package settings',
-            title='Update Media Buy Request',
+            description="Request parameters for updating campaign and package settings",
+            title="Update Media Buy Request",
         ),
     ]

adcp/types/generated_poc/media_buy/update_media_buy_response.py

@@ -17,30 +17,30 @@ from ..core import package
 
 class UpdateMediaBuyResponse2(AdCPBaseModel):
     model_config = ConfigDict(
-        extra='allow',
+        extra="allow",
     )
     context: context_1.ContextObject | None = None
     errors: Annotated[
         list[error.Error],
-        Field(description='Array of errors explaining why the operation failed', min_length=1),
+        Field(description="Array of errors explaining why the operation failed", min_length=1),
     ]
     ext: ext_1.ExtensionObject | None = None
 
 
 class UpdateMediaBuyResponse1(AdCPBaseModel):
     model_config = ConfigDict(
-        extra='allow',
+        extra="allow",
     )
     affected_packages: Annotated[
         list[package.Package] | None,
-        Field(description='Array of packages that were modified with complete state information'),
+        Field(description="Array of packages that were modified with complete state information"),
     ] = None
     buyer_ref: Annotated[str, Field(description="Buyer's reference identifier for the media buy")]
     context: context_1.ContextObject | None = None
     ext: ext_1.ExtensionObject | None = None
     implementation_date: Annotated[
         AwareDatetime | None,
-        Field(description='ISO 8601 timestamp when changes take effect (null if pending approval)'),
+        Field(description="ISO 8601 timestamp when changes take effect (null if pending approval)"),
     ] = None
     media_buy_id: Annotated[str, Field(description="Publisher's identifier for the media buy")]
 
@@ -49,7 +49,7 @@ class UpdateMediaBuyResponse(RootModel[UpdateMediaBuyResponse1 | UpdateMediaBuyR
     root: Annotated[
         UpdateMediaBuyResponse1 | UpdateMediaBuyResponse2,
         Field(
-            description='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.',
-            title='Update Media Buy Response',
+            description="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.",
+            title="Update Media Buy Response",
         ),
     ]

adcp/types/generated_poc/pricing_options/cpc_option.py

@@ -12,32 +12,32 @@ from pydantic import ConfigDict, Field
 
 class CpcPricingOption(AdCPBaseModel):
     model_config = ConfigDict(
-        extra='allow',
+        extra="allow",
     )
     currency: Annotated[
         str,
         Field(
-            description='ISO 4217 currency code',
-            examples=['USD', 'EUR', 'GBP', 'JPY'],
-            pattern='^[A-Z]{3}$',
+            description="ISO 4217 currency code",
+            examples=["USD", "EUR", "GBP", "JPY"],
+            pattern="^[A-Z]{3}$",
         ),
     ]
     is_fixed: Annotated[
         Literal[True],
-        Field(description='Whether this is a fixed rate (true) or auction-based (false)'),
+        Field(description="Whether this is a fixed rate (true) or auction-based (false)"),
     ]
     min_spend_per_package: Annotated[
         float | None,
         Field(
-            description='Minimum spend requirement per package using this pricing option, in the specified currency',
+            description="Minimum spend requirement per package using this pricing option, in the specified currency",
             ge=0.0,
         ),
     ] = None
-    pricing_model: Annotated[Literal['cpc'], Field(description='Cost per click')]
+    pricing_model: Annotated[Literal["cpc"], Field(description="Cost per click")]
     pricing_option_id: Annotated[
         str,
         Field(
             description="Unique identifier for this pricing option within the product (e.g., 'cpc_usd_fixed')"
         ),
     ]
-    rate: Annotated[float, Field(description='Fixed CPC rate (cost per click)', ge=0.0)]
+    rate: Annotated[float, Field(description="Fixed CPC rate (cost per click)", ge=0.0)]

adcp/types/generated_poc/pricing_options/cpcv_option.py

@@ -12,29 +12,29 @@ from pydantic import ConfigDict, Field
 
 class CpcvPricingOption(AdCPBaseModel):
     model_config = ConfigDict(
-        extra='allow',
+        extra="allow",
     )
     currency: Annotated[
         str,
         Field(
-            description='ISO 4217 currency code',
-            examples=['USD', 'EUR', 'GBP', 'JPY'],
-            pattern='^[A-Z]{3}$',
+            description="ISO 4217 currency code",
+            examples=["USD", "EUR", "GBP", "JPY"],
+            pattern="^[A-Z]{3}$",
         ),
     ]
     is_fixed: Annotated[
         Literal[True],
-        Field(description='Whether this is a fixed rate (true) or auction-based (false)'),
+        Field(description="Whether this is a fixed rate (true) or auction-based (false)"),
     ]
     min_spend_per_package: Annotated[
         float | None,
         Field(
-            description='Minimum spend requirement per package using this pricing option, in the specified currency',
+            description="Minimum spend requirement per package using this pricing option, in the specified currency",
             ge=0.0,
         ),
     ] = None
     pricing_model: Annotated[
-        Literal['cpcv'], Field(description='Cost per completed view (100% completion)')
+        Literal["cpcv"], Field(description="Cost per completed view (100% completion)")
     ]
     pricing_option_id: Annotated[
         str,
@@ -42,4 +42,4 @@ class CpcvPricingOption(AdCPBaseModel):
             description="Unique identifier for this pricing option within the product (e.g., 'cpcv_usd_guaranteed')"
         ),
     ]
-    rate: Annotated[float, Field(description='Fixed CPCV rate (cost per 100% completion)', ge=0.0)]
+    rate: Annotated[float, Field(description="Fixed CPCV rate (cost per 100% completion)", ge=0.0)]

adcp/types/generated_poc/pricing_options/cpm_auction_option.py

@@ -14,42 +14,42 @@ class PriceGuidance(AdCPBaseModel):
     floor: Annotated[
         float,
         Field(
-            description='Minimum bid price - publisher will reject bids under this value', ge=0.0
+            description="Minimum bid price - publisher will reject bids under this value", ge=0.0
         ),
     ]
-    p25: Annotated[float | None, Field(description='25th percentile winning price', ge=0.0)] = None
-    p50: Annotated[float | None, Field(description='Median winning price', ge=0.0)] = None
-    p75: Annotated[float | None, Field(description='75th percentile winning price', ge=0.0)] = None
-    p90: Annotated[float | None, Field(description='90th percentile winning price', ge=0.0)] = None
+    p25: Annotated[float | None, Field(description="25th percentile winning price", ge=0.0)] = None
+    p50: Annotated[float | None, Field(description="Median winning price", ge=0.0)] = None
+    p75: Annotated[float | None, Field(description="75th percentile winning price", ge=0.0)] = None
+    p90: Annotated[float | None, Field(description="90th percentile winning price", ge=0.0)] = None
 
 
 class CpmAuctionPricingOption(AdCPBaseModel):
     model_config = ConfigDict(
-        extra='allow',
+        extra="allow",
     )
     currency: Annotated[
         str,
         Field(
-            description='ISO 4217 currency code',
-            examples=['USD', 'EUR', 'GBP', 'JPY'],
-            pattern='^[A-Z]{3}$',
+            description="ISO 4217 currency code",
+            examples=["USD", "EUR", "GBP", "JPY"],
+            pattern="^[A-Z]{3}$",
         ),
     ]
     is_fixed: Annotated[
         Literal[False],
-        Field(description='Whether this is a fixed rate (true) or auction-based (false)'),
+        Field(description="Whether this is a fixed rate (true) or auction-based (false)"),
     ]
     min_spend_per_package: Annotated[
         float | None,
         Field(
-            description='Minimum spend requirement per package using this pricing option, in the specified currency',
+            description="Minimum spend requirement per package using this pricing option, in the specified currency",
             ge=0.0,
         ),
     ] = None
     price_guidance: Annotated[
-        PriceGuidance, Field(description='Pricing guidance for auction-based CPM bidding')
+        PriceGuidance, Field(description="Pricing guidance for auction-based CPM bidding")
     ]
-    pricing_model: Annotated[Literal['cpm'], Field(description='Cost per 1,000 impressions')]
+    pricing_model: Annotated[Literal["cpm"], Field(description="Cost per 1,000 impressions")]
     pricing_option_id: Annotated[
         str,
         Field(

adcp/types/generated_poc/pricing_options/cpm_fixed_option.py

@@ -12,32 +12,32 @@ from pydantic import ConfigDict, Field
 
 class CpmFixedRatePricingOption(AdCPBaseModel):
     model_config = ConfigDict(
-        extra='allow',
+        extra="allow",
     )
     currency: Annotated[
         str,
         Field(
-            description='ISO 4217 currency code',
-            examples=['USD', 'EUR', 'GBP', 'JPY'],
-            pattern='^[A-Z]{3}$',
+            description="ISO 4217 currency code",
+            examples=["USD", "EUR", "GBP", "JPY"],
+            pattern="^[A-Z]{3}$",
         ),
     ]
     is_fixed: Annotated[
         Literal[True],
-        Field(description='Whether this is a fixed rate (true) or auction-based (false)'),
+        Field(description="Whether this is a fixed rate (true) or auction-based (false)"),
     ]
     min_spend_per_package: Annotated[
         float | None,
         Field(
-            description='Minimum spend requirement per package using this pricing option, in the specified currency',
+            description="Minimum spend requirement per package using this pricing option, in the specified currency",
             ge=0.0,
         ),
     ] = None
-    pricing_model: Annotated[Literal['cpm'], Field(description='Cost per 1,000 impressions')]
+    pricing_model: Annotated[Literal["cpm"], Field(description="Cost per 1,000 impressions")]
     pricing_option_id: Annotated[
         str,
         Field(
             description="Unique identifier for this pricing option within the product (e.g., 'cpm_usd_guaranteed')"
         ),
     ]
-    rate: Annotated[float, Field(description='Fixed CPM rate (cost per 1,000 impressions)', ge=0.0)]
+    rate: Annotated[float, Field(description="Fixed CPM rate (cost per 1,000 impressions)", ge=0.0)]

adcp/types/generated_poc/pricing_options/cpp_option.py

@@ -12,53 +12,53 @@ from pydantic import ConfigDict, Field
 
 class Parameters(AdCPBaseModel):
     model_config = ConfigDict(
-        extra='allow',
+        extra="allow",
     )
     demographic: Annotated[
         str,
         Field(
-            description='Target demographic in Nielsen format: P/M/W/A/C + age range. Examples: P18-49 (Persons 18-49), M25-54 (Men 25-54), W35+ (Women 35+), A18-34 (Adults 18-34), C2-11 (Children 2-11)',
-            pattern='^[PMWAC][0-9]{2}(-[0-9]{2}|\\+)$',
+            description="Target demographic in Nielsen format: P/M/W/A/C + age range. Examples: P18-49 (Persons 18-49), M25-54 (Men 25-54), W35+ (Women 35+), A18-34 (Adults 18-34), C2-11 (Children 2-11)",
+            pattern="^[PMWAC][0-9]{2}(-[0-9]{2}|\\+)$",
         ),
     ]
     min_points: Annotated[
         float | None,
-        Field(description='Minimum GRPs/TRPs required for this pricing option', ge=0.0),
+        Field(description="Minimum GRPs/TRPs required for this pricing option", ge=0.0),
     ] = None
 
 
 class CppPricingOption(AdCPBaseModel):
     model_config = ConfigDict(
-        extra='allow',
+        extra="allow",
     )
     currency: Annotated[
         str,
         Field(
-            description='ISO 4217 currency code',
-            examples=['USD', 'EUR', 'GBP', 'JPY'],
-            pattern='^[A-Z]{3}$',
+            description="ISO 4217 currency code",
+            examples=["USD", "EUR", "GBP", "JPY"],
+            pattern="^[A-Z]{3}$",
         ),
     ]
     is_fixed: Annotated[
         Literal[True],
-        Field(description='Whether this is a fixed rate (true) or auction-based (false)'),
+        Field(description="Whether this is a fixed rate (true) or auction-based (false)"),
     ]
     min_spend_per_package: Annotated[
         float | None,
         Field(
-            description='Minimum spend requirement per package using this pricing option, in the specified currency',
+            description="Minimum spend requirement per package using this pricing option, in the specified currency",
             ge=0.0,
         ),
     ] = None
     parameters: Annotated[
         Parameters,
-        Field(description='CPP-specific parameters for demographic targeting and GRP requirements'),
+        Field(description="CPP-specific parameters for demographic targeting and GRP requirements"),
     ]
-    pricing_model: Annotated[Literal['cpp'], Field(description='Cost per Gross Rating Point')]
+    pricing_model: Annotated[Literal["cpp"], Field(description="Cost per Gross Rating Point")]
     pricing_option_id: Annotated[
         str,
         Field(
             description="Unique identifier for this pricing option within the product (e.g., 'cpp_usd_p18-49')"
         ),
     ]
-    rate: Annotated[float, Field(description='Fixed CPP rate (cost per rating point)', ge=0.0)]
+    rate: Annotated[float, Field(description="Fixed CPP rate (cost per rating point)", ge=0.0)]

adcp/types/generated_poc/pricing_options/cpv_option.py

@@ -14,7 +14,7 @@ class ViewThreshold(RootModel[float]):
     root: Annotated[
         float,
         Field(
-            description='Percentage completion threshold for CPV pricing (0.0 to 1.0, e.g., 0.5 = 50% completion)',
+            description="Percentage completion threshold for CPV pricing (0.0 to 1.0, e.g., 0.5 = 50% completion)",
             ge=0.0,
             le=1.0,
         ),
@@ -23,7 +23,7 @@ class ViewThreshold(RootModel[float]):
 
 class ViewThreshold1(AdCPBaseModel):
     model_config = ConfigDict(
-        extra='allow',
+        extra="allow",
     )
     duration_seconds: Annotated[
         int,
@@ -36,42 +36,42 @@ class ViewThreshold1(AdCPBaseModel):
 
 class Parameters(AdCPBaseModel):
     model_config = ConfigDict(
-        extra='allow',
+        extra="allow",
     )
     view_threshold: ViewThreshold | ViewThreshold1
 
 
 class CpvPricingOption(AdCPBaseModel):
     model_config = ConfigDict(
-        extra='allow',
+        extra="allow",
     )
     currency: Annotated[
         str,
         Field(
-            description='ISO 4217 currency code',
-            examples=['USD', 'EUR', 'GBP', 'JPY'],
-            pattern='^[A-Z]{3}$',
+            description="ISO 4217 currency code",
+            examples=["USD", "EUR", "GBP", "JPY"],
+            pattern="^[A-Z]{3}$",
         ),
     ]
     is_fixed: Annotated[
         Literal[True],
-        Field(description='Whether this is a fixed rate (true) or auction-based (false)'),
+        Field(description="Whether this is a fixed rate (true) or auction-based (false)"),
     ]
     min_spend_per_package: Annotated[
         float | None,
         Field(
-            description='Minimum spend requirement per package using this pricing option, in the specified currency',
+            description="Minimum spend requirement per package using this pricing option, in the specified currency",
             ge=0.0,
         ),
     ] = None
     parameters: Annotated[
-        Parameters, Field(description='CPV-specific parameters defining the view threshold')
+        Parameters, Field(description="CPV-specific parameters defining the view threshold")
     ]
-    pricing_model: Annotated[Literal['cpv'], Field(description='Cost per view at threshold')]
+    pricing_model: Annotated[Literal["cpv"], Field(description="Cost per view at threshold")]
     pricing_option_id: Annotated[
         str,
         Field(
             description="Unique identifier for this pricing option within the product (e.g., 'cpv_usd_50pct')"
         ),
     ]
-    rate: Annotated[float, Field(description='Fixed CPV rate (cost per view)', ge=0.0)]
+    rate: Annotated[float, Field(description="Fixed CPV rate (cost per view)", ge=0.0)]