Collection methods: create, get, list

Reference for Collection, one group of Collection methods.

Collection.create

Creates a Collection. Verb page.

TypeScript

interface CollectionVerbs {
  create(input?: CollectionCreateInput, options?: SB.CallOptions): SB.Call<Collection>
}

Emits Collection.created.

Inputs

Input	Type	Description
`id`	`string`	The stable identifier, which never changes.
`type`	list of Noun	The Nouns this Thing is an instance of.
`outside`	`json`	The ids this Thing has in outside tools, one per Integration, so a re-run matches instead of duplicating.
`query`	`json`	The saved query that defines a dynamic Collection.

Returns

Output	Type	Required	Description
`collection`	Collection	required	The Collection.

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 collection = await $.Collection.create({ id: 'collection_txTK8QorKn' })

Returns one Collection by id. Verb page.

TypeScript

interface CollectionVerbs {
  get(input: CollectionGetInput, options?: SB.CallOptions): SB.Call<Collection>
}

Reads only: it emits no Event.

Inputs

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

Returns

Output	Type	Required	Description
`collection`	Collection	required	The Collection.

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 collection = await $.Collection.get({ id: 'collection_txTK8QorKn' })

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

TypeScript

interface CollectionVerbs {
  list(input?: CollectionListInput, options?: SB.CallOptions): SB.ListCall<Collection>
}

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
`collections`	list of Collection	required	One page of Collections.

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