Startup Template methods: create, get, list
The Startup Template Verbs create, get, list as typed SDK methods, with inputs, result, refusals and an example.
Reference for Startup Template, one group of Startup Template methods.
StartupTemplate.create
Creates a Startup Template. Verb page.
interface StartupTemplateVerbs {
create(input: StartupTemplateCreateInput, options?: SB.CallOptions): SB.Call<StartupTemplate>
}Emits StartupTemplate.created.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
slug | string | required | The argument to create --template and the page path under /. |
operatingModel | string | required | The human and Agent mix: autonomous, single-human, or multi-human. |
motions | string[] | required | The Motions its Offers sell through, such as b2b or b2a. |
extends | Startup Template | The base Startup Template whose Product Templates, Systems, Processes, and Roles it inherits. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
startupTemplate | Startup Template | required | The Startup Template. |
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 startupTemplate = await $.StartupTemplate.create({ slug: 'leaseline', operatingModel: 'autonomous', motions: ['Example motions'] })StartupTemplate.get
Returns one Startup Template by id. Verb page.
interface StartupTemplateVerbs {
get(input: StartupTemplateGetInput, options?: SB.CallOptions): SB.Call<StartupTemplate>
}Reads only: it emits no Event.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Startup Template. |
at | string | A time or Version name: the record as it stood then. Unset: as it stands now. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
startupTemplate | Startup Template | required | The Startup Template. |
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 startupTemplate = await $.StartupTemplate.get({ id: 'stpl_9OivLWR17L' })StartupTemplate.list
Returns Startup Templates, newest first, one page at a time. Verb page.
interface StartupTemplateVerbs {
list(input?: StartupTemplateListInput, options?: SB.CallOptions): SB.ListCall<StartupTemplate>
}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 |
|---|---|---|---|
startupTemplates | list of Startup Template | required | One page of Startup Templates. |
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 startupTemplates = await $.StartupTemplate.list({ limit: 20 })