channel

konigle.managers.comm.email.channel

Email channel managers for the Konigle SDK.

This module provides managers for email channel resources, enabling email channel management operations including CRUD operations.

AsyncEmailChannelManager

Bases: BaseEmailChannelManager, BaseAsyncManager

Asynchronous manager for email channel resources.

create(data) async

Create a new email channel.

PARAMETER	DESCRIPTION
data	Email channel creation data including all required fields TYPE: EmailChannelCreate

RETURNS	DESCRIPTION
EmailChannel	Created email channel instance with Active Record capabilities

Example

channel_data = EmailChannelCreate(
    code="transactional",
    channel_type=EmailChannelType.TRANSACTIONAL,
)
channel = await client.email_channels.create(channel_data)
print(f"Created channel: {channel.code}")

set_engagement_tracking(channel_id, enable) async

Enable or disable engagement tracking for the channel.

PARAMETER	DESCRIPTION
channel_id	ID of the channel to update TYPE: str
enable	True to enable engagement tracking, False to disable TYPE: bool

RETURNS	DESCRIPTION
EmailChannel	Updated channel instance with engagement tracking setting

Example

channel = await client.email_channels.set_engagement_tracking(
    "ch_123", True
)
print(f"Engagement tracking: {channel.enable_engagement_tracking}")

BaseEmailChannelManager

Base class for email channel managers with shared configuration.

base_path = '/reachout/api/v1/channels' class-attribute instance-attribute

The API base path for this resource type.

filter_class = EmailChannelFilters class-attribute instance-attribute

The filter model class for this resource type.

resource_class = EmailChannel class-attribute instance-attribute

The resource model class this manager handles.

resource_update_class = EmailChannelUpdate class-attribute instance-attribute

The model class used for updating resources.

EmailChannelManager

Bases: BaseEmailChannelManager, BaseSyncManager

Synchronous manager for email channel resources.

create(data)

Create a new email channel.

PARAMETER	DESCRIPTION
data	Email channel creation data including all required fields TYPE: EmailChannelCreate

RETURNS	DESCRIPTION
EmailChannel	Created email channel instance with Active Record capabilities

Example

channel_data = EmailChannelCreate(
    code="transactional",
    channel_type=EmailChannelType.TRANSACTIONAL,
)
channel = client.email_channels.create(channel_data)
print(f"Created channel: {channel.code}")

set_engagement_tracking(channel_id, enable)

Enable or disable engagement tracking for the channel.

PARAMETER	DESCRIPTION
channel_id	ID of the channel to update TYPE: str
enable	True to enable engagement tracking, False to disable TYPE: bool

RETURNS	DESCRIPTION
EmailChannel	Updated channel instance with engagement tracking setting

Example

channel = client.email_channels.set_engagement_tracking(
    "ch_123", True
)
print(f"Engagement tracking: {channel.enable_engagement_tracking}")