api.md

Shared Types

fromsurge.typesimportError

Accounts

Types:

fromsurge.typesimportAccount, AccountStatus, Organization

Methods:

• client.accounts.create(**params) -> Account
• client.accounts.retrieve(id) -> Account
• client.accounts.update(id, **params) -> Account
• client.accounts.list(**params) -> SyncCursor[Account]
• client.accounts.archive(id) -> Account
• client.accounts.retrieve_status(account_id, **params) -> AccountStatus

Attachments

Types:

fromsurge.typesimportAttachmentGetFileResponse

Methods:

• client.attachments.get_file(attachment_id) -> AttachmentGetFileResponse

Audiences

Types:

fromsurge.typesimportAudienceCreateResponse

Methods:

• client.audiences.create(account_id, **params) -> AudienceCreateResponse
• client.audiences.add_contact(audience_id, **params) -> Contact
• client.audiences.list_contacts(audience_id, **params) -> SyncCursor[Contact]

Blasts

Types:

fromsurge.typesimportBlast

Methods:

• client.blasts.create(account_id, **params) -> Blast

Campaigns

Types:

fromsurge.typesimportCampaign, CampaignResendBrandVerificationMessageResponse

Methods:

• client.campaigns.create(account_id, **params) -> Campaign
• client.campaigns.retrieve(id) -> Campaign
• client.campaigns.update(id, **params) -> Campaign
• client.campaigns.list(account_id, **params) -> SyncCursor[Campaign]
• client.campaigns.resend_brand_verification_message(account_id) -> CampaignResendBrandVerificationMessageResponse

Contacts

Types:

fromsurge.typesimportContact

Methods:

• client.contacts.create(account_id, **params) -> Contact
• client.contacts.retrieve(id) -> Contact
• client.contacts.update(id, **params) -> Contact
• client.contacts.list(account_id, **params) -> SyncCursor[Contact]

Messages

Types:

fromsurge.typesimportMessage

Methods:

• client.messages.create(account_id, **params) -> Message
• client.messages.retrieve(id) -> Message
• client.messages.list(account_id, **params) -> SyncCursor[Message]

PhoneNumbers

Types:

fromsurge.typesimportPhoneNumber, PhoneNumberListAvailableNumbersResponse

Methods:

• client.phone_numbers.retrieve(id) -> PhoneNumber
• client.phone_numbers.update(id, **params) -> PhoneNumber
• client.phone_numbers.list(account_id, **params) -> SyncCursor[PhoneNumber]
• client.phone_numbers.list_available_numbers(account_id, **params) -> SyncCursor[PhoneNumberListAvailableNumbersResponse]
• client.phone_numbers.purchase(account_id, **params) -> PhoneNumber
• client.phone_numbers.release(id) -> PhoneNumber

Recordings

Types:

fromsurge.typesimport (
RecordingRetrieveResponse,
RecordingListResponse,
RecordingDeleteResponse,
RecordingGetFileResponse,
)

Methods:

• client.recordings.retrieve(id) -> RecordingRetrieveResponse
• client.recordings.list(account_id, **params) -> SyncCursor[RecordingListResponse]
• client.recordings.delete(id) -> RecordingDeleteResponse
• client.recordings.get_file(recording_id) -> RecordingGetFileResponse

Users

Types:

fromsurge.typesimportUser, UserTokenResponse

Methods:

• client.users.create(account_id, **params) -> User
• client.users.retrieve(id) -> User
• client.users.update(id, **params) -> User
• client.users.list(account_id, **params) -> SyncCursor[User]
• client.users.delete(id) -> User
• client.users.create_token(user_id, **params) -> UserTokenResponse

Verifications

Types:

fromsurge.typesimportVerification, VerificationCheck

Methods:

• client.verifications.create(account_id, **params) -> Verification
• client.verifications.check(id, **params) -> VerificationCheck

Webhooks

Types:

fromsurge.typesimport (
CallEndedWebhookEvent,
CampaignApprovedWebhookEvent,
ContactOptedInWebhookEvent,
ContactOptedOutWebhookEvent,
ConversationCreatedWebhookEvent,
LinkFollowedWebhookEvent,
MessageDeliveredWebhookEvent,
MessageFailedWebhookEvent,
MessageReceivedWebhookEvent,
MessageSentWebhookEvent,
PhoneNumberAttachedToCampaignWebhookEvent,
PhoneNumberImportedWebhookEvent,
RecordingCompletedWebhookEvent,
VoicemailReceivedWebhookEvent,
UnwrapWebhookEvent,
)