Gathering commands: create, get, list
The Gathering Verbs create, get, list as CLI commands, with inputs, result, refusals and an example.
Reference for Gathering, one group of Gathering commands.
Gathering.create
Creates a Gathering. Verb page.
npx startup-builder do Gathering.create --json '<input>' [--try | --send | --do]Emits Gathering.created.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
title | string | required | What the Gathering is called on its Page and invitations. |
at | datetime | required | When it starts. |
capacity | integer | The most Registrations it admits before new ones join the waitlist. | |
recording | url | Where the replay lives once it ends. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
gathering | Gathering | required | The Gathering. |
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
npx startup-builder do Gathering.create --json '{"title":Gathering.get
Returns one Gathering by id. Verb page.
npx startup-builder do Gathering.get --json '<input>' [--try]Reads only: it emits no Event.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Gathering. |
at | string | A time or Version name: the record as it stood then. Unset: as it stands now. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
gathering | Gathering | required | The Gathering. |
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
npx startup-builder do Gathering.get --json '{"id":Gathering.list
Returns Gatherings, newest first, one page at a time. Verb page.
npx startup-builder do Gathering.list --json '<input>' [--try]Reads only: it emits no Event.
Inputs
| Input | Type | Required | 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 |
|---|---|---|---|
gatherings | list of Gathering | required | One page of Gatherings. |
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
npx startup-builder do Gathering.list --json '{"limit":