api.md

Shared Types

from knockapi.types import Condition, PageInfo

Recipients

Types:

from knockapi.types import Recipient, RecipientReference, RecipientRequest

Subscriptions

Types:

from knockapi.types.recipients import Subscription

Preferences

Types:

from knockapi.types.recipients import (
    InlinePreferenceSetRequest,
    PreferenceSet,
    PreferenceSetChannelSetting,
    PreferenceSetChannelTypeSetting,
    PreferenceSetChannelTypes,
    PreferenceSetRequest,
)

ChannelData

Types:

from knockapi.types.recipients import (
    AwsSnsPushChannelDataDevicesOnly,
    AwsSnsPushChannelDataTargetArnsOnly,
    ChannelData,
    ChannelDataRequest,
    DiscordChannelData,
    InlineChannelDataRequest,
    MsTeamsChannelData,
    OneSignalChannelDataPlayerIDsOnly,
    PushChannelDataDevicesOnly,
    PushChannelDataTokensOnly,
    SlackChannelData,
)

Users

Types:

from knockapi.types import (
    IdentifyUserRequest,
    InlineIdentifyUserRequest,
    User,
    UserListPreferencesResponse,
)

Methods:

• client.users.update(user_id, **params) -> User
• client.users.list(**params) -> SyncEntriesCursor[User]
• client.users.delete(user_id) -> None
• client.users.get(user_id) -> User
• client.users.get_channel_data(user_id, channel_id) -> ChannelData
• client.users.get_preferences(user_id, id, **params) -> PreferenceSet
• client.users.list_messages(user_id, **params) -> SyncItemsCursor[Message]
• client.users.list_preferences(user_id) -> UserListPreferencesResponse
• client.users.list_schedules(user_id, **params) -> SyncEntriesCursor[Schedule]
• client.users.list_subscriptions(user_id, **params) -> SyncEntriesCursor[Subscription]
• client.users.merge(user_id, **params) -> User
• client.users.set_channel_data(user_id, channel_id, **params) -> ChannelData
• client.users.set_preferences(user_id, id, **params) -> PreferenceSet
• client.users.unset_channel_data(user_id, channel_id) -> None

Feeds

Types:

from knockapi.types.users import FeedGetSettingsResponse, FeedListItemsResponse

Methods:

• client.users.feeds.get_settings(user_id, id) -> FeedGetSettingsResponse
• client.users.feeds.list_items(user_id, id, **params) -> SyncEntriesCursor[FeedListItemsResponse]

Guides

Types:

from knockapi.types.users import (
    GuideGetChannelResponse,
    GuideMarkMessageAsArchivedResponse,
    GuideMarkMessageAsInteractedResponse,
    GuideMarkMessageAsSeenResponse,
)

Methods:

• client.users.guides.get_channel(user_id, channel_id, **params) -> GuideGetChannelResponse
• client.users.guides.mark_message_as_archived(user_id, message_id, **params) -> GuideMarkMessageAsArchivedResponse
• client.users.guides.mark_message_as_interacted(user_id, message_id, **params) -> GuideMarkMessageAsInteractedResponse
• client.users.guides.mark_message_as_seen(user_id, message_id, **params) -> GuideMarkMessageAsSeenResponse

Bulk

Methods:

• client.users.bulk.delete(**params) -> BulkOperation
• client.users.bulk.identify(**params) -> BulkOperation
• client.users.bulk.set_preferences(**params) -> BulkOperation

Objects

Types:

from knockapi.types import (
    InlineObjectRequest,
    Object,
    ObjectAddSubscriptionsResponse,
    ObjectDeleteSubscriptionsResponse,
    ObjectListPreferencesResponse,
)

Methods:

• client.objects.list(collection, **params) -> SyncEntriesCursor[Object]
• client.objects.delete(collection, id) -> None
• client.objects.add_subscriptions(collection, object_id, **params) -> ObjectAddSubscriptionsResponse
• client.objects.delete_subscriptions(collection, object_id, **params) -> ObjectDeleteSubscriptionsResponse
• client.objects.get(collection, id) -> Object
• client.objects.get_channel_data(collection, object_id, channel_id) -> ChannelData
• client.objects.get_preferences(collection, object_id, id) -> PreferenceSet
• client.objects.list_messages(collection, id, **params) -> SyncItemsCursor[Message]
• client.objects.list_preferences(collection, object_id) -> ObjectListPreferencesResponse
• client.objects.list_schedules(collection, id, **params) -> SyncEntriesCursor[Schedule]
• client.objects.list_subscriptions(collection, object_id, **params) -> SyncEntriesCursor[Subscription]
• client.objects.set(collection, id, **params) -> Object
• client.objects.set_channel_data(collection, object_id, channel_id, **params) -> ChannelData
• client.objects.set_preferences(collection, object_id, id, **params) -> PreferenceSet
• client.objects.unset_channel_data(collection, object_id, channel_id) -> None

Bulk

Methods:

• client.objects.bulk.delete(collection, **params) -> BulkOperation
• client.objects.bulk.add_subscriptions(collection, **params) -> BulkOperation
• client.objects.bulk.delete_subscriptions(collection, **params) -> BulkOperation
• client.objects.bulk.set(collection, **params) -> BulkOperation

Tenants

Types:

from knockapi.types import InlineTenantRequest, Tenant, TenantRequest

Methods:

• client.tenants.list(**params) -> SyncEntriesCursor[Tenant]
• client.tenants.delete(id) -> None
• client.tenants.get(id, **params) -> Tenant
• client.tenants.set(id, **params) -> Tenant

Bulk

Methods:

• client.tenants.bulk.delete(**params) -> BulkOperation
• client.tenants.bulk.set(**params) -> BulkOperation

BulkOperations

Types:

from knockapi.types import BulkOperation

Methods:

• client.bulk_operations.get(id) -> BulkOperation

Messages

Types:

from knockapi.types import (
    Activity,
    Message,
    MessageDeliveryLog,
    MessageEvent,
    MessageGetContentResponse,
)

Methods:

• client.messages.list(**params) -> SyncItemsCursor[Message]
• client.messages.archive(message_id) -> Message
• client.messages.get(message_id) -> Message
• client.messages.get_content(message_id) -> MessageGetContentResponse
• client.messages.list_activities(message_id, **params) -> SyncItemsCursor[Activity]
• client.messages.list_delivery_logs(message_id, **params) -> SyncItemsCursor[MessageDeliveryLog]
• client.messages.list_events(message_id, **params) -> SyncItemsCursor[MessageEvent]
• client.messages.mark_as_interacted(message_id, **params) -> Message
• client.messages.mark_as_read(message_id) -> Message
• client.messages.mark_as_seen(message_id) -> Message
• client.messages.mark_as_unread(message_id) -> Message
• client.messages.mark_as_unseen(message_id) -> Message
• client.messages.unarchive(message_id) -> Message

Batch

Types:

from knockapi.types.messages import (
    BatchArchiveResponse,
    BatchGetContentResponse,
    BatchMarkAsInteractedResponse,
    BatchMarkAsReadResponse,
    BatchMarkAsSeenResponse,
    BatchMarkAsUnreadResponse,
    BatchMarkAsUnseenResponse,
    BatchUnarchiveResponse,
)

Methods:

• client.messages.batch.archive(**params) -> BatchArchiveResponse
• client.messages.batch.get_content(**params) -> BatchGetContentResponse
• client.messages.batch.mark_as_interacted(**params) -> BatchMarkAsInteractedResponse
• client.messages.batch.mark_as_read(**params) -> BatchMarkAsReadResponse
• client.messages.batch.mark_as_seen(**params) -> BatchMarkAsSeenResponse
• client.messages.batch.mark_as_unread(**params) -> BatchMarkAsUnreadResponse
• client.messages.batch.mark_as_unseen(**params) -> BatchMarkAsUnseenResponse
• client.messages.batch.unarchive(**params) -> BatchUnarchiveResponse

Providers

Slack

Types:

from knockapi.types.providers import (
    SlackCheckAuthResponse,
    SlackListChannelsResponse,
    SlackRevokeAccessResponse,
)

Methods:

• client.providers.slack.check_auth(channel_id, **params) -> SlackCheckAuthResponse
• client.providers.slack.list_channels(channel_id, **params) -> SyncSlackChannelsCursor[SlackListChannelsResponse]
• client.providers.slack.revoke_access(channel_id, **params) -> SlackRevokeAccessResponse

MsTeams

Types:

from knockapi.types.providers import (
    MsTeamCheckAuthResponse,
    MsTeamListChannelsResponse,
    MsTeamListTeamsResponse,
    MsTeamRevokeAccessResponse,
)

Methods:

• client.providers.ms_teams.check_auth(channel_id, **params) -> MsTeamCheckAuthResponse
• client.providers.ms_teams.list_channels(channel_id, **params) -> MsTeamListChannelsResponse
• client.providers.ms_teams.list_teams(channel_id, **params) -> SyncMsTeamsPagination[MsTeamListTeamsResponse]
• client.providers.ms_teams.revoke_access(channel_id, **params) -> MsTeamRevokeAccessResponse

Integrations

Census

Types:

from knockapi.types.integrations import CensusCustomDestinationResponse

Methods:

• client.integrations.census.custom_destination(**params) -> CensusCustomDestinationResponse

Hightouch

Types:

from knockapi.types.integrations import HightouchEmbeddedDestinationResponse

Methods:

• client.integrations.hightouch.embedded_destination(**params) -> HightouchEmbeddedDestinationResponse

Workflows

Types:

from knockapi.types import WorkflowTriggerResponse

Methods:

• client.workflows.cancel(key, **params) -> None
• client.workflows.trigger(key, **params) -> WorkflowTriggerResponse

Schedules

Types:

from knockapi.types import (
    Schedule,
    ScheduleRepeatRule,
    ScheduleCreateResponse,
    ScheduleUpdateResponse,
    ScheduleDeleteResponse,
)

Methods:

• client.schedules.create(**params) -> ScheduleCreateResponse
• client.schedules.update(**params) -> ScheduleUpdateResponse
• client.schedules.list(**params) -> SyncEntriesCursor[Schedule]
• client.schedules.delete(**params) -> ScheduleDeleteResponse

Bulk

Methods:

• client.schedules.bulk.create(**params) -> BulkOperation

Channels

Bulk

Methods:

• client.channels.bulk.update_message_status(channel_id, action, **params) -> BulkOperation

Audiences

Types:

from knockapi.types import AudienceMember, AudienceListMembersResponse

Methods:

• client.audiences.add_members(key, **params) -> None
• client.audiences.list_members(key) -> AudienceListMembersResponse
• client.audiences.remove_members(key, **params) -> None