Supplier commands: update, delete
The Supplier Verbs update, delete as CLI commands, with inputs, result, refusals and an example.
Reference for Supplier, one group of Supplier commands.
Supplier.update
Changes the given properties of a Supplier. Verb page.
npx startup-builder do Supplier.update --json '<input>' [--try | --send | --do]Emits Supplier.updated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Supplier. |
name | string | The legal or personal name. | |
payoutAccount | string | Where payouts land, held through Stripe. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
supplier | Supplier | required | The Supplier. |
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 Supplier.update --json '{"id": "supplier_QTsIMiLqO4", "payoutAccount": "Example payout account"}'Supplier.delete
Deletes a Supplier: a soft delete that keeps its history, undone by Thing.restore. Verb page.
npx startup-builder do Supplier.delete --json '<input>' [--try | --send | --do]Emits Supplier.deleted.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Supplier. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
supplier | Supplier | required | The Supplier. |
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 Supplier.delete --json '{"id": "supplier_QTsIMiLqO4"}'