poprox_concepts.domain

class poprox_concepts.domain.Account(*, account_id=None, email=None, zip5=None, compensation=None, status, source=None, subsource=None, placebo_id=None)

Bases: BaseModel

Parameters:

• account_id (UUID)

• email (str | None)

• zip5 (str | None)

• compensation (str | None)

• status (str)

• source (str | None)

• subsource (str | None)

• placebo_id (str | None)

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'account_id': FieldInfo(annotation=UUID, required=False, default=None), 'compensation': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'email': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'placebo_id': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'source': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'status': FieldInfo(annotation=str, required=True), 'subsource': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'zip5': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class poprox_concepts.domain.AccountInterest(*, account_id=None, entity_id, entity_name, preference, frequency=None)

Bases: BaseModel

Parameters:

• account_id (UUID | None)

• entity_id (UUID)

• entity_name (str)

• preference (int)

• frequency (int | None)

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'account_id': FieldInfo(annotation=Union[UUID, NoneType], required=False, default=None), 'entity_id': FieldInfo(annotation=UUID, required=True), 'entity_name': FieldInfo(annotation=str, required=True), 'frequency': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), 'preference': FieldInfo(annotation=int, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class poprox_concepts.domain.Article(*, article_id=None, headline, subhead=None, body=None, url=None, preview_image_id=None, mentions=[], source=None, external_id=None, raw_data=None, images=None, published_at=datetime.datetime(1970, 1, 1, 0, 0, tzinfo=datetime.timezone.utc), created_at=None)

Bases: BaseModel

Parameters:

• article_id (UUID)

• headline (str)

• subhead (str | None)

• body (str | None)

• url (str | None)

• preview_image_id (UUID | None)

• mentions (list[Mention])

• source (str | None)

• external_id (str | None)

• raw_data (dict[str, Any] | None)

• images (list[Image] | None)

• published_at (datetime)

• created_at (datetime | None)

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'article_id': FieldInfo(annotation=UUID, required=False, default_factory=uuid4), 'body': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'created_at': FieldInfo(annotation=Union[datetime, NoneType], required=False, default=None), 'external_id': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'headline': FieldInfo(annotation=str, required=True), 'images': FieldInfo(annotation=Union[list[Image], NoneType], required=False, default=None), 'mentions': FieldInfo(annotation=list[Mention], required=False, default=[]), 'preview_image_id': FieldInfo(annotation=Union[UUID, NoneType], required=False, default=None), 'published_at': FieldInfo(annotation=datetime, required=False, default=datetime.datetime(1970, 1, 1, 0, 0, tzinfo=datetime.timezone.utc)), 'raw_data': FieldInfo(annotation=Union[dict[str, Any], NoneType], required=False, default=None), 'source': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'subhead': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'url': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class poprox_concepts.domain.CandidateSet(*, articles, **extra_data)

Bases: BaseModel

Parameters:

• articles (list[Article])

• extra_data (Any)

model_config: ClassVar[ConfigDict] = {'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_fields: ClassVar[dict[str, FieldInfo]] = {'articles': FieldInfo(annotation=list[Article], required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class poprox_concepts.domain.Click(*, article_id, newsletter_id=None, timestamp=None)

Bases: BaseModel

Parameters:

• article_id (UUID)

• newsletter_id (UUID | None)

• timestamp (datetime | None)

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'article_id': FieldInfo(annotation=UUID, required=True), 'newsletter_id': FieldInfo(annotation=Union[UUID, NoneType], required=False, default=None), 'timestamp': FieldInfo(annotation=Union[datetime, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class poprox_concepts.domain.Entity(*, entity_id=None, external_id=None, name, entity_type, source, raw_data=None)

Bases: BaseModel

Parameters:

• entity_id (UUID | None)

• external_id (str | None)

• name (str)

• entity_type (str)

• source (str)

• raw_data (dict[str, Any] | None)

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'entity_id': FieldInfo(annotation=Union[UUID, NoneType], required=False, default=None), 'entity_type': FieldInfo(annotation=str, required=True), 'external_id': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'name': FieldInfo(annotation=str, required=True), 'raw_data': FieldInfo(annotation=Union[dict[str, Any], NoneType], required=False, default=None), 'source': FieldInfo(annotation=str, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class poprox_concepts.domain.Image(*, image_id=None, url, caption=None, source, external_id=None, raw_data)

Bases: BaseModel

Parameters:

• image_id (UUID | None)

• url (str)

• caption (str | None)

• source (str)

• external_id (str | None)

• raw_data (dict[str, Any] | None)

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'caption': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'external_id': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'image_id': FieldInfo(annotation=Union[UUID, NoneType], required=False, default=None), 'raw_data': FieldInfo(annotation=Union[dict[str, Any], NoneType], required=True), 'source': FieldInfo(annotation=str, required=True), 'url': FieldInfo(annotation=str, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class poprox_concepts.domain.Impression(*, newsletter_id, position, article, created_at=None, extra=None)

Bases: BaseModel

Parameters:

• newsletter_id (UUID)

• position (int)

• article (Article)

• created_at (datetime | None)

• extra (dict[str, Any] | None)

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'article': FieldInfo(annotation=Article, required=True), 'created_at': FieldInfo(annotation=Union[datetime, NoneType], required=False, default=None), 'extra': FieldInfo(annotation=Union[dict[str, Any], NoneType], required=False, default=None), 'newsletter_id': FieldInfo(annotation=UUID, required=True), 'position': FieldInfo(annotation=int, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class poprox_concepts.domain.InterestProfile(*, profile_id=None, click_history, click_topic_counts=None, click_locality_counts=None, onboarding_topics, **extra_data)

Bases: BaseModel

Parameters:

• profile_id (UUID | None)

• click_history (list[Click])

• click_topic_counts (dict[str, int] | None)

• click_locality_counts (dict[str, int] | None)

• onboarding_topics (list[AccountInterest])

• extra_data (Any)

model_config: ClassVar[ConfigDict] = {'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_fields: ClassVar[dict[str, FieldInfo]] = {'click_history': FieldInfo(annotation=list[Click], required=True), 'click_locality_counts': FieldInfo(annotation=Union[dict[str, int], NoneType], required=False, default=None), 'click_topic_counts': FieldInfo(annotation=Union[dict[str, int], NoneType], required=False, default=None), 'onboarding_topics': FieldInfo(annotation=list[AccountInterest], required=True), 'profile_id': FieldInfo(annotation=Union[UUID, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class poprox_concepts.domain.Mention(*, article_id=None, mention_id=None, source, relevance, entity)

Bases: BaseModel

Parameters:

• article_id (UUID | None)

• mention_id (UUID | None)

• source (str)

• relevance (float)

• entity (Entity)

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'article_id': FieldInfo(annotation=Union[UUID, NoneType], required=False, default=None), 'entity': FieldInfo(annotation=Entity, required=True), 'mention_id': FieldInfo(annotation=Union[UUID, NoneType], required=False, default=None), 'relevance': FieldInfo(annotation=float, required=True), 'source': FieldInfo(annotation=str, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class poprox_concepts.domain.Newsletter(*, newsletter_id=None, account_id, treatment_id=None, impressions, subject, body_html, created_at=None)

Bases: BaseModel

Parameters:

• newsletter_id (UUID)

• account_id (UUID)

• treatment_id (UUID | None)

• impressions (list[Impression])

• subject (str)

• body_html (str)

• created_at (datetime | None)

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'account_id': FieldInfo(annotation=UUID, required=True), 'body_html': FieldInfo(annotation=str, required=True), 'created_at': FieldInfo(annotation=Union[datetime, NoneType], required=False, default=None), 'impressions': FieldInfo(annotation=list[Impression], required=True), 'newsletter_id': FieldInfo(annotation=UUID, required=False, default_factory=uuid4), 'subject': FieldInfo(annotation=str, required=True), 'treatment_id': FieldInfo(annotation=Union[UUID, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class poprox_concepts.domain.RecommendationList(*, articles=None, extras=None)

Bases: BaseModel

Parameters:

• articles (list[Article])

• extras (list[dict[str, JsonValue]])

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'articles': FieldInfo(annotation=list[Article], required=False, default_factory=list), 'extras': FieldInfo(annotation=list[dict[str, JsonValue]], required=False, default_factory=list)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class poprox_concepts.domain.ArticlePlacement(*, placement_id=None, article_id, url=None, section=None, level=None, image_url=None, created_at=datetime.datetime(2025, 4, 11, 18, 37, 22, 526432, tzinfo=datetime.timezone.utc))

Bases: BaseModel

Parameters:

• placement_id (UUID)

• article_id (UUID)

• url (str | None)

• section (str | None)

• level (str | None)

• image_url (str | None)

• created_at (datetime)

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'article_id': FieldInfo(annotation=UUID, required=True), 'created_at': FieldInfo(annotation=datetime, required=False, default=datetime.datetime(2025, 4, 11, 18, 37, 22, 526432, tzinfo=datetime.timezone.utc)), 'image_url': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'level': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'placement_id': FieldInfo(annotation=UUID, required=False, default_factory=uuid4), 'section': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'url': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class poprox_concepts.domain.Demographics(*, demographic_id=None, account_id, gender, birth_year, zip3, education, race, email_client=None)

Bases: BaseModel

Parameters:

• demographic_id (UUID)

• account_id (UUID)

• gender (str)

• birth_year (int)

• zip3 (str)

• education (str)

• race (str)

• email_client (str | None)

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'account_id': FieldInfo(annotation=UUID, required=True), 'birth_year': FieldInfo(annotation=int, required=True), 'demographic_id': FieldInfo(annotation=UUID, required=False, default=None), 'education': FieldInfo(annotation=str, required=True), 'email_client': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'gender': FieldInfo(annotation=str, required=True), 'race': FieldInfo(annotation=str, required=True), 'zip3': FieldInfo(annotation=str, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

Modules

account
article
click
demographics
image
newsletter
profile
recommendation
topics