api.md

Messages

Types:

from zavudev.types import (
    Channel,
    Message,
    MessageContent,
    MessageResponse,
    MessageStatus,
    MessageType,
    MessageListAttachmentsResponse,
    MessageShowTypingResponse,
)

Methods:

• client.messages.retrieve(message_id) -> MessageResponse
• client.messages.list(**params) -> SyncCursor[Message]
• client.messages.list_attachments(message_id) -> MessageListAttachmentsResponse
• client.messages.react(message_id, **params) -> MessageResponse
• client.messages.send(**params) -> MessageResponse
• client.messages.show_typing(message_id) -> MessageShowTypingResponse

Templates

Types:

from zavudev.types import Template, WhatsappCategory, TemplateSyncResponse

Methods:

• client.templates.create(**params) -> Template
• client.templates.retrieve(template_id) -> Template
• client.templates.list(**params) -> SyncCursor[Template]
• client.templates.delete(template_id) -> None
• client.templates.submit(template_id, **params) -> Template
• client.templates.sync(**params) -> TemplateSyncResponse

Senders

Types:

from zavudev.types import (
    Sender,
    SenderWebhook,
    WebhookEvent,
    WebhookSecretResponse,
    WhatsappBusinessProfile,
    WhatsappBusinessProfileResponse,
    WhatsappBusinessProfileVertical,
    SenderUpdateProfileResponse,
    SenderUploadProfilePictureResponse,
)

Methods:

• client.senders.create(**params) -> Sender
• client.senders.retrieve(sender_id) -> Sender
• client.senders.update(sender_id, **params) -> Sender
• client.senders.list(**params) -> SyncCursor[Sender]
• client.senders.delete(sender_id) -> None
• client.senders.get_profile(sender_id) -> WhatsappBusinessProfileResponse
• client.senders.regenerate_webhook_secret(sender_id) -> WebhookSecretResponse
• client.senders.update_profile(sender_id, **params) -> SenderUpdateProfileResponse
• client.senders.upload_profile_picture(sender_id, **params) -> SenderUploadProfilePictureResponse

Agent

Types:

from zavudev.types.senders import (
    Agent,
    AgentExecution,
    AgentExecutionStatus,
    AgentProvider,
    AgentResponse,
    AgentStats,
)

Methods:

• client.senders.agent.create(sender_id, **params) -> AgentResponse
• client.senders.agent.retrieve(sender_id) -> AgentResponse
• client.senders.agent.update(sender_id, **params) -> AgentResponse
• client.senders.agent.delete(sender_id) -> None
• client.senders.agent.stats(sender_id) -> AgentStats

Executions

Types:

from zavudev.types.senders.agent import ExecutionRetrieveResponse

Methods:

• client.senders.agent.executions.retrieve(execution_id, *, sender_id) -> ExecutionRetrieveResponse
• client.senders.agent.executions.list(sender_id, **params) -> SyncCursor[AgentExecution]

Flows

Types:

from zavudev.types.senders.agent import (
    AgentFlow,
    FlowStep,
    FlowTrigger,
    FlowCreateResponse,
    FlowRetrieveResponse,
    FlowUpdateResponse,
    FlowDuplicateResponse,
)

Methods:

• client.senders.agent.flows.create(sender_id, **params) -> FlowCreateResponse
• client.senders.agent.flows.retrieve(flow_id, *, sender_id) -> FlowRetrieveResponse
• client.senders.agent.flows.update(flow_id, *, sender_id, **params) -> FlowUpdateResponse
• client.senders.agent.flows.list(sender_id, **params) -> SyncCursor[AgentFlow]
• client.senders.agent.flows.delete(flow_id, *, sender_id) -> None
• client.senders.agent.flows.duplicate(flow_id, *, sender_id, **params) -> FlowDuplicateResponse

Tools

Types:

from zavudev.types.senders.agent import (
    AgentTool,
    ToolParameters,
    ToolCreateResponse,
    ToolRetrieveResponse,
    ToolUpdateResponse,
    ToolListTestRunsResponse,
    ToolTestResponse,
)

Methods:

• client.senders.agent.tools.create(sender_id, **params) -> ToolCreateResponse
• client.senders.agent.tools.retrieve(tool_id, *, sender_id) -> ToolRetrieveResponse
• client.senders.agent.tools.update(tool_id, *, sender_id, **params) -> ToolUpdateResponse
• client.senders.agent.tools.list(sender_id, **params) -> SyncCursor[AgentTool]
• client.senders.agent.tools.delete(tool_id, *, sender_id) -> None
• client.senders.agent.tools.list_test_runs(tool_id, *, sender_id, **params) -> ToolListTestRunsResponse
• client.senders.agent.tools.test(tool_id, *, sender_id, **params) -> ToolTestResponse

Webhook

Methods:

• client.senders.agent.tools.webhook.rotate_secret(tool_id, *, sender_id) -> WebhookSecretResponse

KnowledgeBases

Types:

from zavudev.types.senders.agent import (
    AgentDocument,
    AgentKnowledgeBase,
    KnowledgeBaseCreateResponse,
    KnowledgeBaseRetrieveResponse,
    KnowledgeBaseUpdateResponse,
)

Methods:

• client.senders.agent.knowledge_bases.create(sender_id, **params) -> KnowledgeBaseCreateResponse
• client.senders.agent.knowledge_bases.retrieve(kb_id, *, sender_id) -> KnowledgeBaseRetrieveResponse
• client.senders.agent.knowledge_bases.update(kb_id, *, sender_id, **params) -> KnowledgeBaseUpdateResponse
• client.senders.agent.knowledge_bases.list(sender_id, **params) -> SyncCursor[AgentKnowledgeBase]
• client.senders.agent.knowledge_bases.delete(kb_id, *, sender_id) -> None

Documents

Types:

from zavudev.types.senders.agent.knowledge_bases import (
    DocumentCreateResponse,
    DocumentRetrieveDocumentResponse,
    DocumentUpdateDocumentResponse,
)

Methods:

• client.senders.agent.knowledge_bases.documents.create(kb_id, *, sender_id, **params) -> DocumentCreateResponse
• client.senders.agent.knowledge_bases.documents.list(kb_id, *, sender_id, **params) -> SyncCursor[AgentDocument]
• client.senders.agent.knowledge_bases.documents.delete(doc_id, *, sender_id, kb_id) -> None
• client.senders.agent.knowledge_bases.documents.retrieve_document(doc_id, *, sender_id, kb_id) -> DocumentRetrieveDocumentResponse
• client.senders.agent.knowledge_bases.documents.update_document(doc_id, *, sender_id, kb_id, **params) -> DocumentUpdateDocumentResponse

WhatsappSync

Types:

from zavudev.types.senders import (
    WhatsAppSyncContacts,
    WhatsAppSyncHistory,
    WhatsAppSyncStatus,
    WhatsappSyncRetrieveResponse,
    WhatsappSyncStartContactsSyncResponse,
    WhatsappSyncStartHistorySyncResponse,
)

Methods:

• client.senders.whatsapp_sync.retrieve(sender_id) -> WhatsappSyncRetrieveResponse
• client.senders.whatsapp_sync.start_contacts_sync(sender_id) -> WhatsappSyncStartContactsSyncResponse
• client.senders.whatsapp_sync.start_history_sync(sender_id) -> WhatsappSyncStartHistorySyncResponse

Telegram

Types:

from zavudev.types.senders import TelegramConnectResponse

Methods:

• client.senders.telegram.connect(sender_id, **params) -> TelegramConnectResponse
• client.senders.telegram.disconnect(sender_id) -> None

Contacts

Types:

from zavudev.types import Contact, ContactChannel

Methods:

• client.contacts.create(**params) -> Contact
• client.contacts.retrieve(contact_id) -> Contact
• client.contacts.update(contact_id, **params) -> Contact
• client.contacts.list(**params) -> SyncCursor[Contact]
• client.contacts.delete(contact_id) -> None
• client.contacts.merge(contact_id, **params) -> Contact
• client.contacts.retrieve_by_phone(phone_number) -> Contact

Channels

Types:

from zavudev.types.contacts import (
    ChannelUpdateResponse,
    ChannelAddResponse,
    ChannelSetPrimaryResponse,
)

Methods:

• client.contacts.channels.update(channel_id, *, contact_id, **params) -> ChannelUpdateResponse
• client.contacts.channels.add(contact_id, **params) -> ChannelAddResponse
• client.contacts.channels.remove(channel_id, *, contact_id) -> None
• client.contacts.channels.set_primary(channel_id, *, contact_id) -> ChannelSetPrimaryResponse

Broadcasts

Types:

from zavudev.types import (
    Broadcast,
    BroadcastChannel,
    BroadcastContact,
    BroadcastContactStatus,
    BroadcastContent,
    BroadcastMessageType,
    BroadcastProgress,
    BroadcastStatus,
    BroadcastCreateResponse,
    BroadcastRetrieveResponse,
    BroadcastUpdateResponse,
    BroadcastCancelResponse,
    BroadcastEscalateReviewResponse,
    BroadcastRescheduleResponse,
    BroadcastRetryReviewResponse,
    BroadcastSendResponse,
)

Methods:

• client.broadcasts.create(**params) -> BroadcastCreateResponse
• client.broadcasts.retrieve(broadcast_id) -> BroadcastRetrieveResponse
• client.broadcasts.update(broadcast_id, **params) -> BroadcastUpdateResponse
• client.broadcasts.list(**params) -> SyncCursor[Broadcast]
• client.broadcasts.delete(broadcast_id) -> None
• client.broadcasts.cancel(broadcast_id) -> BroadcastCancelResponse
• client.broadcasts.escalate_review(broadcast_id) -> BroadcastEscalateReviewResponse
• client.broadcasts.progress(broadcast_id) -> BroadcastProgress
• client.broadcasts.reschedule(broadcast_id, **params) -> BroadcastRescheduleResponse
• client.broadcasts.retry_review(broadcast_id) -> BroadcastRetryReviewResponse
• client.broadcasts.send(broadcast_id, **params) -> BroadcastSendResponse

Contacts

Types:

from zavudev.types.broadcasts import ContactAddResponse

Methods:

• client.broadcasts.contacts.list(broadcast_id, **params) -> SyncCursor[BroadcastContact]
• client.broadcasts.contacts.add(broadcast_id, **params) -> ContactAddResponse
• client.broadcasts.contacts.remove(contact_id, *, broadcast_id) -> None

Introspect

Types:

from zavudev.types import LineType, IntrospectValidateEmailResponse, IntrospectValidatePhoneResponse

Methods:

• client.introspect.validate_email(**params) -> IntrospectValidateEmailResponse
• client.introspect.validate_phone(**params) -> IntrospectValidatePhoneResponse

PhoneNumbers

Types:

from zavudev.types import (
    AvailablePhoneNumber,
    OwnedPhoneNumber,
    OwnedPhoneNumberPricing,
    PhoneNumberCapabilities,
    PhoneNumberPricing,
    PhoneNumberStatus,
    PhoneNumberType,
    Requirement,
    RequirementAcceptanceCriteria,
    RequirementFieldType,
    RequirementType,
    PhoneNumberRetrieveResponse,
    PhoneNumberUpdateResponse,
    PhoneNumberPurchaseResponse,
    PhoneNumberRequirementsResponse,
    PhoneNumberSearchAvailableResponse,
)

Methods:

• client.phone_numbers.retrieve(phone_number_id) -> PhoneNumberRetrieveResponse
• client.phone_numbers.update(phone_number_id, **params) -> PhoneNumberUpdateResponse
• client.phone_numbers.list(**params) -> SyncCursor[OwnedPhoneNumber]
• client.phone_numbers.purchase(**params) -> PhoneNumberPurchaseResponse
• client.phone_numbers.release(phone_number_id) -> None
• client.phone_numbers.requirements(**params) -> PhoneNumberRequirementsResponse
• client.phone_numbers.search_available(**params) -> PhoneNumberSearchAvailableResponse

Addresses

Types:

from zavudev.types import Address, AddressStatus, AddressCreateResponse, AddressRetrieveResponse

Methods:

• client.addresses.create(**params) -> AddressCreateResponse
• client.addresses.retrieve(address_id) -> AddressRetrieveResponse
• client.addresses.list(**params) -> SyncCursor[Address]
• client.addresses.delete(address_id) -> None

RegulatoryDocuments

Types:

from zavudev.types import (
    RegulatoryDocument,
    RegulatoryDocumentCreateResponse,
    RegulatoryDocumentRetrieveResponse,
    RegulatoryDocumentUploadURLResponse,
)

Methods:

• client.regulatory_documents.create(**params) -> RegulatoryDocumentCreateResponse
• client.regulatory_documents.retrieve(document_id) -> RegulatoryDocumentRetrieveResponse
• client.regulatory_documents.list(**params) -> SyncCursor[RegulatoryDocument]
• client.regulatory_documents.delete(document_id) -> None
• client.regulatory_documents.upload_url() -> RegulatoryDocumentUploadURLResponse

Invitations

Types:

from zavudev.types import (
    Invitation,
    InvitationCreateResponse,
    InvitationRetrieveResponse,
    InvitationCancelResponse,
)

Methods:

• client.invitations.create(**params) -> InvitationCreateResponse
• client.invitations.retrieve(invitation_id) -> InvitationRetrieveResponse
• client.invitations.list(**params) -> SyncCursor[Invitation]
• client.invitations.cancel(invitation_id) -> InvitationCancelResponse

URLs

Types:

from zavudev.types import (
    VerifiedURL,
    URLEscalateResponse,
    URLRetrieveDetailsResponse,
    URLSubmitForVerificationResponse,
)

Methods:

• client.urls.escalate(url_id, **params) -> URLEscalateResponse
• client.urls.list_verified(**params) -> SyncCursor[VerifiedURL]
• client.urls.retrieve_details(url_id) -> URLRetrieveDetailsResponse
• client.urls.submit_for_verification(**params) -> URLSubmitForVerificationResponse

Balance

Types:

from zavudev.types import BalanceRetrieveResponse

Methods:

• client.balance.retrieve() -> BalanceRetrieveResponse

SubAccounts

Types:

from zavudev.types import (
    SubAccount,
    SubAccountCreateResponse,
    SubAccountRetrieveResponse,
    SubAccountUpdateResponse,
    SubAccountDeactivateResponse,
    SubAccountGetBalanceResponse,
)

Methods:

• client.sub_accounts.create(**params) -> SubAccountCreateResponse
• client.sub_accounts.retrieve(id) -> SubAccountRetrieveResponse
• client.sub_accounts.update(id, **params) -> SubAccountUpdateResponse
• client.sub_accounts.list(**params) -> SyncCursor[SubAccount]
• client.sub_accounts.deactivate(id) -> SubAccountDeactivateResponse
• client.sub_accounts.get_balance(id) -> SubAccountGetBalanceResponse

APIKeys

Types:

from zavudev.types.sub_accounts import APIKeyCreateResponse, APIKeyListResponse

Methods:

• client.sub_accounts.api_keys.create(id, **params) -> APIKeyCreateResponse
• client.sub_accounts.api_keys.list(id) -> APIKeyListResponse
• client.sub_accounts.api_keys.revoke(key_id, *, id) -> None

Number10dlc

Brands

Types:

from zavudev.types.number_10dlc import (
    TenDlcBrand,
    BrandCreateResponse,
    BrandRetrieveResponse,
    BrandUpdateResponse,
    BrandListUseCasesResponse,
    BrandSubmitResponse,
    BrandSyncStatusResponse,
)

Methods:

• client.number_10dlc.brands.create(**params) -> BrandCreateResponse
• client.number_10dlc.brands.retrieve(brand_id) -> BrandRetrieveResponse
• client.number_10dlc.brands.update(brand_id, **params) -> BrandUpdateResponse
• client.number_10dlc.brands.list(**params) -> SyncCursor[TenDlcBrand]
• client.number_10dlc.brands.delete(brand_id) -> None
• client.number_10dlc.brands.list_use_cases() -> BrandListUseCasesResponse
• client.number_10dlc.brands.submit(brand_id) -> BrandSubmitResponse
• client.number_10dlc.brands.sync_status(brand_id) -> BrandSyncStatusResponse

Campaigns

Types:

from zavudev.types.number_10dlc import (
    TenDlcCampaign,
    CampaignCreateResponse,
    CampaignRetrieveResponse,
    CampaignUpdateResponse,
    CampaignSubmitResponse,
    CampaignSyncStatusResponse,
)

Methods:

• client.number_10dlc.campaigns.create(**params) -> CampaignCreateResponse
• client.number_10dlc.campaigns.retrieve(campaign_id) -> CampaignRetrieveResponse
• client.number_10dlc.campaigns.update(campaign_id, **params) -> CampaignUpdateResponse
• client.number_10dlc.campaigns.list(**params) -> SyncCursor[TenDlcCampaign]
• client.number_10dlc.campaigns.delete(campaign_id) -> None
• client.number_10dlc.campaigns.submit(campaign_id) -> CampaignSubmitResponse
• client.number_10dlc.campaigns.sync_status(campaign_id) -> CampaignSyncStatusResponse

PhoneNumbers

Types:

from zavudev.types.number_10dlc.campaigns import (
    TenDlcPhoneNumberAssignment,
    PhoneNumberListResponse,
    PhoneNumberAssignResponse,
)

Methods:

• client.number_10dlc.campaigns.phone_numbers.list(campaign_id) -> PhoneNumberListResponse
• client.number_10dlc.campaigns.phone_numbers.assign(campaign_id, **params) -> PhoneNumberAssignResponse
• client.number_10dlc.campaigns.phone_numbers.unassign(assignment_id, *, campaign_id) -> None

Me

Types:

from zavudev.types import MeRetrieveResponse

Methods:

• client.me.retrieve() -> MeRetrieveResponse

Functions

Types:

from zavudev.types import (
    FunctionCreateResponse,
    FunctionRetrieveResponse,
    FunctionUpdateResponse,
    FunctionDeleteResponse,
    FunctionDeployResponse,
    FunctionGetDeploymentResponse,
    FunctionListDeploymentsResponse,
    FunctionListEventTypesResponse,
    FunctionRollbackDeploymentResponse,
    FunctionTailLogsResponse,
)

Methods:

• client.functions.create(**params) -> FunctionCreateResponse
• client.functions.retrieve(function_id) -> FunctionRetrieveResponse
• client.functions.update(function_id, **params) -> FunctionUpdateResponse
• client.functions.delete(function_id) -> FunctionDeleteResponse
• client.functions.deploy(function_id, **params) -> FunctionDeployResponse
• client.functions.get_deployment(deployment_id) -> FunctionGetDeploymentResponse
• client.functions.list_deployments(function_id, **params) -> FunctionListDeploymentsResponse
• client.functions.list_event_types() -> FunctionListEventTypesResponse
• client.functions.rollback_deployment(function_id, **params) -> FunctionRollbackDeploymentResponse
• client.functions.tail_logs(function_id, **params) -> FunctionTailLogsResponse

Secrets

Types:

from zavudev.types.functions import SecretListResponse

Methods:

• client.functions.secrets.list(function_id) -> SecretListResponse
• client.functions.secrets.set(key, *, function_id, **params) -> object
• client.functions.secrets.unset(key, *, function_id) -> None

Triggers

Types:

from zavudev.types.functions import (
    TriggerCreateResponse,
    TriggerUpdateResponse,
    TriggerListResponse,
)

Methods:

• client.functions.triggers.create(function_id, **params) -> TriggerCreateResponse
• client.functions.triggers.update(trigger_id, **params) -> TriggerUpdateResponse
• client.functions.triggers.list(function_id) -> TriggerListResponse
• client.functions.triggers.delete(trigger_id) -> None

GitLink

Types:

from zavudev.types.functions import (
    GitLinkRetrieveResponse,
    GitLinkUpdateResponse,
    GitLinkDeployNowResponse,
    GitLinkLinkResponse,
)

Methods:

• client.functions.git_link.retrieve(function_id) -> GitLinkRetrieveResponse
• client.functions.git_link.update(function_id, **params) -> GitLinkUpdateResponse
• client.functions.git_link.deploy_now(function_id) -> GitLinkDeployNowResponse
• client.functions.git_link.link(function_id, **params) -> GitLinkLinkResponse
• client.functions.git_link.unlink(function_id) -> None

Conversations

Types:

from zavudev.types import (
    ConversationRetrieveResponse,
    ConversationListResponse,
    ConversationMarkAsReadResponse,
)

Methods:

• client.conversations.retrieve(conversation_id) -> ConversationRetrieveResponse
• client.conversations.list(**params) -> SyncCursor[ConversationListResponse]
• client.conversations.list_messages(conversation_id, **params) -> SyncCursor[Message]
• client.conversations.mark_as_read(conversation_id) -> ConversationMarkAsReadResponse

Calls

Types:

from zavudev.types import (
    CallCreateResponse,
    CallRetrieveResponse,
    CallListResponse,
    CallHangupResponse,
)

Methods:

• client.calls.create(**params) -> CallCreateResponse
• client.calls.retrieve(call_id) -> CallRetrieveResponse
• client.calls.list(**params) -> SyncCursor[CallListResponse]
• client.calls.hangup(call_id) -> CallHangupResponse

AgentTemplates

Types:

from zavudev.types import AgentTemplateRetrieveResponse, AgentTemplateListResponse

Methods:

• client.agent_templates.retrieve(template_id) -> AgentTemplateRetrieveResponse
• client.agent_templates.list() -> AgentTemplateListResponse

EmailDomains

Types:

from zavudev.types import (
    EmailDomainCreateResponse,
    EmailDomainRetrieveResponse,
    EmailDomainListResponse,
    EmailDomainVerifyResponse,
)

Methods:

• client.email_domains.create(**params) -> EmailDomainCreateResponse
• client.email_domains.retrieve(domain_id) -> EmailDomainRetrieveResponse
• client.email_domains.list() -> EmailDomainListResponse
• client.email_domains.delete(domain_id) -> None
• client.email_domains.verify(domain_id) -> EmailDomainVerifyResponse

Agents

Types:

from zavudev.types import (
    AgentCreateResponse,
    AgentRetrieveResponse,
    AgentUpdateResponse,
    AgentListVoicesResponse,
    AgentTestResponse,
)

Methods:

• client.agents.create(**params) -> AgentCreateResponse
• client.agents.retrieve(agent_id) -> AgentRetrieveResponse
• client.agents.update(agent_id, **params) -> AgentUpdateResponse
• client.agents.list(**params) -> SyncCursor[Agent]
• client.agents.delete(agent_id) -> None
• client.agents.list_voices(**params) -> AgentListVoicesResponse
• client.agents.test(agent_id, **params) -> AgentTestResponse

Senders

Types:

from zavudev.types.agents import SenderConnectResponse

Methods:

• client.agents.senders.connect(agent_id, **params) -> SenderConnectResponse
• client.agents.senders.disconnect(sender_id, *, agent_id) -> None