Holder methods
Every Holder Verb as a typed SDK method, with its inputs, result, refusals and an example.
Reference for Holder.
Holder.create
Creates a Holder. Verb page.
interface HolderVerbs {
create(input: HolderCreateInput, options?: SB.CallOptions): SB.Call<Holder>
}Emits Holder.created.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
party | Party | required | The person or entity behind the holding. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
holder | Holder | required | The Holder. |
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 holder = await $.Holder.create({ party: 'party_hmQWaPrAyZ' })Holder.get
Returns one Holder by id. Verb page.
interface HolderVerbs {
get(input: HolderGetInput, options?: SB.CallOptions): SB.Call<Holder>
}Reads only: it emits no Event.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Holder. |
at | string | A time or Version name: the record as it stood then. Unset: as it stands now. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
holder | Holder | required | The Holder. |
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 holder = await $.Holder.get({ id: 'holder_e2Dm5Y6QGO' })Holder.list
Returns Holders, newest first, one page at a time. Verb page.
interface HolderVerbs {
list(input?: HolderListInput, options?: SB.CallOptions): SB.ListCall<Holder>
}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 |
|---|---|---|---|
holders | list of Holder | required | One page of Holders. |
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 holders = await $.Holder.list({ limit: 20 })Holder.update
Changes the given properties of a Holder. Verb page.
interface HolderVerbs {
update(input: HolderUpdateInput, options?: SB.CallOptions): SB.Call<Holder>
}Emits Holder.updated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Holder. |
party | Party | The person or entity behind the holding. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
holder | Holder | required | The Holder. |
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 holder = await $.Holder.update({ id: 'holder_e2Dm5Y6QGO', party: 'party_hmQWaPrAyZ' })