Startup methods: claim, clone, hold, import
The Startup Verbs claim, clone, hold, import as typed SDK methods, with inputs, result, refusals and an example.
Reference for Startup, one group of Startup methods.
Startup.claim
Claim binds a provisional Startup to a verified owner, which enables payments and every Verb that moves money. Verb page.
interface StartupVerbs {
claim(input: StartupClaimInput, options?: SB.CallOptions): SB.Call<Startup>
}Emits Startup.claimed.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
startup | Startup | required | The provisional Startup. |
claimToken | string | required | The token issued when the Startup was created. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
startup | Startup | required | The Startup, now owned. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The input does not match the schema of the operation. | invalid-input | Read the schema of the operation, then send every required field with the right type. | None. |
| 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 startup = await $.Startup.claim({ startup: 'startup_l3hr1EnUGY', claimToken: 'Example claim token' })Startup.clone
Clone copies a Startup’s definition into a new Startup once, with no link back to the source. Verb page.
interface StartupVerbs {
clone(input: StartupCloneInput, options?: SB.CallOptions): SB.Call<Startup>
}Emits Startup.cloned.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
startup | Startup | required | The Startup to copy. |
name | string | required | The new Startup’s name. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
clone | Startup | required | The new Startup, in Idea. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The input does not match the schema of the operation. | invalid-input | Read the schema of the operation, then send every required field with the right type. | None. |
| 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 clone = await $.Startup.clone({ startup: 'startup_l3hr1EnUGY', name: 'Leaseline' })Startup.hold
Hold keeps a Startup running in its current Lifecycle state with no new investment from the Studio. Verb page.
interface StartupVerbs {
hold(input: StartupHoldInput, options?: SB.CallOptions): SB.Call<Startup>
}Emits Startup.held.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
startup | Startup | required | The Startup to hold. |
reason | text | Why the Studio holds it. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
startup | Startup | required | The Startup, now on Hold. |
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 startup = await $.Startup.hold({ startup: 'startup_l3hr1EnUGY' })Startup.import
Import builds a new Startup from an existing business’s definition: its Offers, Pages, Nouns and Processes. Verb page.
interface StartupVerbs {
import(input: StartupImportInput, options?: SB.CallOptions): SB.Call<Startup>
}Emits Startup.imported.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
source | url | required | The existing business’s site or export. |
template | Template | The Template to map the definition onto. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
startup | Startup | required | The new Startup, in Idea. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The input does not match the schema of the operation. | invalid-input | Read the schema of the operation, then send every required field with the right type. | None. |
| 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 startup = await $.Startup.import({ source: 'https: