@kentcdodds/x

X API v2 helpers for tweets, search, legacy DMs, and encrypted X Chat via a Fly XDK sidecar.

src/list-dm-events.ts

19 lines · 802 B · TypeScript

import { listDmEvents } from './client.ts'
import type { XListDmEventsParams } from './client.ts'

/**
 * List recent DM events across all of the account's conversations.
 * OAuth user-context only; requires the dm.read scope.
 *
 * Limitation: this hits legacy `/dm_events`. Encrypted X Chat plaintext is
 * available from `list-chat-conversations` / `get-chat-conversation`.
 *
 * @returns Shaped DM events for GET /dm_events.
 * @example
 * import listDmEvents from 'kody:@kentcdodds/x/list-dm-events'
 * const events = await listDmEvents({ maxResults: 5 })
 * // => { data: [{ id: '...', event_type: 'MessageCreate', text: '...', sender_id: '...' }], meta: { ... } }
 */
export default async function listDmEventsEntrypoint(params: XListDmEventsParams = {}) {
  return await listDmEvents(params)
}