Tenant methods: create, get, list

Reference for Tenant, one group of Tenant methods.

Tenant.create

Creates a Tenant. Verb page.

TypeScript

interface TenantVerbs {
  create(input?: TenantCreateInput, options?: SB.CallOptions): SB.Call<Tenant>
}

Emits Tenant.created.

Inputs

Input	Type	Required	Description
`placement`	`string`		Where the Tenant sits in an address: `path` or `host`.
`apiVersion`	`string`		The API version an unversioned call with this Tenant’s keys answers at; set at creation, moved only by `pin`.

Returns

Output	Type	Required	Description
`tenant`	Tenant	required	The Tenant.

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 tenant = await $.Tenant.create({ placement: 'path' })

Returns one Tenant by id. Verb page.

TypeScript

interface TenantVerbs {
  get(input: TenantGetInput, options?: SB.CallOptions): SB.Call<Tenant>
}

Reads only: it emits no Event.

Inputs

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

Returns

Output	Type	Required	Description
`tenant`	Tenant	required	The Tenant.

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 tenant = await $.Tenant.get({ id: 'ten_Bu63f0he26' })

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

TypeScript

interface TenantVerbs {
  list(input?: TenantListInput, options?: SB.CallOptions): SB.ListCall<Tenant>
}

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
`tenants`	list of Tenant	required	One page of Tenants.

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