Class Pages

Pages resource handler

Index

Constructors

Methods

count create delete get getAnalytics getAuthor getByHandle list publish search unpublish update

Constructors

constructor

new Pages(client): Pages
Parameters
- client: SapoClient
Returns Pages
- Defined in resources/pages.ts:18

Methods

count

count(params?): Promise<number>
Get total page count
Parameters
- Optional params: Partial<PageListParams>
  Filter parameters
Returns Promise<number>
- Defined in resources/pages.ts:72

create

create(data): Promise<Page>
Create a new page
Parameters
- data: CreatePageData
  Page creation data
Returns Promise<Page>
- Defined in resources/pages.ts:41

delete

delete(id): Promise<void>
Delete a page
Parameters
- id: number
  Page ID
Returns Promise<void>
- Defined in resources/pages.ts:64

get

get(id): Promise<Page>
Get a single page by ID
Parameters
- id: number
  Page ID
Returns Promise<Page>
- Defined in resources/pages.ts:32

getAnalytics

getAnalytics(id, startDate, endDate): Promise<PageAnalytics>
Get page analytics
Parameters
- id: number
  Page ID
- startDate: string
  Start date (YYYY-MM-DD)
- endDate: string
  End date (YYYY-MM-DD)
Returns Promise<PageAnalytics>
- Defined in resources/pages.ts:111

getAuthor

getAuthor(id): Promise<null | PageAuthor>
Get page author details
Parameters
- id: number
  Page ID
Returns Promise<null | PageAuthor>
- Defined in resources/pages.ts:127

getByHandle

getByHandle(handle): Promise<null | Page>
Get page by handle
Parameters
- handle: string
  Page handle
Returns Promise<null | Page>
- Defined in resources/pages.ts:90

list

list(params?): Promise<PaginatedResponse<Page>>
Get a list of pages
Parameters
- Optional params: PageListParams
  Query parameters for filtering and pagination
Returns Promise<PaginatedResponse<Page>>
- Defined in resources/pages.ts:24

publish

publish(id): Promise<Page>
Publish a page
Parameters
- id: number
  Page ID
Returns Promise<Page>
- Defined in resources/pages.ts:145

search

search(params): Promise<Page[]>
Search pages
Parameters
- params: PageSearchParams
  Search parameters
Returns Promise<Page[]>
- Defined in resources/pages.ts:81

unpublish

unpublish(id): Promise<Page>
Unpublish a page
Parameters
- id: number
  Page ID
Returns Promise<Page>
- Defined in resources/pages.ts:154

update

update(id, data): Promise<Page>
Update an existing page
Parameters
- id: number
  Page ID
- data: Partial<CreatePageData>
  Page update data
Returns Promise<Page>
- Defined in resources/pages.ts:53