comm

konigle.filters.comm

Communication filter models for the Konigle SDK.

This module provides type-safe filter models for communication resources including email accounts, channels, and identities.

AudienceFilters

Bases: BaseFilters

Type-safe filters for audience queries.

q = Field(default=None, title='Search Query', description='Search in audience name') class-attribute instance-attribute

Search in audience name

tags = Field(default=None, title='Tags', description='Filter by tags (comma-separated for multiple tags).') class-attribute instance-attribute

Filter by tags (comma-separated for multiple tags).

CampaignFilters

Bases: BaseFilters

Type-safe filters for campaign queries.

audience = Field(default=None, title='Audience code', description='Filter by audience code.') class-attribute instance-attribute

Filter by audience code.

channel_type = Field(default=None, title='Channel Type', description='Filter by channel type.') class-attribute instance-attribute

Filter by channel type.

q = Field(default=None, title='Search Query', description='Search in campaign name and description.') class-attribute instance-attribute

Search in campaign name and description.

status = Field(default=None, title='Status', description='Filter by campaign status.') class-attribute instance-attribute

Filter by campaign status.

ContactFilters

Bases: BaseFilters

Type-safe filters for contact queries.

q = Field(default=None, title='Search Query', description='Search in email') class-attribute instance-attribute

Search in email

source = Field(default=None, title='Source', description='Filter by contact source.') class-attribute instance-attribute

Filter by contact source.

tags = Field(default=None, title='Tags', description='Filter by tags (comma-separated for multiple tags).') class-attribute instance-attribute

Filter by tags (comma-separated for multiple tags).

EmailAccountFilters

Bases: BaseFilters

Type-safe filters for email account queries.

Currently there is only one email account per website, so filters are irrelevant. This class is provided for consistency.

EmailChannelFilters

Bases: BaseFilters

Type-safe filters for email channel queries.

channel_type = Field(default=None, title='Channel Type', description='Filter by channel type (transactional, marketing, broadcast).') class-attribute instance-attribute

Filter by channel type (transactional, marketing, broadcast).

ordering = Field(default=None, title='Ordering', description="Field to order results by. Prefix with '-' for descending order.") class-attribute instance-attribute

Field to order results by. Prefix with '-' for descending order.

q = Field(default=None, title='Search Query', description='Search in channel code and type.') class-attribute instance-attribute

Search in channel code and type.

status = Field(default=None, title='Status', description='Filter by channel status (active, suspended, pending).') class-attribute instance-attribute

Filter by channel status (active, suspended, pending).

EmailIdentityFilters

Bases: BaseFilters

Type-safe filters for email identity queries.

identity_type = Field(default=None, title='Identity Type', description='Filter by identity type (domain, email).') class-attribute instance-attribute

Filter by identity type (domain, email).

ordering = Field(default=None, title='Ordering', description="Field to order results by. Prefix with '-' for descending order.") class-attribute instance-attribute

Field to order results by. Prefix with '-' for descending order.

q = Field(default=None, title='Search Query', description='Search in identity value.') class-attribute instance-attribute

Search in identity value.

EmailTemplateFilters

Bases: BaseFilters

Type-safe filters for email template queries.

is_base = Field(default=None, title='Is Base Template', description='Filter by base template status.') class-attribute instance-attribute

Filter by base template status.

ordering = Field(default=None, title='Ordering', description="Field to order results by. Prefix with '-' for descending order.") class-attribute instance-attribute

Field to order results by. Prefix with '-' for descending order.

q = Field(default=None, title='Search Query', description='Search in template name, code, and tags.') class-attribute instance-attribute

Search in template name, code, and tags.

tags = Field(default=None, title='Tags', description='Filter by tags (comma-separated for multiple tags).') class-attribute instance-attribute

Filter by tags (comma-separated for multiple tags).