backends-web-backend

---

Class: WorkbookReviewController

Defined in: backends/web-backend/src/workbooks/workbook-review.controller.ts:42

Constructors

Constructor

new WorkbookReviewController(rolesService, workflowService, commentsService): WorkbookReviewController

Defined in: backends/web-backend/src/workbooks/workbook-review.controller.ts:43

Parameters

rolesService

WorkbookRolesService

workflowService

WorkbookWorkflowService

commentsService

WorkbookCommentsService

Returns

WorkbookReviewController

Methods

addComment()

addComment(id, body, req): Promise<unknown>

Defined in: backends/web-backend/src/workbooks/workbook-review.controller.ts:141

Parameters

id

string

body

AddCommentBody

req

AuthenticatedRequest

Returns

Promise<unknown>

---

assign()

assign(id, body, req): Promise<WorkbookRolesResponse>

Defined in: backends/web-backend/src/workbooks/workbook-review.controller.ts:63

Parameters

id

string

body

AssignBody

req

AuthenticatedRequest

Returns

Promise<WorkbookRolesResponse>

---

awaitingMe()

awaitingMe(req): Promise<object[]>

Defined in: backends/web-backend/src/workbooks/workbook-review.controller.ts:51

Parameters

req

AuthenticatedRequest

Returns

Promise<object[]>

---

listRoles()

listRoles(id, req): Promise<WorkbookRolesResponse>

Defined in: backends/web-backend/src/workbooks/workbook-review.controller.ts:57

Parameters

id

string

req

AuthenticatedRequest

Returns

Promise<WorkbookRolesResponse>

---

requestRevision()

requestRevision(id, body, req): Promise<unknown>

Defined in: backends/web-backend/src/workbooks/workbook-review.controller.ts:135

Parameters

id

string

body

RequestRevisionBody

req

AuthenticatedRequest

Returns

Promise<unknown>

---

signApproval()

signApproval(id, body, req): Promise<unknown>

Defined in: backends/web-backend/src/workbooks/workbook-review.controller.ts:116

Parameters

id

string

body

signatureDataUrl?

string

req

AuthenticatedRequest

Returns

Promise<unknown>

---

signAs()

signAs(id, body, req): Promise<unknown>

Defined in: backends/web-backend/src/workbooks/workbook-review.controller.ts:122

Parameters

id

string

body

SignAsBody

req

AuthenticatedRequest

Returns

Promise<unknown>

---

signReview()

signReview(id, body, req): Promise<unknown>

Defined in: backends/web-backend/src/workbooks/workbook-review.controller.ts:110

Parameters

id

string

body

signatureDataUrl?

string

req

AuthenticatedRequest

Returns

Promise<unknown>

---

status()

status(id, req): Promise<WorkbookWorkflowStatus>

Defined in: backends/web-backend/src/workbooks/workbook-review.controller.ts:98

Parameters

id

string

req

AuthenticatedRequest

Returns

Promise<WorkbookWorkflowStatus>

---

submit()

submit(id, req): Promise<unknown>

Defined in: backends/web-backend/src/workbooks/workbook-review.controller.ts:104

Parameters

id

string

req

AuthenticatedRequest

Returns

Promise<unknown>

---

submitToApprover()

submitToApprover(id, req): Promise<unknown>

Defined in: backends/web-backend/src/workbooks/workbook-review.controller.ts:129

Parameters

id

string

req

AuthenticatedRequest

Returns

Promise<unknown>

---

unassignTeam()

unassignTeam(id, teamId, role, req): Promise<WorkbookRolesResponse>

Defined in: backends/web-backend/src/workbooks/workbook-review.controller.ts:87

Parameters

id

string

teamId

string

role

WorkbookRoleName

req

AuthenticatedRequest

Returns

Promise<WorkbookRolesResponse>

---

unassignUser()

unassignUser(id, username, role, req): Promise<WorkbookRolesResponse>

Defined in: backends/web-backend/src/workbooks/workbook-review.controller.ts:76

Parameters

id

string

username

string

role

WorkbookRoleName

req

AuthenticatedRequest

Returns

Promise<WorkbookRolesResponse>

---

updateComment()

updateComment(id, commentUuid, body, req): Promise<unknown>

Defined in: backends/web-backend/src/workbooks/workbook-review.controller.ts:147

Parameters

id

string

commentUuid

string

body

UpdateCommentBody

req

AuthenticatedRequest

Returns

Promise<unknown>