listNoteCommentsWithHttpInfo method

Future<Response> listNoteCommentsWithHttpInfo(
  1. String id, {
  2. String? accountId,
  3. String? xWorkspaceID,
})

List comments on a note.

Returns active (non-deleted) comments. When ?accountId= targets an external provider that supports comments (e.g. Notion), the provider is queried directly; otherwise the native store is used.

Note: This method returns the HTTP Response.

Parameters:

  • String id (required): Note id.

  • 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> listNoteCommentsWithHttpInfo(String id, { String? accountId, String? xWorkspaceID, }) async {
  // ignore: prefer_const_declarations
  final path = r'/v1/notes/{id}/comments'
    .replaceAll('{id}', id);

  // ignore: prefer_final_locals
  Object? postBody;

  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>[];


  return apiClient.invokeAPI(
    path,
    'GET',
    queryParams,
    postBody,
    headerParams,
    formParams,
    contentTypes.isEmpty ? null : contentTypes.first,
  );
}