client.taskRecurrenceVersionsOperation 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.
/task-recurrences/{id}/versionstaskRecurrenceVersions.list
Use this operation to list task recurrence versions. 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.taskRecurrenceVersions.list(seriesId: string, options: ListOptions = {})- Return form
Promise- Operation ID
listTaskRecurrenceVersions- Required scopes
task-recurrences:readtasks:read- SDK parameters
seriesId: stringoptions: ListOptions- Path request fields
id: string- Success
200 Array<TaskRecurrenceVersion> envelope
/task-recurrences/{id}/versions/{versionId}taskRecurrenceVersions.get
Use this operation to get a task recurrence version. 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.taskRecurrenceVersions.get(seriesId: string, versionId: string, options: RequestOptions = {})- Return form
Promise- Operation ID
getTaskRecurrenceVersion- Required scopes
task-recurrences:readtasks:read- SDK parameters
seriesId: stringversionId: stringoptions: RequestOptions- Path request fields
id: stringversionId: string- Success
200 TaskRecurrenceVersion envelope
/task-recurrences/{id}/versions/{versionId}/restoretaskRecurrenceVersions.restore
Use this operation to restore a task recurrence version. 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. Send the latest strong ETag in If-Match; stale revisions fail without overwriting a concurrent change.
client.taskRecurrenceVersions.restore(seriesId: string, versionId: string, data: TaskRecurrenceVersionRestore = {}, options: TaskRecurrenceMutationOptions)- Return form
Promise- Operation ID
restoreTaskRecurrenceVersion- Required scopes
task-recurrences:writetasks:readtasks:write- SDK parameters
seriesId: stringversionId: stringdata: TaskRecurrenceVersionRestoreoptions: TaskRecurrenceMutationOptions- Path request fields
id: stringversionId: string- Header request fields
If-Match: string- Request body
TaskRecurrenceVersionRestoreapplication/json- Success
200 TaskRecurrence envelope
Convenience helpers
These typed helpers compose mapped operations. They do not grant scopes or bypass API limits.
taskRecurrenceVersions.pages
Iterate cursor pages with a bounded PaginationOptions policy.
client.taskRecurrenceVersions.pages(seriesId: string, options: ListOptions = {}, 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.