Mapping methods: create, get, list

Reference for Mapping, one group of Mapping methods.

Mapping.create

Creates a Mapping. Verb page.

TypeScript

interface MappingVerbs {
  create(input?: MappingCreateInput, options?: SB.CallOptions): SB.Call<Mapping>
}

Emits Mapping.created.

Inputs

Input	Type	Description
`verb`	`string`	The Verb it serves, such as `Meeting.book`; a Verb has many Mappings, ranked.
`fields`	`json`	Each outside field or event and the Noun property or Event it maps to.
`direction`	`string`	`both` still keeps db.sb the record; the outside tool never becomes a second one.
`convert`	`text`	How a value changes on the way, such as cents to money or a picklist to closed values.
`rank`	`integer`	Order tried when the preferred Mapping fails or finds nothing; the Policy orders it by cost per accepted result.
`preferred`	`boolean`	True for the Mapping a Verb tries first.
`door`	`string`	How the outside endpoint is classed; an unclassed write is one-way and waits its delay window.
`source`	Source	A Source reaches the registry’s Nouns and Verbs through its Mappings, one per Verb it serves.

Returns

Output	Type	Required	Description
`mapping`	Mapping	required	The Mapping.

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

TypeScript

import { $ } from 'startup-builder'

const mapping = await $.Mapping.create({ verb: 'Meeting.book' })

Returns one Mapping by id. Verb page.

TypeScript

interface MappingVerbs {
  get(input: MappingGetInput, options?: SB.CallOptions): SB.Call<Mapping>
}

Reads only: it emits no Event.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Mapping.
`at`	`string`		A time or Version name: the record as it stood then. Unset: as it stands now.

Returns

Output	Type	Required	Description
`mapping`	Mapping	required	The Mapping.

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

TypeScript

import { $ } from 'startup-builder'

const mapping = await $.Mapping.get({ id: 'mapping_WOromrQi6J' })

Returns Mappings, newest first, one page at a time. Verb page.

TypeScript

interface MappingVerbs {
  list(input?: MappingListInput, options?: SB.CallOptions): SB.ListCall<Mapping>
}

Reads only: it emits no Event.

Inputs

Input	Type	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
`mappings`	list of Mapping	required	One page of Mappings.

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

TypeScript

import { $ } from 'startup-builder'

const mappings = await $.Mapping.list({ limit: 20 })