Story methods: update, delete

Reference for Story, one group of Story methods.

Story.update

Changes the given properties of a Story. Verb page.

TypeScript

interface StoryVerbs {
  update(input: StoryUpdateInput, options?: SB.CallOptions): SB.Call<Story>
}

Emits Story.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Story.
`icp`	ICP		The ICP it speaks to: one Story per ICP.
`hero`	`text`		Who the customer is and what they want.
`problem`	Problem		The Problem: external, internal, and the villain behind it.
`guide`	`text`		The Startup’s empathy and authority, the authority read from Metrics and Evidence.
`plan`	`text`		Three steps, each naming a declared Event.
`success`	`text`		What the customer gains.
`failure`	`text`		What the customer risks without it.
`oneLiner`	`string`		The Story in one sentence.
`direct`	Offer		The direct call to action: an Offer that makes a Customer.
`transitional`	Funnel		The transitional call to action: a Funnel opt-in that makes a Lead.
`from`	`string`		Lineage: the slot it compiles from, as `Hypothesis#<slot>@v<version>`.
`stance`	`string`		The positioning the Positioning tournament chose, graded Behavior; every compiled asset recompiles when it changes.
`category`	`string`		The market category name the Story claims, as answer engines repeat it.

Returns

Output	Type	Required	Description
`story`	Story	required	The Story.

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 story = await $.Story.update({ id: 'story_ujkz1xjvrp', icp: 'icp_EwhsJU4AOW' })

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

TypeScript

interface StoryVerbs {
  delete(input: StoryDeleteInput, options?: SB.CallOptions): SB.Call<Story>
}

Emits Story.deleted.

Inputs

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

Returns

Output	Type	Required	Description
`story`	Story	required	The Story.

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 story = await $.Story.delete({ id: 'story_ujkz1xjvrp' })