Class MessagingResource

Messaging / chat. Live feeds are NDJSON-over-HTTP streams exposed as async iterators (backlog first, then live updates); sends are plain POSTs.

Index

Constructors

Methods

markRead reply send streamConversations streamMessages

Constructors

constructor

new MessagingResource(http: HttpClient): MessagingResource
Parameters
- http: HttpClient
Returns MessagingResource
- Defined in src/resources/messaging.ts:52

Methods

markRead

markRead(conversationId: string, offset: number): Promise<void>
Mark the conversation read up to (and including) offset.
Parameters
- conversationId: string
- offset: number
Returns Promise<void>
- Defined in src/resources/messaging.ts:106

reply

reply(
options: ReplyOptions,
): Promise<{ message: string; publicAccountId: string }>
Start a conversation by replying to a listing. Does NOT return a conversation id — discover the new conversation via streamConversations.
Parameters
- options: ReplyOptions
Returns Promise<{ message: string; publicAccountId: string }>
- Defined in src/resources/messaging.ts:120

send

send(conversationId: string, text: string): Promise<Message>
Send a text message. Returns the created message (with server offset).
Parameters
- conversationId: string
- text: string
Returns Promise<Message>
- Defined in src/resources/messaging.ts:97

streamConversations

streamConversations(options?: StreamOptions): AsyncGenerator<Conversation>
Live stream of conversations. Yields a full conversation object on every change (initial backlog, then updates). Maintain your own map keyed by conversation.id. Runs until the signal aborts or the server closes.
Parameters
- options: StreamOptions = {}
Returns AsyncGenerator<Conversation>
- Defined in src/resources/messaging.ts:59

streamMessages

streamMessages(
conversationId: string,
options?: StreamOptions & { offset?: number },
): AsyncGenerator<Message>
Live stream of messages in a conversation. Yields backlog (from offset, ordered by offset) then new messages as they arrive.
Parameters
- conversationId: string
- options: StreamOptions & { offset?: number } = {}
Returns AsyncGenerator<Message>
- Defined in src/resources/messaging.ts:80