client.callNotesOperation methods
Parameter declarations below are taken from the pinned TypeScript source. Request fields and responses are summarized from the matching OpenAPI operation; follow the API link for every field, constraint, example, and error description.
/call-notescallNotes.list
Use this operation to list call notes. It returns only resources visible to the credential and applies the documented filters before producing a bounded, stable page. Required scopes, product permissions, sharing rules, workspace locks, and regional cell ownership are enforced for every request.
client.callNotes.list(options?: CallNoteListOptions)- Return form
Promise- Operation ID
listCallNotes- Required scopes
call-notes:read- SDK parameters
options: CallNoteListOptions- Query request fields
cursor?: stringlimit?: integerarchived?: boolean- Success
200 Array<CallNote> envelope
/call-notescallNotes.create
Use this operation to create a call note. The server validates the complete payload and derives workspace ownership from the authenticated credential. Required scopes, product permissions, sharing rules, workspace locks, and regional cell ownership are enforced for every request. Use a stable Idempotency-Key when retrying so a transport timeout cannot create duplicate work.
client.callNotes.create(data: CallNoteCreate, options?: MutationOptions)- Return form
Promise- Operation ID
createCallNote- Required scopes
call-notes:write- SDK parameters
data: CallNoteCreateoptions: MutationOptions- Header request fields
Idempotency-Key: string- Request body
CallNoteCreateapplication/json- Success
200 CallNote envelope201 CallNote envelope
/call-notes/{id}callNotes.get
Use this operation to get a call note. It returns the resource only when it belongs to the authenticated workspace and is visible to the credential. Required scopes, product permissions, sharing rules, workspace locks, and regional cell ownership are enforced for every request.
client.callNotes.get(id: string, options?: RequestOptions)- Return form
Promise- Operation ID
getCallNote- Required scopes
call-notes:read- SDK parameters
id: stringoptions: RequestOptions- Path request fields
id: string- Success
200 CallNote envelope
/call-notes/{id}callNotes.archive
Use this operation to archive a call note. The operation preserves TeamGrid lifecycle and permission rules instead of bypassing them with a direct data deletion. Required scopes, product permissions, sharing rules, workspace locks, and regional cell ownership are enforced for every request.
client.callNotes.archive(id: string, options?: RequestOptions)- Return form
Promise- Operation ID
archiveCallNote- Required scopes
call-notes:write- SDK parameters
id: stringoptions: RequestOptions- Path request fields
id: string- Success
204
/call-notes/{id}/restorecallNotes.restore
Use this operation to restore an archived call note. The server validates the complete payload and derives workspace ownership from the authenticated credential. Required scopes, product permissions, sharing rules, workspace locks, and regional cell ownership are enforced for every request.
client.callNotes.restore(id: string, options?: RequestOptions)- Return form
Promise- Operation ID
restoreCallNote- Required scopes
call-notes:write- SDK parameters
id: stringoptions: RequestOptions- Path request fields
id: string- Success
200 CallNote envelope
Convenience helpers
These typed helpers compose mapped operations. They do not grant scopes or bypass API limits.
callNotes.pages
Iterate cursor pages with a bounded PaginationOptions policy.
client.callNotes.pages(options?: CallNoteListOptions, pagination?: PaginationOptions)AsyncGeneratorErrors and transport metadata
HTTP failures reject with TeamGridApiError, including the status, stable error documents, request ID, optional retry delay, and transport metadata. Local validation, routing, timeout, response-size, and pagination failures reject withTeamGridClientError and a stable client error code. Successful envelopes expose non-enumerable transport metadata.
See pagination and errors andclient configuration for handling guidance.