Startup methods: create, get, list

Reference for Startup, one group of Startup methods.

Startup.create

Creates a Startup. Verb page.

TypeScript

interface StartupVerbs {
  create(input: StartupCreateInput, options?: SB.CallOptions): SB.Call<Startup>
}

Emits Startup.created.

Inputs

Input	Type	Required	Description
`name`	`string`	required	The name the Startup trades under.
`domain`	`url`		The canonical hostname of the Startup.
`launchedAt`	`datetime`		When the Startup went live.
`template`	`string`		The slug of the template it extends; the root one when none is named.
`idea`	`text`		The Idea it starts from, in a sentence, recorded as its Idea.
`spendState`	`string`		How freely money Limits allow spend: `free`, `tight` (discretionary Limits halved) or `hold` (one-way spend stops).
`studio`	Studio		A Studio founds and builds its Startups and runs Plays across them.
`company`	Company		The holding Company is the Startup’s owner of record: it signs its Agreements and owns its profit rights.

Returns

Output	Type	Required	Description
`startup`	Startup	required	The Startup.

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 startup = await $.Startup.create({ name: 'Leaseline' })

Returns one Startup by id. Verb page.

TypeScript

interface StartupVerbs {
  get(input: StartupGetInput, options?: SB.CallOptions): SB.Call<Startup>
}

Reads only: it emits no Event.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Startup.
`at`	`string`		A time or Version name: the record as it stood then. Unset: as it stands now.

Returns

Output	Type	Required	Description
`startup`	Startup	required	The Startup.

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 startup = await $.Startup.get({ id: 'startup_l3hr1EnUGY' })

Returns Startups, newest first, one page at a time. Verb page.

TypeScript

interface StartupVerbs {
  list(input?: StartupListInput, options?: SB.CallOptions): SB.ListCall<Startup>
}

Reads only: it emits no Event.

Inputs

Input	Type	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
`startups`	list of Startup	required	One page of Startups.

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 startups = await $.Startup.list({ limit: 20 })