client.changesOperation methods
Parameter declarations below are taken from the pinned TypeScript source. Request fields and responses are summarized from the matching OpenAPI operation; follow the API link for every field, constraint, example, and error description.
/changeschanges.list
Returns metadata-only, cell-local changes at a fixed page watermark. The opaque cursor is bound to the credential, workspace, cell, epoch, and exact filter set. A 410 response requires a new checkpoint and full resource snapshot.
client.changes.list(options?: ChangeListOptions)- Return form
Promise- Operation ID
listChanges- Required scopes
changes:read- SDK parameters
options: ChangeListOptions- Query request fields
cursor?: stringlimit?: integeroperations?: Array<string>resourceTypes?: Array<string>startAtLatest?: boolean- Success
200 Array<ChangeEvent> envelope
Convenience helpers
These typed helpers compose mapped operations. They do not grant scopes or bypass API limits.
changes.checkpoint
Capture an opaque, credential- and filter-bound change-feed checkpoint.
client.changes.checkpoint(options?: ChangeFilterOptions)Promisechanges.pages
Iterate cursor pages with a bounded PaginationOptions policy.
client.changes.pages(options?: ChangeCatchUpOptions, pagination?: PaginationOptions)AsyncGeneratorchanges.snapshotThenCatchUp
Take a checkpoint, run a caller-owned snapshot, and expose bounded catch-up pages.
client.changes.snapshotThenCatchUp(snapshot: (checkpoint: ChangeCheckpoint) => Promise<T>, options?: ChangeFilterOptions, pagination?: PaginationOptions)PromiseErrors and transport metadata
HTTP failures reject with TeamGridApiError, including the status, stable error documents, request ID, optional retry delay, and transport metadata. Local validation, routing, timeout, response-size, and pagination failures reject withTeamGridClientError and a stable client error code. Successful envelopes expose non-enumerable transport metadata.
See pagination and errors andclient configuration for handling guidance.