Story methods: create, get, list
The Story Verbs create, get, list as typed SDK methods, with inputs, result, refusals and an example.
Reference for Story, one group of Story methods.
Story.create
Creates a Story. Verb page.
interface StoryVerbs {
create(input: StoryCreateInput, options?: SB.CallOptions): SB.Call<Story>
}Emits Story.created.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
icp | ICP | required | The ICP it speaks to: one Story per ICP. |
hero | text | required | Who the customer is and what they want. |
problem | Problem | required | 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 | required | 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. | |
hypothesis | Hypothesis | The Founding Hypothesis whose slots the Story compiles from; a pivot recompiles 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
import { $ } from 'startup-builder'
const story = await $.Story.create({ icp: 'icp_EwhsJU4AOW', hero: 'Example hero', problem: 'problem_UzvXXfKsJB', from: 'Hypothesis#approach@v1' })Story.get
Returns one Story by id. Verb page.
interface StoryVerbs {
get(input: StoryGetInput, options?: SB.CallOptions): SB.Call<Story>
}Reads only: it emits no Event.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Story. |
at | string | A time or Version name: the record as it stood then. Unset: as it stands now. |
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
import { $ } from 'startup-builder'
const story = await $.Story.get({ id: 'story_ujkz1xjvrp' })Story.list
Returns Stories, newest first, one page at a time. Verb page.
interface StoryVerbs {
list(input?: StoryListInput, options?: SB.CallOptions): SB.ListCall<Story>
}Reads only: it emits no Event.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
limit | integer | At most this many records, up to 100. The default is 20. | |
after | string | The cursor from the previous page. | |
where | string | A filter over the properties, such as paidAt = null and total.amount > 500. | |
sort | string | Properties to sort by, comma-separated; a leading minus sorts descending. | |
total | boolean | True adds the match count as meta.total, exact up to 10,000 matches and estimated above. | |
facets | string | Properties to count by value, comma-separated, returned as meta.facets. | |
fields | string | Properties to return on each record, comma-separated; $id and $type always return. | |
include | string | Related records to embed in place of their URLs, comma-separated. | |
depth | integer | How many levels of related records to embed. The default is 1. | |
q | string | Words to match across the text properties, ranked by relevance. | |
match | string | Ranks the search by words, or meaning; words is the default. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
stories | list of Story | required | One page of Stories. |
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
import { $ } from 'startup-builder'
const stories = await $.Story.list({ limit: 20 })