UpdateRequests API

Update Requests API

import { CodeBoltClient } from '@codebolt/clientsdk';

const client = new CodeBoltClient();

Quick Reference

Method	Description
addDispute	Add a dispute to a request
addDisputeComment	Add a comment to a dispute
addWatcher	Add a watcher to a request
completeWork	Complete work on a request
create	Create a new update request
delete	Delete an update request
get	Get a single update request
list	List all update requests
merge	Merge a request into project structure
removeWatcher	Remove a watcher from a request
resolveDispute	Resolve a dispute
startWork	Start working on a request
submit	Submit a request for review
update	Update an existing request

Methods

---

addDispute

client.updateRequests.addDispute(id: string, data: AddDisputeRequest): Promise<unknown>

Add a dispute to a request

Parameter	Type	Required	Description
id	string	Yes
data	AddDisputeRequest	Yes

Returns: Promise<unknown>

Full reference →

---

addDisputeComment

client.updateRequests.addDisputeComment(id: string, disputeId: string, data: AddDisputeCommentRequest): Promise<unknown>

Add a comment to a dispute

Parameter	Type	Required	Description
id	string	Yes
disputeId	string	Yes
data	AddDisputeCommentRequest	Yes

Returns: Promise<unknown>

Full reference →

---

addWatcher

client.updateRequests.addWatcher(id: string, data: AddWatcherRequest): Promise<unknown>

Add a watcher to a request

Parameter	Type	Required	Description
id	string	Yes
data	AddWatcherRequest	Yes

Returns: Promise<unknown>

Full reference →

---

completeWork

client.updateRequests.completeWork(id: string, data?: CompleteWorkRequest): Promise<unknown>

Complete work on a request

Parameter	Type	Required	Description
id	string	Yes
data	CompleteWorkRequest	No

Returns: Promise<unknown>

Full reference →

---

create

client.updateRequests.create(data: CreateUpdateRequestRequest): Promise<UpdateRequest>

Create a new update request

Parameter	Type	Required	Description
data	CreateUpdateRequestRequest	Yes

Returns: Promise<UpdateRequest>

Full reference →

---

delete

client.updateRequests.delete(id: string): Promise<unknown>

Delete an update request

Parameter	Type	Required	Description
id	string	Yes

Returns: Promise<unknown>

Full reference →

---

get

client.updateRequests.get(id: string): Promise<UpdateRequest>

Get a single update request

Parameter	Type	Required	Description
id	string	Yes

Returns: Promise<UpdateRequest>

Full reference →

---

list

client.updateRequests.list(params?: Record<string, unknown>): Promise<UpdateRequest[]>

List all update requests

Parameter	Type	Required	Description
params	Record<string, unknown>	No

Returns: Promise<UpdateRequest[]>

Full reference →

---

merge

client.updateRequests.merge(id: string, data?: MergeUpdateRequestRequest): Promise<unknown>

Merge a request into project structure

Parameter	Type	Required	Description
id	string	Yes
data	MergeUpdateRequestRequest	No

Returns: Promise<unknown>

Full reference →

---

removeWatcher

client.updateRequests.removeWatcher(id: string, watcherId: string): Promise<unknown>

Remove a watcher from a request

Parameter	Type	Required	Description
id	string	Yes
watcherId	string	Yes

Returns: Promise<unknown>

Full reference →

---

resolveDispute

client.updateRequests.resolveDispute(id: string, disputeId: string, data: ResolveDisputeRequest): Promise<unknown>

Resolve a dispute

Parameter	Type	Required	Description
id	string	Yes
disputeId	string	Yes
data	ResolveDisputeRequest	Yes

Returns: Promise<unknown>

Full reference →

---

startWork

client.updateRequests.startWork(id: string): Promise<unknown>

Start working on a request

Parameter	Type	Required	Description
id	string	Yes

Returns: Promise<unknown>

Full reference →

---

submit

client.updateRequests.submit(id: string): Promise<unknown>

Submit a request for review

Parameter	Type	Required	Description
id	string	Yes

Returns: Promise<unknown>

Full reference →

---

update

client.updateRequests.update(id: string, data: UpdateUpdateRequestRequest): Promise<UpdateRequest>

Update an existing request

Parameter	Type	Required	Description
id	string	Yes
data	UpdateUpdateRequestRequest	Yes

Returns: Promise<UpdateRequest>

Full reference →