Market methods: create, get, list
The Market Verbs create, get, list as typed SDK methods, with inputs, result, refusals and an example.
Reference for Market, one group of Market methods.
Market.create
Creates a Market. Verb page.
interface MarketVerbs {
create(input: MarketCreateInput, options?: SB.CallOptions): SB.Call<Market>
}Emits Market.created.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
countries | string[] | required | ISO 3166-1 alpha-2 country codes. |
currency | string | required | The ISO 4217 currency Prices show in. |
locales | string[] | required | BCP 47 locale tags, the default first. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
market | Market | required | The Market. |
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 market = await $.Market.create({ countries: ['Example countries'], currency: 'USD', locales: ['Example locales'] })Market.get
Returns one Market by id. Verb page.
interface MarketVerbs {
get(input: MarketGetInput, options?: SB.CallOptions): SB.Call<Market>
}Reads only: it emits no Event.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Market. |
at | string | A time or Version name: the record as it stood then. Unset: as it stands now. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
market | Market | required | The Market. |
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 market = await $.Market.get({ id: 'market_4uFEzN14G4' })Market.list
Returns Markets, newest first, one page at a time. Verb page.
interface MarketVerbs {
list(input?: MarketListInput, options?: SB.CallOptions): SB.ListCall<Market>
}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 |
|---|---|---|---|
markets | list of Market | required | One page of Markets. |
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 markets = await $.Market.list({ limit: 20 })