filters
konigle.filters
¶
Filter models for the Konigle SDK.
This module exports all filter classes organized by resource category. Filters provide type-safe querying capabilities for list operations.
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).
BaseFilters
¶
Bases: BaseModel
Base class for filter models.
Provides common filtering patterns and validation for all resource filter classes.
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).
DocumentFilters
¶
Bases: MediaAssetFilters
Filters specific to document assets.
mime_type = Field('document')
class-attribute
instance-attribute
¶
Automatically set to 'document' for document filters
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).
ImageFilters
¶
Bases: MediaAssetFilters
Filters specific to image assets.
mime_type = Field('image')
class-attribute
instance-attribute
¶
Automatically set to 'image' for image filters
MediaAssetFilters
¶
Bases: BaseFilters
Base filters for all media assets.
max_size = Field(None, ge=0)
class-attribute
instance-attribute
¶
Maximum file size in bytes
mime_type = Field(None)
class-attribute
instance-attribute
¶
Filter by MIME type. Can be 'image', 'video', 'font', 'document' or comma-separated specific MIME types
min_size = Field(None, ge=0)
class-attribute
instance-attribute
¶
Minimum file size in bytes
q = Field(None)
class-attribute
instance-attribute
¶
Search query that matches name and alt_text fields
tags = Field(None)
class-attribute
instance-attribute
¶
Comma-separated tags to filter by (matches any of the tags)
ProductFilters
¶
Bases: BaseFilters
Type-safe filters for product queries.
handle = Field(default=None, title='Handle', description='Filter by product handle.')
class-attribute
instance-attribute
¶
Filter by product handle.
ordering = Field(None, title='Ordering', description='Sort order for results.')
class-attribute
instance-attribute
¶
Sort order for results.
product_type = Field(default=None, title='Product Type', description='Filter by product type.')
class-attribute
instance-attribute
¶
Filter by product type.
q = Field(default=None, title='Search Query', description='Search in title, handle, and tags.')
class-attribute
instance-attribute
¶
Search in title, handle, and tags.
status = Field(default=None, title='Status', description='Filter by product status (active, archived, draft).')
class-attribute
instance-attribute
¶
Filter by product status (active, archived, draft).
vendor = Field(default=None, title='Vendor', description='Filter by vendor name.')
class-attribute
instance-attribute
¶
Filter by vendor name.
ProductImageFilters
¶
Bases: BaseFilters
Type-safe filters for product image queries.
ProductVariantFilters
¶
Bases: BaseFilters
Type-safe filters for product variant queries.
handle = Field(default=None, title='Handle', description='Filter by variant handle.')
class-attribute
instance-attribute
¶
Filter by variant handle.
ordering = Field(None, title='Ordering', description='Sort order for results.')
class-attribute
instance-attribute
¶
Sort order for results.
product_handle = Field(default=None, title='Product Handle', description='Filter by parent product handle.')
class-attribute
instance-attribute
¶
Filter by parent product handle.
product_id = Field(default=None, title='Product ID', description='Filter by parent product ID.')
class-attribute
instance-attribute
¶
Filter by parent product ID.
q = Field(default=None, title='Search Query', description='Search in title, sku, and barcode.')
class-attribute
instance-attribute
¶
Search in title, sku, and barcode.
sku = Field(default=None, title='SKU', description='Filter by SKU.')
class-attribute
instance-attribute
¶
Filter by SKU.
VideoFilters
¶
Bases: MediaAssetFilters
Filters specific to video assets.
mime_type = Field('video')
class-attribute
instance-attribute
¶
Automatically set to 'video' for video filters