planning-center-monorepo v1.0.0

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

Interface: NotePageOptions

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

Strictly typed options for Note getPage() - includes pagination

Extends

• NoteListOptions

Properties

where?

optional where: NoteWhereClause

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

Filter by specific fields

Inherited from

NoteListOptions.where

include?

optional include: NoteInclude[]

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

Include related resources

Inherited from

NoteListOptions.include

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)

Inherited from

NoteListOptions.order

perPage?

optional perPage: number

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

Items per page (1-100, default: 25)

page?

optional page: number

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

Page number