Entitlement commands: create, get, list
The Entitlement Verbs create, get, list as CLI commands, with inputs, result, refusals and an example.
Reference for Entitlement, one group of Entitlement commands.
Entitlement.create
Creates an Entitlement. Verb page.
npx startup-builder do Entitlement.create --json '<input>' [--try | --send | --do]Emits Entitlement.created.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
verb | Verb | required | The Verb it grants. |
limit | Limit | The Limit that bounds it. | |
kind | string | Computed, never set: feature, or limit when a Limit bounds it. | |
offer | Offer | An accepted Offer grants Entitlements, each a Verb on a Noun, optionally bounded by a Limit. | |
customer | Customer | A Customer’s Entitlements are what it may do right now, granted by the Offers it accepted. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
entitlement | Entitlement | required | The Entitlement. |
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 Entitlement.create --json '{"verb":Entitlement.get
Returns one Entitlement by id. Verb page.
npx startup-builder do Entitlement.get --json '<input>' [--try]Reads only: it emits no Event.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Entitlement. |
at | string | A time or Version name: the record as it stood then. Unset: as it stands now. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
entitlement | Entitlement | required | The Entitlement. |
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 Entitlement.get --json '{"id":Entitlement.list
Returns Entitlements, newest first, one page at a time. Verb page.
npx startup-builder do Entitlement.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 |
|---|---|---|---|
entitlements | list of Entitlement | required | One page of Entitlements. |
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 Entitlement.list --json '{"limit":