api.md

Shared Types

from courier.types import (
    AirshipProfile,
    AirshipProfileAudience,
    Alignment,
    AudienceFilter,
    AudienceFilterConfig,
    AudienceRecipient,
    ChannelClassification,
    ChannelPreference,
    DeviceType,
    Discord,
    ElementalActionNodeWithType,
    ElementalBaseNode,
    ElementalChannelNode,
    ElementalChannelNodeWithType,
    ElementalContent,
    ElementalContentSugar,
    ElementalDividerNodeWithType,
    ElementalImageNodeWithType,
    ElementalMetaNodeWithType,
    ElementalNode,
    ElementalQuoteNodeWithType,
    ElementalTextNodeWithType,
    Expo,
    FilterConfig,
    Intercom,
    IntercomRecipient,
    ListFilter,
    ListPatternRecipient,
    ListRecipient,
    MessageContext,
    MessageRouting,
    MessageRoutingChannel,
    MsTeams,
    MsTeamsBaseProperties,
    MsTeamsRecipient,
    MultipleTokens,
    NotificationPreferenceDetails,
    Pagerduty,
    PagerdutyRecipient,
    Paging,
    Preference,
    PreferenceStatus,
    RecipientPreferences,
    Rule,
    SendDirectMessage,
    SendToChannel,
    SendToMsTeamsChannelID,
    SendToMsTeamsChannelName,
    SendToMsTeamsConversationID,
    SendToMsTeamsEmail,
    SendToMsTeamsUserID,
    SendToSlackChannel,
    SendToSlackEmail,
    SendToSlackUserID,
    Slack,
    SlackBaseProperties,
    SlackRecipient,
    TextStyle,
    Token,
    UserProfile,
    UserProfileFirebaseToken,
    UserRecipient,
    Utm,
    WebhookAuthMode,
    WebhookAuthentication,
    WebhookMethod,
    WebhookProfile,
    WebhookProfileType,
    WebhookRecipient,
)

Send

Types:

from courier.types import SendMessageResponse

Methods:

• client.send.message(**params) -> SendMessageResponse

Audiences

Types:

from courier.types import (
    Audience,
    AudienceUpdateResponse,
    AudienceListResponse,
    AudienceListMembersResponse,
)

Methods:

• client.audiences.retrieve(audience_id) -> Audience
• client.audiences.update(audience_id, **params) -> AudienceUpdateResponse
• client.audiences.list(**params) -> AudienceListResponse
• client.audiences.delete(audience_id) -> None
• client.audiences.list_members(audience_id, **params) -> AudienceListMembersResponse

AuditEvents

Types:

from courier.types import AuditEvent, AuditEventListResponse

Methods:

• client.audit_events.retrieve(audit_event_id) -> AuditEvent
• client.audit_events.list(**params) -> AuditEventListResponse

Auth

Types:

from courier.types import AuthIssueTokenResponse

Methods:

• client.auth.issue_token(**params) -> AuthIssueTokenResponse

Automations

Types:

from courier.types import (
    AutomationInvokeResponse,
    AutomationTemplate,
    AutomationTemplateListResponse,
)

Methods:

• client.automations.list(**params) -> AutomationTemplateListResponse

Invoke

Methods:

• client.automations.invoke.invoke_ad_hoc(**params) -> AutomationInvokeResponse
• client.automations.invoke.invoke_by_template(template_id, **params) -> AutomationInvokeResponse

Brands

Types:

from courier.types import (
    Brand,
    BrandColors,
    BrandSettings,
    BrandSettingsEmail,
    BrandSettingsInApp,
    BrandSnippet,
    BrandSnippets,
    BrandTemplate,
    EmailFooter,
    EmailHead,
    EmailHeader,
    Icons,
    Logo,
    WidgetBackground,
    BrandListResponse,
)

Methods:

• client.brands.create(**params) -> Brand
• client.brands.retrieve(brand_id) -> Brand
• client.brands.update(brand_id, **params) -> Brand
• client.brands.list(**params) -> BrandListResponse
• client.brands.delete(brand_id) -> None

Bulk

Types:

from courier.types import (
    InboundBulkMessage,
    InboundBulkMessageUser,
    BulkCreateJobResponse,
    BulkListUsersResponse,
    BulkRetrieveJobResponse,
)

Methods:

• client.bulk.add_users(job_id, **params) -> None
• client.bulk.create_job(**params) -> BulkCreateJobResponse
• client.bulk.list_users(job_id, **params) -> BulkListUsersResponse
• client.bulk.retrieve_job(job_id) -> BulkRetrieveJobResponse
• client.bulk.run_job(job_id) -> None

Inbound

Types:

from courier.types import InboundTrackEventResponse

Methods:

• client.inbound.track_event(**params) -> InboundTrackEventResponse

Lists

Types:

from courier.types import PutSubscriptionsRecipient, SubscriptionList, ListListResponse

Methods:

• client.lists.retrieve(list_id) -> SubscriptionList
• client.lists.update(list_id, **params) -> None
• client.lists.list(**params) -> ListListResponse
• client.lists.delete(list_id) -> None
• client.lists.restore(list_id) -> None

Subscriptions

Types:

from courier.types.lists import SubscriptionListResponse

Methods:

• client.lists.subscriptions.list(list_id, **params) -> SubscriptionListResponse
• client.lists.subscriptions.add(list_id, **params) -> None
• client.lists.subscriptions.subscribe(list_id, **params) -> None
• client.lists.subscriptions.subscribe_user(user_id, *, list_id, **params) -> None
• client.lists.subscriptions.unsubscribe_user(user_id, *, list_id) -> None

Messages

Types:

from courier.types import (
    MessageDetails,
    MessageRetrieveResponse,
    MessageListResponse,
    MessageContentResponse,
    MessageHistoryResponse,
)

Methods:

• client.messages.retrieve(message_id) -> MessageRetrieveResponse
• client.messages.list(**params) -> MessageListResponse
• client.messages.cancel(message_id) -> MessageDetails
• client.messages.content(message_id) -> MessageContentResponse
• client.messages.history(message_id, **params) -> MessageHistoryResponse

Requests

Methods:

• client.requests.archive(request_id) -> None

Notifications

Types:

from courier.types import BaseCheck, Check, NotificationGetContent, NotificationListResponse

Methods:

• client.notifications.list(**params) -> NotificationListResponse
• client.notifications.retrieve_content(id) -> NotificationGetContent

Draft

Methods:

• client.notifications.draft.retrieve_content(id) -> NotificationGetContent

Checks

Types:

from courier.types.notifications import CheckUpdateResponse, CheckListResponse

Methods:

• client.notifications.checks.update(submission_id, *, id, **params) -> CheckUpdateResponse
• client.notifications.checks.list(submission_id, *, id) -> CheckListResponse
• client.notifications.checks.delete(submission_id, *, id) -> None

Profiles

Types:

from courier.types import (
    SubscribeToListsRequestItem,
    ProfileCreateResponse,
    ProfileRetrieveResponse,
    ProfileReplaceResponse,
)

Methods:

• client.profiles.create(user_id, **params) -> ProfileCreateResponse
• client.profiles.retrieve(user_id) -> ProfileRetrieveResponse
• client.profiles.update(user_id, **params) -> None
• client.profiles.delete(user_id) -> None
• client.profiles.replace(user_id, **params) -> ProfileReplaceResponse

Lists

Types:

from courier.types.profiles import ListRetrieveResponse, ListDeleteResponse, ListSubscribeResponse

Methods:

• client.profiles.lists.retrieve(user_id, **params) -> ListRetrieveResponse
• client.profiles.lists.delete(user_id) -> ListDeleteResponse
• client.profiles.lists.subscribe(user_id, **params) -> ListSubscribeResponse

Tenants

Types:

from courier.types import (
    BaseTemplateTenantAssociation,
    DefaultPreferences,
    PostTenantTemplatePublishRequest,
    PostTenantTemplatePublishResponse,
    PutTenantTemplateRequest,
    PutTenantTemplateResponse,
    SubscriptionTopicNew,
    Tenant,
    TenantAssociation,
    TenantTemplateInput,
    TenantListResponse,
    TenantListUsersResponse,
)

Methods:

• client.tenants.retrieve(tenant_id) -> Tenant
• client.tenants.update(tenant_id, **params) -> Tenant
• client.tenants.list(**params) -> TenantListResponse
• client.tenants.delete(tenant_id) -> None
• client.tenants.list_users(tenant_id, **params) -> TenantListUsersResponse

Preferences

Items

Methods:

• client.tenants.preferences.items.update(topic_id, *, tenant_id, **params) -> None
• client.tenants.preferences.items.delete(topic_id, *, tenant_id) -> None

Templates

Types:

from courier.types.tenants import TemplateListResponse

Methods:

• client.tenants.templates.retrieve(template_id, *, tenant_id) -> BaseTemplateTenantAssociation
• client.tenants.templates.list(tenant_id, **params) -> TemplateListResponse
• client.tenants.templates.publish(template_id, *, tenant_id, **params) -> PostTenantTemplatePublishResponse
• client.tenants.templates.replace(template_id, *, tenant_id, **params) -> PutTenantTemplateResponse

Versions

Methods:

• client.tenants.templates.versions.retrieve(version, *, tenant_id, template_id) -> BaseTemplateTenantAssociation

Translations

Types:

from courier.types import TranslationRetrieveResponse

Methods:

• client.translations.retrieve(locale, *, domain) -> str
• client.translations.update(locale, *, domain, **params) -> None

Users

Preferences

Types:

from courier.types.users import (
    TopicPreference,
    PreferenceRetrieveResponse,
    PreferenceRetrieveTopicResponse,
    PreferenceUpdateOrCreateTopicResponse,
)

Methods:

• client.users.preferences.retrieve(user_id, **params) -> PreferenceRetrieveResponse
• client.users.preferences.retrieve_topic(topic_id, *, user_id, **params) -> PreferenceRetrieveTopicResponse
• client.users.preferences.update_or_create_topic(topic_id, *, user_id, **params) -> PreferenceUpdateOrCreateTopicResponse

Tenants

Types:

from courier.types.users import TenantListResponse

Methods:

• client.users.tenants.list(user_id, **params) -> TenantListResponse
• client.users.tenants.add_multiple(user_id, **params) -> None
• client.users.tenants.add_single(tenant_id, *, user_id, **params) -> None
• client.users.tenants.remove_all(user_id) -> None
• client.users.tenants.remove_single(tenant_id, *, user_id) -> None

Tokens

Types:

from courier.types.users import UserToken, TokenRetrieveResponse, TokenListResponse

Methods:

• client.users.tokens.retrieve(token, *, user_id) -> TokenRetrieveResponse
• client.users.tokens.update(token, *, user_id, **params) -> None
• client.users.tokens.list(user_id) -> TokenListResponse
• client.users.tokens.delete(token, *, user_id) -> None
• client.users.tokens.add_multiple(user_id) -> None
• client.users.tokens.add_single(path_token, *, user_id, **params) -> None