Thing commands: relate, resolve, restore

Reference for Thing, one group of Thing commands.

Thing.relate

Relate links two Things by a Relationship their Nouns declare, readable from both ends at once. Verb page.

Text

npx startup-builder do Thing.relate --json '<input>' [--try | --send | --do]

Inputs

Input	Type	Required	Description
`thing`	Thing	required	The source Thing.
`predicate`	`string`	required	The Relationship as read from the source, such as `places`.
`to`	Thing	required	The target Thing.

Returns

Output	Type	Required	Description
`relationship`	Relationship	required	The Relationship, with its provenance.
`thing`	Thing	required	The Thing the Relationship starts from.

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 predicate that neither Noun declares	`refused`	Clear what the check names, then call it again.	None.

Example

Terminal

npx startup-builder do Thing.relate --json '{"thing":"thing_8ds0r9vvRl","predicate":"Example predicate","to":"thing_8ds0r9vvRl"}'

Resolve finds the one Thing of a Noun that matches given properties, or creates it, and says which it did. Verb page.

Text

npx startup-builder do Thing.resolve --json '<input>' [--try | --send | --do]

Inputs

Input	Type	Required	Description
`noun`	Noun	required	The Noun to resolve.
`match`	`json`	required	The properties that identify the Thing, such as an email address.
`set`	`json`		Properties to write on the found or created Thing.

Returns

Output	Type	Required	Description
`thing`	Thing		The Thing found or created; empty when held.
`decision`	`string`	required	What happened: `found`, `created`, or `held` when two or more Things match.

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

Terminal

npx startup-builder do Thing.resolve --json '{"noun":"noun_v0akLUrXCN","match":{}}'

Restore brings back a deleted Thing, or one an undone Action removed, with its history and Relationships intact. Verb page.

Text

npx startup-builder do Thing.restore --json '<input>' [--try | --send | --do]

Inputs

Input	Type	Required	Description
`thing`	Thing	required	The deleted Thing.

Returns

Output	Type	Required	Description
`thing`	Thing	required	The Thing, back in every list and query it left.

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.
The Thing is not deleted	`refused`	Clear what the check names, then call it again.	None.

Example

Terminal

npx startup-builder do Thing.restore --json '{"thing":"thing_8ds0r9vvRl"}'