Partner methods: create, get, list

Reference for Partner, one group of Partner methods.

Partner.create

Creates a Partner. Verb page.

TypeScript

interface PartnerVerbs {
  create(input: PartnerCreateInput, options?: SB.CallOptions): SB.Call<Partner>
}

Emits Partner.created.

Inputs

Input	Type	Required	Description
`name`	`string`	required	The name it trades under.
`hostname`	`string`		The web domain that keys it.
`side`	`string`	required	One of `supply`, `distribution`, or `both`.

Returns

Output	Type	Required	Description
`partner`	Partner	required	The Partner.

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 partner = await $.Partner.create({ name: 'Leaseline', side: 'supply' })

Returns one Partner by id. Verb page.

TypeScript

interface PartnerVerbs {
  get(input: PartnerGetInput, options?: SB.CallOptions): SB.Call<Partner>
}

Reads only: it emits no Event.

Inputs

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

Returns

Output	Type	Required	Description
`partner`	Partner	required	The Partner.

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 partner = await $.Partner.get({ id: 'partner_YcEOEgSexq' })

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

TypeScript

interface PartnerVerbs {
  list(input?: PartnerListInput, options?: SB.CallOptions): SB.ListCall<Partner>
}

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
`partners`	list of Partner	required	One page of Partners.

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 partners = await $.Partner.list({ limit: 20 })