Template methods: extend, promote, upgrade
The Template Verbs extend, promote, upgrade as typed SDK methods, with inputs, result, refusals and an example.
Reference for Template, one group of Template methods.
Template.extend
Extend adds a Template to a Startup’s bases, pinned to a Version, so the Startup inherits its definition. Verb page.
interface TemplateVerbs {
extend(input: TemplateExtendInput, options?: SB.CallOptions): SB.Call<TemplateExtendOutput>
}Emits Template.extended.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
template | Template | required | The Template to inherit. |
startup | Startup | required | The Startup that extends it. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
startup | Startup | required | The Startup with the Template among its bases. |
template | Template | required | The Template extended. |
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. |
| The record is not in a state that allows this Verb, so the call is refused. | refused | Read the record, run the Verb that moves it to an allowed state, then retry. | None. |
| A clash between two bases until the Startup settles it | refused | Clear what the check names, then call it again. | None. |
Example
import { $ } from 'startup-builder'
const { startup, template } = await $.Template.extend({ template: 'template_THRQF1h9uX', startup: 'startup_l3hr1EnUGY' })Template.promote
Promote moves one Startup’s refinement into a Template, so every Startup that extends the Template inherits it. Verb page.
interface TemplateVerbs {
promote(input: TemplatePromoteInput, options?: SB.CallOptions): SB.Call<TemplatePromoteOutput>
}Emits Template.promoted.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
template | Template | required | The Template that receives the refinement. |
startup | Startup | required | The Startup that holds the refinement. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
change | Change | required | The Change against the Template. |
template | Template | required | The Template that received the refinement. |
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. |
| The record is not in a state that allows this Verb, so the call is refused. | refused | Read the record, run the Verb that moves it to an allowed state, then retry. | None. |
Example
import { $ } from 'startup-builder'
const { change, template } = await $.Template.promote({ template: 'template_THRQF1h9uX', startup: 'startup_l3hr1EnUGY' })Template.upgrade
Upgrade moves a Startup to a newer Version of a Template it extends, through a Change it can review. Verb page.
interface TemplateVerbs {
upgrade(input: TemplateUpgradeInput, options?: SB.CallOptions): SB.Call<TemplateUpgradeOutput>
}Emits Template.upgraded.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
template | Template | required | The Template to upgrade. |
startup | Startup | required | The Startup that extends it. |
version | Version | The target Version. Defaults to the latest. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
change | Change | required | The Change that moves the pin. |
template | Template | required | The Template upgraded to. |
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. |
| The record is not in a state that allows this Verb, so the call is refused. | refused | Read the record, run the Verb that moves it to an allowed state, then retry. | None. |
Example
import { $ } from 'startup-builder'
const { change, template } = await $.Template.upgrade({ template: 'template_THRQF1h9uX', startup: 'startup_l3hr1EnUGY' })