api.md

BeeperDesktop

Types:

• FocusResponse
• SearchResponse

Methods:

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

Shared

Types:

• Attachment
• Error
• Message
• Reaction
• User

Accounts

Types:

• Account
• AccountListResponse

Methods:

• client.accounts.list() -> AccountListResponse

Contacts

Types:

• ContactSearchResponse

Methods:

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

Chats

Types:

• Chat
• ChatCreateResponse
• ChatListResponse

Methods:

• client.chats.create({ ...params }) -> ChatCreateResponse
• client.chats.retrieve(chatID, { ...params }) -> Chat
• client.chats.list({ ...params }) -> ChatListResponsesCursorNoLimit
• client.chats.archive(chatID, { ...params }) -> void
• client.chats.search({ ...params }) -> ChatsCursorSearch

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(messageID, { ...params }) -> ReactionDeleteResponse
• client.chats.messages.reactions.add(messageID, { ...params }) -> ReactionAddResponse

Messages

Types:

• MessageUpdateResponse
• MessageSendResponse

Methods:

• client.messages.update(messageID, { ...params }) -> MessageUpdateResponse
• client.messages.list(chatID, { ...params }) -> MessagesCursorSortKey
• 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 }) -> void
• client.assets.upload({ ...params }) -> AssetUploadResponse
• client.assets.uploadBase64({ ...params }) -> AssetUploadBase64Response

Info

Types:

• InfoRetrieveResponse

Methods:

• client.info.retrieve() -> InfoRetrieveResponse