Module adcp.types.generated_poc.a2ui.user_action

Classes

class A2UiUserAction (**data: Any)
Expand source code 
class A2UiUserAction(AdCPBaseModel):
    model_config = ConfigDict(
        extra='allow',
    )
    surfaceId: Annotated[str, Field(description='ID of the surface where the action occurred')]
    componentId: Annotated[str, Field(description='ID of the component that triggered the action')]
    action: Annotated[Action, Field(description='The action that was triggered')]
    timestamp: Annotated[AwareDatetime | None, Field(description='When the action occurred')] = None

Base model for AdCP types with spec-compliant serialization.

Defaults to extra='ignore' so that 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. Consumers who want strict validation can override with extra='forbid'.

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 action : Action
var componentId : str
var model_config
var surfaceId : str
var timestamp : pydantic.types.AwareDatetime | None

Inherited members

class Action (**data: Any)
Expand source code 
class Action(AdCPBaseModel):
    model_config = ConfigDict(
        extra='allow',
    )
    name: Annotated[
        str, Field(description="Action identifier (e.g., 'view_product', 'add_to_cart')")
    ]
    context: Annotated[
        dict[str, Any] | None, Field(description='Context data resolved from data model bindings')
    ] = None

Base model for AdCP types with spec-compliant serialization.

Defaults to extra='ignore' so that 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. Consumers who want strict validation can override with extra='forbid'.

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 context : dict[str, typing.Any] | None
var model_config
var name : str

Inherited members