Role programs: review, staff, vacate

Reference for Role, one group of Role programs.

Role.review

Review checks one Role against its contract for a period and records a Role Review. Verb page.

Text

do: return await $.Role.review(input)

Inputs

Input	Type	Required	Description
`role`	Role	required	The Role to review.
`period`	`string`	required	The period it covers, such as `2026-W43`.

Returns

Output	Type	Required	Description
`role`	Role	required	The reviewed Role.
`roleReview`	Role Review	required	The recorded Role Review.

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

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Role.review({ role: 'role_oloMFMUeCH', period: 'Example period' })"
  }
}

Staff fills a Role with a Worker, human or agent, who then performs the Role’s Verbs under its Permissions. Verb page.

Text

do: return await $.Role.staff(input)

Inputs

Input	Type	Required	Description
`role`	Role	required	The Role to fill.
`worker`	Worker	required	The Worker who fills it.

Returns

Output	Type	Required	Description
`role`	Role	required	The staffed Role.

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 record is not in a state that allows this Verb, so the call is refused.	`refused`	Read the record, run the Verb that moves it to an allowed state, then retry.	None.

Example

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Role.staff({ role: 'role_oloMFMUeCH', worker: 'worker_whZFpOKWIV' })"
  }
}

Vacate takes the Worker out of a Role, and the seat’s Tasks route to the Role it escalates to until a new Worker is staffed. Verb page.

Text

do: return await $.Role.vacate(input)

Inputs

Input	Type	Required	Description
`role`	Role	required	The Role to empty.
`reason`	`text`		Why the seat empties.

Returns

Output	Type	Required	Description
`role`	Role	required	The vacant Role.

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

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Role.vacate({ role: 'role_oloMFMUeCH' })"
  }
}