Review programs: publish, remove, withhold

Reference for Review, one group of Review programs.

Review.publish

Publish shows a Review on the Startup’s Pages with its rating counted, whatever the rating. Verb page.

Text

do: return await $.Review.publish(input)

Inputs

Input	Type	Required	Description
`review`	Review	required	The Review to show.

Returns

Output	Type	Required	Description
`review`	Review	required	The Review, now `published`.

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 $.Review.publish({ review: 'review_1XPL2xTlfx' })"
  }
}

Remove takes a Review down for good when its author or its venue asks; the record is kept. Verb page.

Text

do: return await $.Review.remove(input)

Inputs

Input	Type	Required	Description
`review`	Review	required	The Review to take down.
`reason`	`string`	required	Who asked.

Returns

Output	Type	Required	Description
`review`	Review	required	The Review, now `removed`.

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 $.Review.remove({ review: 'review_1XPL2xTlfx', reason: 'authorRequest' })"
  }
}

Withhold keeps a Review off display for one of five reasons, none of them its rating or its tone. Verb page.

Text

do: return await $.Review.withhold(input)

Inputs

Input	Type	Required	Description
`review`	Review	required	The Review to withhold.
`reason`	`string`	required	Why it is not shown.

Returns

Output	Type	Required	Description
`review`	Review	required	The Review, now `withheld`.

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 $.Review.withhold({ review: 'review_1XPL2xTlfx', reason: 'fake' })"
  }
}