Product Template commands: create, get, list
The Product Template Verbs create, get, list as CLI commands, with inputs, result, refusals and an example.
Reference for Product Template, one group of Product Template commands.
ProductTemplate.create
Creates a Product Template. Verb page.
npx startup-builder do ProductTemplate.create --json '<input>' [--try | --send | --do]Emits ProductTemplate.created.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
slug | string | required | The page path under /. |
kind | string | required | The abstract Product: data, software, agent, or service. |
supply | string | required | Who supplies the work: digital, which is unlimited, or human, which is recruited and credentialed. |
worker | string | required | Who does the work: agents, humans, or agents-and-humans. |
buyer | string | required | Who buys: human, agent, or human-or-agent. |
earningModel | string | required | How it earns: subscription, usage, commerce, marketplace, or directory. |
assurance | text | What the buyer can rely on, in one sentence. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
productTemplate | Product Template | required | The Product Template. |
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 ProductTemplate.create --json '{"slug":ProductTemplate.get
Returns one Product Template by id. Verb page.
npx startup-builder do ProductTemplate.get --json '<input>' [--try]Reads only: it emits no Event.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Product Template. |
at | string | A time or Version name: the record as it stood then. Unset: as it stands now. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
productTemplate | Product Template | required | The Product Template. |
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 ProductTemplate.get --json '{"id":ProductTemplate.list
Returns Product Templates, newest first, one page at a time. Verb page.
npx startup-builder do ProductTemplate.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 |
|---|---|---|---|
productTemplates | list of Product Template | required | One page of Product Templates. |
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 ProductTemplate.list --json '{"limit":