api.md

Webhooks

Types:

from sent_dm.types import (
    APIMeta,
    APIResponseWebhook,
    CallEvent,
    CallEventPayload,
    ChannelEvent,
    ChannelEventPayload,
    ContactEvent,
    ContactEventPayload,
    ErrorDetail,
    InboundMessageEvent,
    InboundMessageEventPayload,
    MessageEvent,
    MessageEventPayload,
    MutationRequest,
    PaginationMeta,
    TemplateEvent,
    TemplateEventPayload,
    WebhookEventType,
    WebhookResponse,
    WebhookListEventTypesResponse,
    WebhookListEventsResponse,
    WebhookRotateSecretResponse,
    WebhookTestResponse,
)

Methods:

• client.webhooks.create(**params) -> APIResponseWebhook
• client.webhooks.retrieve(id) -> APIResponseWebhook
• client.webhooks.update(id, **params) -> APIResponseWebhook
• client.webhooks.list(**params) -> SyncWebhooksPage[WebhookResponse]
• client.webhooks.delete(id) -> None
• client.webhooks.list_event_types() -> WebhookListEventTypesResponse
• client.webhooks.list_events(id, **params) -> SyncWebhookEventsPage[WebhookListEventsResponse]
• client.webhooks.rotate_secret(id, **params) -> WebhookRotateSecretResponse
• client.webhooks.test(id, **params) -> WebhookTestResponse
• client.webhooks.toggle_status(id, **params) -> APIResponseWebhook

Users

Types:

from sent_dm.types import APIResponseOfUser, UserResponse, UserListResponse

Methods:

• client.users.retrieve(user_id) -> APIResponseOfUser
• client.users.list() -> UserListResponse
• client.users.invite(**params) -> APIResponseOfUser
• client.users.remove(user_id, **params) -> None
• client.users.update_role(user_id, **params) -> APIResponseOfUser

Templates

Types:

from sent_dm.types import (
    APIResponseTemplate,
    AuthenticationConfig,
    Template,
    TemplateBody,
    TemplateBodyContent,
    TemplateButton,
    TemplateButtonProps,
    TemplateDefinition,
    TemplateFooter,
    TemplateHeader,
    TemplateVariable,
)

Methods:

• client.templates.create(**params) -> APIResponseTemplate
• client.templates.retrieve(id) -> APIResponseTemplate
• client.templates.update(id, **params) -> APIResponseTemplate
• client.templates.list(**params) -> SyncTemplatesPage[Template]
• client.templates.delete(id, **params) -> None

Profiles

Types:

from sent_dm.types import (
    APIResponseOfProfileDetail,
    BillingContactInfo,
    BrandBusinessInfo,
    BrandComplianceInfo,
    BrandContactInfo,
    BrandsBrandData,
    DestinationCountry,
    PaymentDetails,
    ProfileDetail,
    TcrBrandRelationship,
    TcrVertical,
    ProfileListResponse,
    ProfileCompleteResponse,
)

Methods:

• client.profiles.create(**params) -> APIResponseOfProfileDetail
• client.profiles.retrieve(profile_id) -> APIResponseOfProfileDetail
• client.profiles.update(profile_id, **params) -> APIResponseOfProfileDetail
• client.profiles.list() -> ProfileListResponse
• client.profiles.delete(profile_id, **params) -> None
• client.profiles.complete(profile_id, **params) -> ProfileCompleteResponse

Campaigns

Types:

from sent_dm.types.profiles import (
    APIResponseOfBrandCampaign,
    APIResponseOfListOfBrandCampaign,
    BrandCampaign,
    CampaignData,
    CampaignUseCase,
    CampaignUseCaseData,
    MessagingUseCaseUs,
)

Methods:

• client.profiles.campaigns.create(profile_id, **params) -> APIResponseOfBrandCampaign
• client.profiles.campaigns.update(campaign_id, *, profile_id, **params) -> APIResponseOfBrandCampaign
• client.profiles.campaigns.list(profile_id) -> APIResponseOfListOfBrandCampaign
• client.profiles.campaigns.delete(campaign_id, *, profile_id, **params) -> None

Numbers

Types:

from sent_dm.types import NumberLookupResponse

Methods:

• client.numbers.lookup(phone_number) -> NumberLookupResponse

Messages

Types:

from sent_dm.types import (
    MessageRetrieveActivitiesResponse,
    MessageRetrieveStatusResponse,
    MessageSendResponse,
)

Methods:

• client.messages.retrieve_activities(id) -> MessageRetrieveActivitiesResponse
• client.messages.retrieve_status(id) -> MessageRetrieveStatusResponse
• client.messages.send(**params) -> MessageSendResponse

Contacts

Types:

from sent_dm.types import (
    APIResponseOfContact,
    APIResponseOfContactMessageSummary,
    ContactMessageSummary,
    ContactResponse,
)

Methods:

• client.contacts.create(**params) -> APIResponseOfContact
• client.contacts.retrieve(id) -> APIResponseOfContact
• client.contacts.update(id, **params) -> APIResponseOfContact
• client.contacts.list(**params) -> SyncContactsPage[ContactResponse]
• client.contacts.delete(id, **params) -> None
• client.contacts.retrieve_message_summary(contact_id) -> APIResponseOfContactMessageSummary

Conversations

Types:

from sent_dm.types import APIResponseOfConversationMessagesList, ConversationMessagesList

Methods:

• client.conversations.list(**params) -> SyncConversationsPage[Message]
• client.conversations.list_messages(id, **params) -> SyncConversationsPage[Message]

Calls

Types:

from sent_dm.types import (
    APIResponseOfCall,
    APIResponseOfCallRecordings,
    APIResponseOfCallsList,
    Call,
    CallParty,
    CallRecording,
    CallRecordings,
    CallTimelineEntry,
    CallsList,
)

Methods:

• client.calls.retrieve(id) -> APIResponseOfCall
• client.calls.list(**params) -> SyncCallsPage[Call]
• client.calls.hangup(id, **params) -> None
• client.calls.list_recordings(id) -> APIResponseOfCallRecordings
• client.calls.record(id, **params) -> None

Participants

Types:

from sent_dm.types.calls import (
    APIResponseOfListOfCallParticipant,
    CallParticipant,
    CallParticipantTarget,
)

Methods:

• client.calls.participants.update(participant_id, *, id, **params) -> None
• client.calls.participants.list(id) -> APIResponseOfListOfCallParticipant
• client.calls.participants.add(id, **params) -> APIResponseOfCall
• client.calls.participants.remove(participant_id, *, id, **params) -> None
• client.calls.participants.remove_all(id, **params) -> None

Channels

Voice

Types:

from sent_dm.types.channels import (
    APIResponseOfListOfVoiceNumber,
    APIResponseOfVoiceCallbackTest,
    APIResponseOfVoiceNumber,
    APIResponseOfVoiceNumberCreated,
    APIResponseOfVoiceSecret,
    APIResponseOfVoiceToken,
    VoiceCallbackTest,
    VoiceCallbackTestErrorInfo,
    VoiceCallbackTestRequestInfo,
    VoiceCallbackTestResponseInfo,
    VoiceNumber,
    VoiceNumberCreated,
    VoiceSecret,
    VoiceToken,
)

Methods:

• client.channels.voice.create(**params) -> APIResponseOfVoiceNumberCreated
• client.channels.voice.retrieve(number) -> APIResponseOfVoiceNumber
• client.channels.voice.update(number, **params) -> APIResponseOfVoiceNumber
• client.channels.voice.list() -> APIResponseOfListOfVoiceNumber
• client.channels.voice.create_token(**params) -> APIResponseOfVoiceToken
• client.channels.voice.rotate_secret(number, **params) -> APIResponseOfVoiceSecret
• client.channels.voice.test(number, **params) -> APIResponseOfVoiceCallbackTest

Me

Types:

from sent_dm.types import ProfileSettings, MeRetrieveResponse

Methods:

• client.me.retrieve() -> MeRetrieveResponse