Shared Types

from beeper_desktop_api.types import (
    APIError,
    AppStateSnapshot,
    Attachment,
    AttachmentCapabilities,
    ChatCapabilities,
    ChatDraft,
    ChatStateCapabilities,
    DraftAttachment,
    Error,
    LinkPreview,
    Message,
    Reaction,
    SendStatus,
    User,
)

BeeperDesktop

Types:

from beeper_desktop_api.types import FocusResponse, SearchResponse

Methods:

client.focus(**params) -> FocusResponse
client.search(**params) -> SearchResponse

Accounts

Types:

from beeper_desktop_api.types import (
    Account,
    AccountBridge,
    AccountRetrieveResponse,
    AccountListResponse,
)

Methods:

client.accounts.retrieve(account_id) -> AccountRetrieveResponse
client.accounts.list() -> AccountListResponse

Contacts

Types:

from beeper_desktop_api.types.accounts import ContactSearchResponse

Methods:

client.accounts.contacts.list(account_id, **params) -> SyncCursorSearch[User]
client.accounts.contacts.search(account_id, **params) -> ContactSearchResponse

Bridges

Types:

from beeper_desktop_api.types import (
    Bridge,
    BridgeLogin,
    CookieField,
    DisappearingTimerCapability,
    GroupFieldCapability,
    GroupTypeCapabilities,
    LoginFlow,
    LoginInputField,
    LoginSession,
    ProvisioningCapabilities,
    ResolveIdentifierCapabilities,
    BridgeRetrieveResponse,
    BridgeListResponse,
)

Methods:

client.bridges.retrieve(bridge_id) -> BridgeRetrieveResponse
client.bridges.list() -> BridgeListResponse
client.bridges.retrieve_capabilities(bridge_id) -> ProvisioningCapabilities

LoginFlows

Types:

from beeper_desktop_api.types.bridges import LoginFlowListResponse

Methods:

client.bridges.login_flows.list(bridge_id) -> LoginFlowListResponse

Logins

Types:

from beeper_desktop_api.types.bridges import LoginListResponse, LoginRemoveResponse

Methods:

client.bridges.logins.retrieve(login_id, *, bridge_id) -> BridgeLogin
client.bridges.logins.list(bridge_id) -> LoginListResponse
client.bridges.logins.remove(login_id, *, bridge_id, **params) -> LoginRemoveResponse

LoginSessions

Types:

from beeper_desktop_api.types.bridges import LoginSessionCancelResponse

Methods:

client.bridges.login_sessions.create(bridge_id, **params) -> LoginSession
client.bridges.login_sessions.retrieve(login_session_id, *, bridge_id) -> LoginSession
client.bridges.login_sessions.cancel(login_session_id, *, bridge_id) -> LoginSessionCancelResponse

Steps

Methods:

client.bridges.login_sessions.steps.submit(step_id, *, bridge_id, login_session_id, **params) -> LoginSession

Chats

Types:

from beeper_desktop_api.types import Chat, ChatCreateResponse, ChatListResponse, ChatStartResponse

Methods:

client.chats.create(**params) -> ChatCreateResponse
client.chats.retrieve(chat_id, **params) -> Chat
client.chats.update(chat_id, **params) -> Chat
client.chats.list(**params) -> SyncCursorNoLimit[ChatListResponse]
client.chats.archive(chat_id, **params) -> None
client.chats.mark_read(chat_id, **params) -> Chat
client.chats.mark_unread(chat_id, **params) -> Chat
client.chats.notify_anyway(chat_id) -> Chat
client.chats.search(**params) -> SyncCursorSearch[Chat]
client.chats.start(**params) -> ChatStartResponse

Reminders

Methods:

client.chats.reminders.create(chat_id, **params) -> None
client.chats.reminders.delete(chat_id) -> None

Messages

Reactions

Types:

from beeper_desktop_api.types.chats.messages import ReactionDeleteResponse, ReactionAddResponse

Methods:

client.chats.messages.reactions.delete(reaction_key, *, chat_id, message_id) -> ReactionDeleteResponse
client.chats.messages.reactions.add(message_id, *, chat_id, **params) -> ReactionAddResponse

Labels

Types:

from beeper_desktop_api.types import Label, LabelListResponse

Methods:

client.labels.list() -> LabelListResponse

Messages

Types:

from beeper_desktop_api.types import MessageUpdateResponse, MessageSendResponse

Methods:

client.messages.retrieve(message_id, *, chat_id) -> Message
client.messages.update(message_id, *, chat_id, **params) -> MessageUpdateResponse
client.messages.list(chat_id, **params) -> SyncCursorNoLimit[Message]
client.messages.delete(message_id, *, chat_id, **params) -> None
client.messages.search(**params) -> SyncCursorSearch[Message]
client.messages.send(chat_id, **params) -> MessageSendResponse

Assets

Types:

from beeper_desktop_api.types import (
    AssetDownloadResponse,
    AssetUploadResponse,
    AssetUploadBase64Response,
)

Methods:

client.assets.download(**params) -> AssetDownloadResponse
client.assets.serve(**params) -> BinaryAPIResponse
client.assets.upload(**params) -> AssetUploadResponse
client.assets.upload_base64(**params) -> AssetUploadBase64Response

Info

Types:

from beeper_desktop_api.types import InfoRetrieveResponse

Methods:

client.info.retrieve() -> InfoRetrieveResponse

App

Types:

from beeper_desktop_api.types import (
    RecoveryKeyResetResponse,
    SetupCompleteResponse,
    SetupRegistrationRequiredResponse,
    SetupResponseOutput,
    SetupStateResponse,
    Verification,
    VerificationResponse,
)

Setup

Types:

from beeper_desktop_api.types.app import (
    SetupRetrieveResponse,
    SetupRegisterResponse,
    SetupResponseResponse,
    SetupStartResponse,
)

Methods:

client.app.setup.retrieve() -> SetupRetrieveResponse
client.app.setup.email(**params) -> None
client.app.setup.register(**params) -> SetupRegisterResponse
client.app.setup.response(**params) -> SetupResponseResponse
client.app.setup.start() -> SetupStartResponse

RecoveryKey

Types:

from beeper_desktop_api.types.app.setup import RecoveryKeyVerifyResponse

Methods:

client.app.setup.recovery_key.verify(**params) -> RecoveryKeyVerifyResponse

Reset

Types:

from beeper_desktop_api.types.app.setup.recovery_key import (
    ResetCreateResponse,
    ResetConfirmResponse,
)

Methods:

client.app.setup.recovery_key.reset.create(**params) -> ResetCreateResponse
client.app.setup.recovery_key.reset.confirm(**params) -> ResetConfirmResponse

Verifications

Types:

from beeper_desktop_api.types.app.setup import (
    VerificationCreateResponse,
    VerificationRetrieveResponse,
    VerificationListResponse,
    VerificationAcceptResponse,
    VerificationCancelResponse,
)

Methods:

client.app.setup.verifications.create(**params) -> VerificationCreateResponse
client.app.setup.verifications.retrieve(verification_id) -> VerificationRetrieveResponse
client.app.setup.verifications.list() -> VerificationListResponse
client.app.setup.verifications.accept(verification_id) -> VerificationAcceptResponse
client.app.setup.verifications.cancel(verification_id, **params) -> VerificationCancelResponse

QR

Types:

from beeper_desktop_api.types.app.setup.verifications import (
    QRConfirmScannedResponse,
    QRScanResponse,
)

Methods:

client.app.setup.verifications.qr.confirm_scanned(verification_id) -> QRConfirmScannedResponse
client.app.setup.verifications.qr.scan(**params) -> QRScanResponse

SAS

Types:

from beeper_desktop_api.types.app.setup.verifications import SASConfirmResponse, SASStartResponse

Methods:

client.app.setup.verifications.sas.confirm(verification_id) -> SASConfirmResponse
client.app.setup.verifications.sas.start(verification_id) -> SASStartResponse

GeezerVison

Expand file tree

api.md

Latest commit

History

api.md

File metadata and controls

Shared Types

BeeperDesktop

Accounts

Contacts

Bridges

LoginFlows

Logins

LoginSessions

Steps

Chats

Reminders

Messages

Reactions

Labels

Messages

Assets

Info

App

Setup

RecoveryKey

Reset

Verifications

QR

SAS