planning-center-monorepo v1.0.0

planning-center-monorepo / planning-center-people-ts/src / NoteListOptions

Interface: NoteListOptions

Defined in: packages/planning-center-people-ts/src/types/api-options.ts:261 

Strictly typed options for Note getAll() - no pagination options

Extended by

• NotePageOptions

Properties

where?

optional where: NoteWhereClause

Defined in: packages/planning-center-people-ts/src/types/api-options.ts:263 

Filter by specific fields

include?

optional include: NoteInclude[]

Defined in: packages/planning-center-people-ts/src/types/api-options.ts:265 

Include related resources

order?

optional order: "-created_at" | "-updated_at" | NoteOrderField | "-id" | "-note" | "-note_category_id" | "-display_date"

Defined in: packages/planning-center-people-ts/src/types/api-options.ts:267 

Order by field (prefix with ’-’ for descending)