Market methods: update, delete
The Market Verbs update, delete as typed SDK methods, with inputs, result, refusals and an example.
Reference for Market, one group of Market methods.
Market.update
Changes the given properties of a Market. Verb page.
interface MarketVerbs {
update(input: MarketUpdateInput, options?: SB.CallOptions): SB.Call<Market>
}Emits Market.updated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Market. |
countries | string[] | ISO 3166-1 alpha-2 country codes. | |
currency | string | The ISO 4217 currency Prices show in. | |
locales | string[] | 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.update({ id: 'market_4uFEzN14G4', currency: 'USD' })Market.delete
Deletes a Market: a soft delete that keeps its history, undone by Thing.restore. Verb page.
interface MarketVerbs {
delete(input: MarketDeleteInput, options?: SB.CallOptions): SB.Call<Market>
}Emits Market.deleted.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Market. |
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.delete({ id: 'market_4uFEzN14G4' })