Order commands: revise, screen, start
The Order Verbs revise, screen, start as CLI commands, with inputs, result, refusals and an example.
Reference for Order, one group of Order commands.
Order.revise
Revise sends delivered lines back for one counted revision, with the changes the Customer asks for. Verb page.
npx startup-builder do Order.revise --json '<input>' [--try | --send | --do]Emits Order.revised.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
order | Order | required | The delivered Order. |
lines | json | The lines sent back; every delivered line when absent. | |
changes | text | required | What the Customer wants changed, such as a shorter summary. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
order | Order | required | The Order, its fulfillment set to revising. |
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 Order.revise --json '{"order": "order_dswDnxf2vt", "changes": "Example changes"}'Order.screen
Screen scores an Order’s payment before it is charged and allows, authenticates, holds or blocks it by the Startup’s risk Policy. Verb page.
npx startup-builder do Order.screen --json '<input>' [--try | --send | --do]Emits Order.screened.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
order | Order | required | The placed Order whose payment is screened. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
outcome | string | required | allow charges, authenticate asks the buyer to confirm with their card issuer, review waits for an Approval, block cancels. |
risk | number | required | The payment’s risk score from 0 to 99, as Stripe scored it. |
rule | string | The risk Policy rule that decided the outcome, when one did. | |
order | Order | required | The Order screened. |
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 Order.screen --json '{"order": "order_dswDnxf2vt"}'Order.start
Start checks a Service Order’s inputs against its brief, then moves it from intake to working and starts its deadline. Verb page.
npx startup-builder do Order.start --json '<input>' [--try | --send | --do]Emits Order.started.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
order | Order | required | The Order in intake. |
received | json | required | What the Customer supplied, measured as the brief measures it, such as a 79,400-word manuscript. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
order | Order | required | The Order, its fulfillment set to working, or still intake while a Question is open. |
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 Order.start --json '{"order": "order_dswDnxf2vt", "received": {}}'