ReviewableRequests

ReviewableRequests

ReviewableRequests.

Constructor

new ReviewableRequests()

Source:

Methods

cancel(requestId) → {Promise.<JsonApiResponse>}

Cancel a reviewable request.

Source:
Parameters:
Name Type Description
requestId string

Reviewable request ID.
Returns:
Type:
Promise.<JsonApiResponse>

get(requestId, queryopt) → {Promise.<JsonApiResponse>}

Get a reviewable request by id

Source:
Parameters:
Name Type Attributes Description
requestId
query object <optional>

Request options.
Returns:
Type:
Promise.<JsonApiResponse>

getPage(queryopt) → {Promise.<JsonApiResponse>}

Get reviewable requests.

Source:
Parameters:
Name Type Attributes Description
query object <optional>

Request options.

Name Type Attributes Description
page.number Number <optional>

Page number.
page.size Number <optional>

Page size.
sort Array.<string> <optional>

Sorting params.
requestor string <optional>

Requestor of the request.
reviewer reviewer <optional>

Reviewer of the request.
type string <optional>

Type of the request.
Returns:
Type:
Promise.<JsonApiResponse>

manage(requestId, hash, state, rejectReasonopt) → {Promise.<JsonApiResponse>}

Manage a reviewable request.

Source:
Parameters:
Name Type Attributes Description
requestId string

Reviewable request ID.
hash string

Reviewable request hash.
state string

The new state of the request.
rejectReason string <optional>

The reason why the request was rejected.
Returns:
Type:
Promise.<JsonApiResponse>