client.taskRecurrencesOperation 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-recurrencestaskRecurrences.list
Use this operation to list task recurrences. 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.taskRecurrences.list(options: TaskRecurrenceListOptions = {})- Return form
Promise- Operation ID
listTaskRecurrences- Required scopes
task-recurrences:readtasks:read- SDK parameters
options: TaskRecurrenceListOptions- Query request fields
cursor?: stringlimit?: integerprojectId?: stringstatus?: string- Success
200 Array<TaskRecurrence> envelope
/task-recurrencestaskRecurrences.create
Use this operation to create a task recurrence. 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.taskRecurrences.create(data: TaskRecurrenceCreate, options: MutationOptions = {})- Return form
Promise- Operation ID
createTaskRecurrence- Required scopes
task-recurrences:writetasks:readtasks:write- SDK parameters
data: TaskRecurrenceCreateoptions: MutationOptions- Header request fields
Idempotency-Key: string- Request body
TaskRecurrenceCreateapplication/json- Success
200 TaskRecurrence envelope201 TaskRecurrence envelope
/task-recurrences/previewtaskRecurrences.preview
Use this operation to preview a draft task recurrence. 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.taskRecurrences.preview(data: TaskRecurrencePreviewInput, options: RequestOptions = {})- Return form
Promise- Operation ID
previewTaskRecurrence- Required scopes
task-recurrences:writetasks:readtasks:write- SDK parameters
data: TaskRecurrencePreviewInputoptions: RequestOptions- Request body
TaskRecurrencePreviewInputapplication/json- Success
200 TaskRecurrencePreview envelope202 TaskRecurrenceOperation envelope
/task-recurrences/{id}taskRecurrences.get
Use this operation to get a task recurrence. 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.taskRecurrences.get(id: string, options: RequestOptions = {})- Return form
Promise- Operation ID
getTaskRecurrence- Required scopes
task-recurrences:readtasks:read- SDK parameters
id: stringoptions: RequestOptions- Path request fields
id: string- Success
200 TaskRecurrence envelope
/task-recurrences/{id}taskRecurrences.update
Use this operation to update a task recurrence. Only documented mutable fields are accepted; omitted fields retain their current values unless the request schema states replacement semantics. 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.taskRecurrences.update(id: string, data: TaskRecurrenceUpdate, options: TaskRecurrenceMutationOptions)- Return form
Promise- Operation ID
updateTaskRecurrence- Required scopes
task-recurrences:writetasks:readtasks:write- SDK parameters
id: stringdata: TaskRecurrenceUpdateoptions: TaskRecurrenceMutationOptions- Path request fields
id: string- Header request fields
If-Match: string- Request body
TaskRecurrenceUpdateapplication/json- Success
200 TaskRecurrence envelope
/task-recurrences/{id}taskRecurrences.archive
Use this operation to archive a task recurrence. 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. Send the latest strong ETag in If-Match; stale revisions fail without overwriting a concurrent change.
client.taskRecurrences.archive(id: string, options: TaskRecurrenceMutationOptions)- Return form
Promise- Operation ID
archiveTaskRecurrence- Required scopes
task-recurrences:writetasks:readtasks:write- SDK parameters
id: stringoptions: TaskRecurrenceMutationOptions- Path request fields
id: string- Header request fields
If-Match: string- Success
200 TaskRecurrence envelope
/task-recurrences/{id}/previewtaskRecurrences.previewStored
Use this operation to preview a stored task recurrence. 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.taskRecurrences.previewStored(id: string, options: TaskRecurrenceStoredPreviewOptions = {})- Return form
Promise- Operation ID
previewStoredTaskRecurrence- Required scopes
task-recurrences:readtasks:read- SDK parameters
id: stringoptions: TaskRecurrenceStoredPreviewOptions- Path request fields
id: string- Query request fields
from?: stringuntil?: stringcount?: integer- Success
200 TaskRecurrencePreview envelope
/task-recurrences/{id}/restoretaskRecurrences.restore
Use this operation to restore a task recurrence. 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.taskRecurrences.restore(id: string, options: TaskRecurrenceMutationOptions)- Return form
Promise- Operation ID
restoreTaskRecurrence- Required scopes
task-recurrences:writetasks:readtasks:write- SDK parameters
id: stringoptions: TaskRecurrenceMutationOptions- Path request fields
id: string- Header request fields
If-Match: string- Success
200 TaskRecurrence envelope
/task-recurrences/{id}/pausetaskRecurrences.pause
Use this operation to pause a task recurrence. 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.taskRecurrences.pause(id: string, options: TaskRecurrenceMutationOptions)- Return form
Promise- Operation ID
pauseTaskRecurrence- Required scopes
task-recurrences:writetasks:readtasks:write- SDK parameters
id: stringoptions: TaskRecurrenceMutationOptions- Path request fields
id: string- Header request fields
If-Match: string- Success
200 TaskRecurrence envelope
/task-recurrences/{id}/resumetaskRecurrences.resume
Use this operation to resume a task recurrence. 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.taskRecurrences.resume(id: string, options: TaskRecurrenceMutationOptions)- Return form
Promise- Operation ID
resumeTaskRecurrence- Required scopes
task-recurrences:writetasks:readtasks:write- SDK parameters
id: stringoptions: TaskRecurrenceMutationOptions- Path request fields
id: string- Header request fields
If-Match: string- Success
200 TaskRecurrence envelope
/task-recurrences/{id}/endtaskRecurrences.end
Use this operation to end a task recurrence. 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.taskRecurrences.end(id: string, options: TaskRecurrenceMutationOptions)- Return form
Promise- Operation ID
endTaskRecurrence- Required scopes
task-recurrences:writetasks:readtasks:write- SDK parameters
id: stringoptions: TaskRecurrenceMutationOptions- Path request fields
id: string- Header request fields
If-Match: string- Success
200 TaskRecurrence envelope
/task-recurrences/{id}/remove-from-taskstaskRecurrences.removeFromTasks
Use this operation to remove a task recurrence from its tasks. 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.taskRecurrences.removeFromTasks(id: string, options: TaskRecurrenceMutationOptions)- Return form
Promise- Operation ID
removeTaskRecurrenceFromTasks- Required scopes
task-recurrences:writetasks:readtasks:write- SDK parameters
id: stringoptions: TaskRecurrenceMutationOptions- Path request fields
id: string- Header request fields
If-Match: string- Success
200 TaskRecurrence envelope
/task-recurrences/{id}/ownertaskRecurrences.transferOwner
Use this operation to transfer task recurrence ownership. 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.taskRecurrences.transferOwner(id: string, data: TaskRecurrenceOwnerUpdate, options: TaskRecurrenceMutationOptions)- Return form
Promise- Operation ID
transferTaskRecurrenceOwner- Required scopes
task-recurrences:writetasks:readtasks:write- SDK parameters
id: stringdata: TaskRecurrenceOwnerUpdateoptions: TaskRecurrenceMutationOptions- Path request fields
id: string- Header request fields
If-Match: string- Request body
TaskRecurrenceOwnerUpdateapplication/json- Success
200 TaskRecurrence envelope
/task-recurrences/{id}/definition-from-tasktaskRecurrences.applyTaskTemplate
Use this operation to replace a recurrence template from a task. 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.taskRecurrences.applyTaskTemplate(id: string, data: TaskRecurrenceTaskTemplateUpdate, options: TaskRecurrenceMutationOptions)- Return form
Promise- Operation ID
applyTaskAsTaskRecurrenceTemplate- Required scopes
task-recurrences:writetasks:readtasks:write- SDK parameters
id: stringdata: TaskRecurrenceTaskTemplateUpdateoptions: TaskRecurrenceMutationOptions- Path request fields
id: string- Header request fields
If-Match: string- Request body
TaskRecurrenceTaskTemplateUpdateapplication/json- Success
200 TaskRecurrence envelope
/task-recurrences/{id}/rechecktaskRecurrences.recheck
Use this operation to recheck a task recurrence asynchronously. 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.taskRecurrences.recheck(id: string, options: RequestOptions = {})- Return form
Promise- Operation ID
recheckTaskRecurrence- Required scopes
task-recurrences:writetasks:readtasks:write- SDK parameters
id: stringoptions: RequestOptions- Path request fields
id: string- Success
202 TaskRecurrenceOperation envelope
/task-recurrences/{id}/eventstaskRecurrences.submitEvent
Use this operation to submit an event to a task recurrence. 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.taskRecurrences.submitEvent(id: string, data: TaskRecurrenceEventSubmit, options: RequestOptions = {})- Return form
Promise- Operation ID
submitTaskRecurrenceEvent- Required scopes
task-recurrences:runtasks:write- SDK parameters
id: stringdata: TaskRecurrenceEventSubmitoptions: RequestOptions- Path request fields
id: string- Request body
TaskRecurrenceEventSubmitapplication/json- Success
202 TaskRecurrenceEvent envelope
Convenience helpers
These typed helpers compose mapped operations. They do not grant scopes or bypass API limits.
taskRecurrences.pages
Iterate cursor pages with a bounded PaginationOptions policy.
client.taskRecurrences.pages(options: TaskRecurrenceListOptions = {}, 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.