api.md

BeeperDesktop

Types:

• FocusResponse
• SearchResponse

Methods:

• client.focus({ ...params }) -> FocusResponse
• client.search({ ...params }) -> SearchResponse

Shared

Types:

• APIError
• AppStateSnapshot
• Attachment
• AttachmentCapabilities
• ChatCapabilities
• ChatDraft
• ChatStateCapabilities
• DraftAttachment
• Error
• LinkPreview
• Message
• Reaction
• SendStatus
• User

Accounts

Types:

• Account
• AccountBridge
• AccountRetrieveResponse
• AccountListResponse

Methods:

• client.accounts.retrieve(accountID) -> AccountRetrieveResponse
• client.accounts.list() -> AccountListResponse

Contacts

Types:

• ContactSearchResponse

Methods:

• client.accounts.contacts.list(accountID, { ...params }) -> UsersCursorSearch
• client.accounts.contacts.search(accountID, { ...params }) -> ContactSearchResponse

Bridges

Types:

• Bridge
• BridgeLogin
• CookieField
• DisappearingTimerCapability
• GroupFieldCapability
• GroupTypeCapabilities
• LoginFlow
• LoginInputField
• LoginSession
• ProvisioningCapabilities
• ResolveIdentifierCapabilities
• BridgeRetrieveResponse
• BridgeListResponse

Methods:

• client.bridges.retrieve(bridgeID) -> BridgeRetrieveResponse
• client.bridges.list() -> BridgeListResponse
• client.bridges.retrieveCapabilities(bridgeID) -> ProvisioningCapabilities

LoginFlows

Types:

• LoginFlowListResponse

Methods:

• client.bridges.loginFlows.list(bridgeID) -> LoginFlowListResponse

Logins

Types:

• LoginListResponse
• LoginRemoveResponse

Methods:

• client.bridges.logins.retrieve(loginID, { ...params }) -> BridgeLogin
• client.bridges.logins.list(bridgeID) -> LoginListResponse
• client.bridges.logins.remove(loginID, { ...params }) -> LoginRemoveResponse

LoginSessions

Types:

• LoginSessionCancelResponse

Methods:

• client.bridges.loginSessions.create(bridgeID, { ...params }) -> LoginSession
• client.bridges.loginSessions.retrieve(loginSessionID, { ...params }) -> LoginSession
• client.bridges.loginSessions.cancel(loginSessionID, { ...params }) -> LoginSessionCancelResponse

Steps

Methods:

• client.bridges.loginSessions.steps.submit(stepID, { ...params }) -> LoginSession

Chats

Types:

• Chat
• ChatCreateResponse
• ChatListResponse
• ChatStartResponse

Methods:

• client.chats.create({ ...params }) -> ChatCreateResponse
• client.chats.retrieve(chatID, { ...params }) -> Chat
• client.chats.update(chatID, { ...params }) -> Chat
• client.chats.list({ ...params }) -> ChatListResponsesCursorNoLimit
• client.chats.archive(chatID, { ...params }) -> void
• client.chats.markRead(chatID, { ...params }) -> Chat
• client.chats.markUnread(chatID, { ...params }) -> Chat
• client.chats.notifyAnyway(chatID) -> Chat
• client.chats.search({ ...params }) -> ChatsCursorSearch
• client.chats.start({ ...params }) -> ChatStartResponse

Reminders

Methods:

• client.chats.reminders.create(chatID, { ...params }) -> void
• client.chats.reminders.delete(chatID) -> void

Messages

Reactions

Types:

• ReactionDeleteResponse
• ReactionAddResponse

Methods:

• client.chats.messages.reactions.delete(reactionKey, { ...params }) -> ReactionDeleteResponse
• client.chats.messages.reactions.add(messageID, { ...params }) -> ReactionAddResponse

Labels

Types:

• Label
• LabelListResponse

Methods:

• client.labels.list() -> LabelListResponse

Messages

Types:

• MessageUpdateResponse
• MessageSendResponse

Methods:

• client.messages.retrieve(messageID, { ...params }) -> Message
• client.messages.update(messageID, { ...params }) -> MessageUpdateResponse
• client.messages.list(chatID, { ...params }) -> MessagesCursorNoLimit
• client.messages.delete(messageID, { ...params }) -> void
• client.messages.search({ ...params }) -> MessagesCursorSearch
• client.messages.send(chatID, { ...params }) -> MessageSendResponse

Assets

Types:

• AssetDownloadResponse
• AssetUploadResponse
• AssetUploadBase64Response

Methods:

• client.assets.download({ ...params }) -> AssetDownloadResponse
• client.assets.serve({ ...params }) -> Response
• client.assets.upload({ ...params }) -> AssetUploadResponse
• client.assets.uploadBase64({ ...params }) -> AssetUploadBase64Response

Info

Types:

• InfoRetrieveResponse

Methods:

• client.info.retrieve() -> InfoRetrieveResponse

App

Types:

• RecoveryKeyResetResponse
• SetupCompleteResponse
• SetupRegistrationRequiredResponse
• SetupResponseOutput
• SetupStateResponse
• Verification
• VerificationResponse

Setup

Types:

• SetupRetrieveResponse
• SetupRegisterResponse
• SetupResponseResponse
• SetupStartResponse

Methods:

• client.app.setup.retrieve() -> SetupRetrieveResponse
• client.app.setup.email({ ...params }) -> void
• client.app.setup.register({ ...params }) -> SetupRegisterResponse
• client.app.setup.response({ ...params }) -> SetupResponseResponse
• client.app.setup.start() -> SetupStartResponse

RecoveryKey

Types:

• RecoveryKeyVerifyResponse

Methods:

• client.app.setup.recoveryKey.verify({ ...params }) -> RecoveryKeyVerifyResponse

Reset

Types:

• ResetCreateResponse
• ResetConfirmResponse

Methods:

• client.app.setup.recoveryKey.reset.create({ ...params }) -> ResetCreateResponse
• client.app.setup.recoveryKey.reset.confirm({ ...params }) -> ResetConfirmResponse

Verifications

Types:

• VerificationCreateResponse
• VerificationRetrieveResponse
• VerificationListResponse
• VerificationAcceptResponse
• VerificationCancelResponse

Methods:

• client.app.setup.verifications.create({ ...params }) -> VerificationCreateResponse
• client.app.setup.verifications.retrieve(verificationID) -> VerificationRetrieveResponse
• client.app.setup.verifications.list() -> VerificationListResponse
• client.app.setup.verifications.accept(verificationID) -> VerificationAcceptResponse
• client.app.setup.verifications.cancel(verificationID, { ...params }) -> VerificationCancelResponse

QR

Types:

• QRConfirmScannedResponse
• QRScanResponse

Methods:

• client.app.setup.verifications.qr.confirmScanned(verificationID) -> QRConfirmScannedResponse
• client.app.setup.verifications.qr.scan({ ...params }) -> QRScanResponse

SAS

Types:

• SASConfirmResponse
• SASStartResponse

Methods:

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