updateNoteCommentWithHttpInfo method
Future<Response>
updateNoteCommentWithHttpInfo(
- String id,
- String commentId,
- UpdateCommentRequest updateCommentRequest, {
- String? accountId,
- String? xWorkspaceID,
Edit a comment.
Only the comment author can edit. The note owner can delete via DELETE but cannot rewrite.
Note: This method returns the HTTP Response.
Parameters:
-
String id (required): Note id.
-
String commentId (required): Comment id.
-
UpdateCommentRequest updateCommentRequest (required):
-
String accountId: Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with
provider. If omitted on a list endpoint the call fans out across every connected account. -
String xWorkspaceID: Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.
Implementation
Future<Response> updateNoteCommentWithHttpInfo(String id, String commentId, UpdateCommentRequest updateCommentRequest, { String? accountId, String? xWorkspaceID, }) async {
// ignore: prefer_const_declarations
final path = r'/v1/notes/{id}/comments/{commentId}'
.replaceAll('{id}', id)
.replaceAll('{commentId}', commentId);
// ignore: prefer_final_locals
Object? postBody = updateCommentRequest;
final queryParams = <QueryParam>[];
final headerParams = <String, String>{};
final formParams = <String, String>{};
if (accountId != null) {
queryParams.addAll(_queryParams('', 'accountId', accountId));
}
if (xWorkspaceID != null) {
headerParams[r'X-Workspace-ID'] = parameterToString(xWorkspaceID);
}
const contentTypes = <String>['application/json'];
return apiClient.invokeAPI(
path,
'PATCH',
queryParams,
postBody,
headerParams,
formParams,
contentTypes.isEmpty ? null : contentTypes.first,
);
}