Share commands
Every Share Verb as a CLI command, with its inputs, result, refusals and an example.
Reference for Share.
Share.get
Returns one Share by id. Verb page.
npx startup-builder do Share.get --json '<input>' [--try]Reads only: it emits no Event.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Share. |
at | string | A time or Version name: the record as it stood then. Unset: as it stands now. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
share | Share | required | The Share. |
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 Share.get --json '{"id":Share.list
Returns Shares, newest first, one page at a time. Verb page.
npx startup-builder do Share.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 |
|---|---|---|---|
shares | list of Share | required | One page of Shares. |
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 Share.list --json '{"limit":Share.issue
Issue records new Shares of one class to a Holder under a board-approved Agreement, with the certificate or book entry. Verb page.
npx startup-builder do Share.issue --json '<input>' [--try | --send | --do]Emits Share.issued.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
holder | Holder | required | The Holder who receives the Shares. |
class | string | required | The share class. |
quantity | integer | required | How many Shares. |
price | money | required | The price paid per Share. |
agreement | Agreement | required | The board-approved Agreement that authorizes the issue. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
share | Share | required | The issued Share record. |
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 Share.issue --json '{"holder":Share.transfer
Transfer moves Shares from one Holder to another under a signed Agreement, within the Company’s transfer restrictions. Verb page.
npx startup-builder do Share.transfer --json '<input>' [--try | --send | --do]Emits Share.transferred.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
share | Share | required | The Share record to transfer from. |
to | Holder | required | The Holder who receives them. |
quantity | integer | required | How many Shares move. |
agreement | Agreement | required | The signed transfer Agreement. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
share | Share | required | The new Share record held by the receiving Holder. |
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. |
| A transfer the bylaws or a right of first refusal block | refused | Clear what the check names, then call it again. | None. |
Example
npx startup-builder do Share.transfer --json '{"share":