@riposte.co/api-types

Overview

The @riposte.co/api-types package publishes lightweight TypeScript definitions for every response and schema in the Riposte OpenAPI document. The types are regenerated from the SDK’s operations map so they always stay in sync with the server without shipping any HTTP clients.【F:product/api-types/README.md†L1-L30】

Import the shapes you need directly from the package—index.ts re-exports the entire generated surface so tree-shaking works as expected.【F:product/api-types/src/index.ts†L1-L1】

import type {
  Thread,
  ThreadListResponse,
  CalendarEvent,
  CalendarEventListResponse,
  Pagination,
} from '@riposte.co/api-types';

【F:product/api-types/README.md†L8-L19】

Account and thread models

AccountListResponse

AccountListResponse represents the payload returned by GET /accounts, including pagination metadata and optional Gmail token details for each account.【F:product/api-types/src/generated.ts†L4-L35】

Account

Use Account when you need the canonical shape for a specific Riposte-managed account record, including provider, pause status, and token summary.【F:product/api-types/src/generated.ts†L38-L54】

ThreadListResponse, ThreadSummary, Thread, ThreadMessage

Thread-centric types cover list responses, high-level thread summaries, expanded threads with nested messages, and the normalized message metadata for each entry.【F:product/api-types/src/generated.ts†L56-L128】

Pagination

Many list responses reuse the Pagination helper for consistent cursor and page-based navigation fields.【F:product/api-types/src/generated.ts†L203-L217】

Messaging payloads

MessageListResponse

MessageListResponse contains message metadata, provider identifiers, label assignments, and pagination information returned by GET /accounts/{accountId}/messages.【F:product/api-types/src/generated.ts†L130-L201】

Calendar data structures

CalendarEventListResponse

Riposte normalizes provider-specific calendar events using CalendarEventListResponse, which includes attendees, organizer details, per-event status, and standard pagination fields.【F:product/api-types/src/generated.ts†L220-L274】

CalendarEvent

CalendarEvent captures the individual event representation with start/end values, location, participants, and provider metadata.【F:product/api-types/src/generated.ts†L276-L315】

Webhook schemas

Webhook endpoint collections

Webhook helper types describe endpoint inventory, configuration, and delivery results so you can type webhook management flows without importing the SDK runtime.【F:product/api-types/src/generated.ts†L1961-L1999】

API response lookup

For advanced cases you can inspect the ApiResponse mapped type that lists the 200-level response for every endpoint and HTTP method. This is useful when you want to infer return values dynamically based on a path/method pair.【F:product/api-types/src/generated.ts†L317-L360】