Module adcp.types.domains.pricing_options.revenue_share_option

Classes

class RevenueSharePricingOption (**data: Any)
Expand source code 
class RevenueSharePricingOption(AdCPBaseModel):
    model_config = ConfigDict(
        extra='allow',
    )
    pricing_option_id: Annotated[
        str,
        Field(
            description='Unique identifier for this pricing option within the product', min_length=1
        ),
    ]
    pricing_model: Annotated[
        Literal['revenue_share'],
        Field(description='Percentage commission on settled attributed conversion value'),
    ] = 'revenue_share'
    event_type: Annotated[
        event_type_1.EventType,
        Field(
            description='Conversion event whose attributed value may become commissionable (for example purchase or subscribe)'
        ),
    ]
    custom_event_name: Annotated[
        str | None,
        Field(
            description='Name of the custom event when event_type is custom. Required for custom events and absent otherwise.',
            min_length=1,
        ),
    ] = None
    event_source_id: Annotated[
        str,
        Field(
            description='Event source whose attribution is authoritative for billing. Must match an event source configured through sync_event_sources.',
            min_length=1,
        ),
    ]
    commission_rate: Annotated[
        StrictFloat,
        Field(
            description='Decimal proportion applied to commissionable_value. For example, 0.04 means 4%.',
            gt=0.0,
            le=1.0,
        ),
    ]
    currency: Annotated[
        str,
        Field(
            description='ISO 4217 currency code for commissionable_value and resulting spend',
            examples=['USD', 'EUR', 'GBP', 'JPY'],
            pattern='^[A-Z]{3}$',
        ),
    ]
    commission_basis_description: Annotated[
        str,
        Field(
            description='Human-readable definition of inclusions, exclusions, and return or cancellation treatment used by the billing authority to calculate commissionable_value.',
            max_length=1000,
            min_length=1,
        ),
    ]

Base model for AdCP types with spec-compliant serialization.

Defaults to extra='ignore' so unknown fields from newer spec versions are silently dropped rather than causing validation errors. Generated types whose schemas set additionalProperties: true override this with extra='allow' in their own model_config.

Set ADCP_STRICT_VALIDATION=1 in the environment ("1", "true", "yes", "on" are accepted) to flip the default to extra='forbid'. Use this during spec upgrades to catch silently-dropped renamed fields in tests. See :func:_resolve_extra_policy.

Important

The env var is resolved once at module import time. Set it in your shell or CI environment before import adcp runs — mutating os.environ["ADCP_STRICT_VALIDATION"] after the first adcp import has no effect on already-imported model classes (they captured the policy at class-body evaluation).

Consumers who want per-model strict validation can override model_config on their subclass.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors

Class variables

var commission_basis_description : str
var commission_rate : float
var currency : str
var custom_event_name : str | None
var event_source_id : str
var event_type : EventType
var model_config
var pricing_model : Literal['revenue_share']
var pricing_option_id : str

Inherited members