Page methods: update, delete

Reference for Page, one group of Page methods.

Page.update

Changes the given properties of a Page. Verb page.

TypeScript

interface PageVerbs {
  update(input: PageUpdateInput, options?: SB.CallOptions): SB.Call<Page>
}

Emits Page.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Page.
`path`	`string`		The path under its Site, such as `/pricing`.
`kind`	`string`		The page type, such as `landing`, `pricing`, or `terms`.
`from`	`string`		Lineage: the slot it compiles from, as `Hypothesis#<slot>@v<version>`.

Returns

Output	Type	Required	Description
`page`	Page	required	The Page.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

TypeScript

import { $ } from 'startup-builder'

const page = await $.Page.update({ id: 'page_A8w9CXatRR', path: '/' })

Deletes a Page: a soft delete that keeps its history, undone by Thing.restore. Verb page.

TypeScript

interface PageVerbs {
  delete(input: PageDeleteInput, options?: SB.CallOptions): SB.Call<Page>
}

Emits Page.deleted.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Page.

Returns

Output	Type	Required	Description
`page`	Page	required	The Page.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

TypeScript

import { $ } from 'startup-builder'

const page = await $.Page.delete({ id: 'page_A8w9CXatRR' })