api.md

Shared Types

from knock_mapi.types import PageInfo

Templates

Types:

from knock_mapi.types import (
    ChatTemplate,
    EmailTemplate,
    InAppFeedTemplate,
    PushTemplate,
    RequestTemplate,
    SMSTemplate,
    WebhookTemplate,
)

EmailLayouts

Types:

from knock_mapi.types import EmailLayout, EmailLayoutUpsertResponse, EmailLayoutValidateResponse

Methods:

• client.email_layouts.retrieve(email_layout_key, **params) -> EmailLayout
• client.email_layouts.list(**params) -> SyncEntriesCursor[EmailLayout]
• client.email_layouts.upsert(email_layout_key, **params) -> EmailLayoutUpsertResponse
• client.email_layouts.validate(email_layout_key, **params) -> EmailLayoutValidateResponse

Commits

Types:

from knock_mapi.types import (
    Commit,
    CommitCommitAllResponse,
    CommitPromoteAllResponse,
    CommitPromoteOneResponse,
)

Methods:

• client.commits.retrieve(id) -> Commit
• client.commits.list(**params) -> SyncEntriesCursor[Commit]
• client.commits.commit_all(**params) -> CommitCommitAllResponse
• client.commits.promote_all(**params) -> CommitPromoteAllResponse
• client.commits.promote_one(id) -> CommitPromoteOneResponse

Partials

Types:

from knock_mapi.types import Partial, PartialUpsertResponse, PartialValidateResponse

Methods:

• client.partials.retrieve(partial_key, **params) -> Partial
• client.partials.list(**params) -> SyncEntriesCursor[Partial]
• client.partials.upsert(partial_key, **params) -> PartialUpsertResponse
• client.partials.validate(partial_key, **params) -> PartialValidateResponse

Translations

Types:

from knock_mapi.types import (
    Translation,
    TranslationRetrieveResponse,
    TranslationUpsertResponse,
    TranslationValidateResponse,
)

Methods:

• client.translations.retrieve(locale_code, **params) -> TranslationRetrieveResponse
• client.translations.list(**params) -> SyncEntriesCursor[Translation]
• client.translations.upsert(locale_code, **params) -> TranslationUpsertResponse
• client.translations.validate(locale_code, **params) -> TranslationValidateResponse

Workflows

Types:

from knock_mapi.types import (
    Condition,
    ConditionGroup,
    Duration,
    SendWindow,
    Workflow,
    WorkflowBatchStep,
    WorkflowBranchStep,
    WorkflowChannelStep,
    WorkflowDelayStep,
    WorkflowFetchStep,
    WorkflowStep,
    WorkflowThrottleStep,
    WorkflowTriggerWorkflowStep,
    WorkflowActivateResponse,
    WorkflowRunResponse,
    WorkflowUpsertResponse,
    WorkflowValidateResponse,
)

Methods:

• client.workflows.retrieve(workflow_key, **params) -> Workflow
• client.workflows.list(**params) -> SyncEntriesCursor[Workflow]
• client.workflows.activate(workflow_key, **params) -> WorkflowActivateResponse
• client.workflows.run(workflow_key, **params) -> WorkflowRunResponse
• client.workflows.upsert(workflow_key, **params) -> WorkflowUpsertResponse
• client.workflows.validate(workflow_key, **params) -> WorkflowValidateResponse

Steps

Types:

from knock_mapi.types.workflows import StepPreviewTemplateResponse

Methods:

• client.workflows.steps.preview_template(step_ref, *, workflow_key, **params) -> StepPreviewTemplateResponse

MessageTypes

Types:

from knock_mapi.types import (
    MessageType,
    MessageTypeTextField,
    MessageTypeVariant,
    MessageTypeUpsertResponse,
    MessageTypeValidateResponse,
)

Methods:

• client.message_types.retrieve(message_type_key, **params) -> MessageType
• client.message_types.list(**params) -> SyncEntriesCursor[MessageType]
• client.message_types.upsert(message_type_key, **params) -> MessageTypeUpsertResponse
• client.message_types.validate(message_type_key, **params) -> MessageTypeValidateResponse

Auth

Types:

from knock_mapi.types import AuthVerifyResponse

Methods:

• client.auth.verify() -> AuthVerifyResponse

APIKeys

Types:

from knock_mapi.types import APIKeyExchangeResponse

Methods:

• client.api_keys.exchange(**params) -> APIKeyExchangeResponse

ChannelGroups

Types:

from knock_mapi.types import ChannelGroup, ChannelGroupRule

Methods:

• client.channel_groups.list(**params) -> SyncEntriesCursor[ChannelGroup]

Channels

Types:

from knock_mapi.types import (
    Channel,
    ChatChannelSettings,
    EmailChannelSettings,
    InAppFeedChannelSettings,
    PushChannelSettings,
    SMSChannelSettings,
)

Methods:

• client.channels.list(**params) -> SyncEntriesCursor[Channel]

Environments

Types:

from knock_mapi.types import Environment

Methods:

• client.environments.retrieve(environment_slug) -> Environment
• client.environments.list(**params) -> SyncEntriesCursor[Environment]

Variables

Types:

from knock_mapi.types import Variable

Methods:

• client.variables.list(**params) -> SyncEntriesCursor[Variable]