Skip to main content

SyncCommandsMap

type SyncCommandsMap = {
  accept_invitation: AcceptInvitationArgs;
  biz_accept_invitation: BizAcceptInvitationArgs;
  biz_reject_invitation: BizRejectInvitationArgs;
  calendar_account_restore_task_calendar: CalendarAccountRestoreTaskCalendarArgs;
  calendar_account_update: CalendarAccountUpdateArgs;
  calendar_update: CalendarUpdateArgs;
  delete_collaborator: DeleteCollaboratorArgs;
  filter_add: FilterAddArgs;
  filter_delete: FilterDeleteArgs;
  filter_update: FilterUpdateArgs;
  filter_update_orders: FilterUpdateOrdersArgs;
  folder_add: FolderAddArgs;
  folder_delete: FolderDeleteArgs;
  folder_update: FolderUpdateArgs;
  id_mapping: IdMappingArgs;
  item_add: TaskAddArgs;
  item_complete: TaskCompleteArgs;
  item_complete_undo: TaskCompleteUndoArgs;
  item_delete: TaskDeleteArgs;
  item_move: TaskMoveArgs;
  item_reorder: TaskReorderArgs;
  item_uncomplete: TaskUncompleteArgs;
  item_update: TaskUpdateArgs;
  item_update_date_complete: TaskUpdateDateCompleteArgs;
  item_update_day_orders: TaskUpdateDayOrderArgs;
  label_add: LabelAddArgs;
  label_delete: LabelDeleteArgs;
  label_delete_occurrences: LabelDeleteOccurrencesArgs;
  label_rename: LabelRenameArgs;
  label_update: LabelUpdateArgs;
  label_update_orders: LabelUpdateOrdersArgs;
  live_notifications_mark_read: LiveNotificationsMarkReadArgs;
  live_notifications_mark_read_all: LiveNotificationsMarkReadAllArgs;
  live_notifications_mark_unread: LiveNotificationsMarkUnreadArgs;
  live_notifications_set_last_read: LiveNotificationsSetLastReadArgs;
  note_add: NoteAddArgs;
  note_delete: NoteDeleteArgs;
  note_reaction_add: NoteReactionAddArgs;
  note_reaction_remove: NoteReactionRemoveArgs;
  note_update: NoteUpdateArgs;
  project_add: ProjectAddArgs;
  project_archive: ProjectArchiveArgs;
  project_delete: ProjectDeleteArgs;
  project_leave: ProjectLeaveArgs;
  project_move: ProjectMoveArgs;
  project_move_to_personal: ProjectMoveToPersonalArgs;
  project_move_to_workspace: ProjectMoveToWorkspaceArgs;
  project_reorder: ProjectReorderArgs;
  project_unarchive: ProjectUnarchiveArgs;
  project_update: ProjectUpdateArgs;
  project_view_options_defaults_set: ProjectViewOptionsDefaultsSetArgs;
  reject_invitation: RejectInvitationArgs;
  reminder_add: ReminderAddArgs;
  reminder_delete: ReminderDeleteArgs;
  reminder_update: ReminderUpdateArgs;
  section_add: SectionAddArgs;
  section_archive: SectionArchiveArgs;
  section_delete: SectionDeleteArgs;
  section_move: SectionMoveArgs;
  section_reorder: SectionReorderArgs;
  section_unarchive: SectionUnarchiveArgs;
  section_update: SectionUpdateArgs;
  share_project: ShareProjectArgs;
  suggestion_delete: SuggestionDeleteArgs;
  update_goals: UpdateGoalsArgs;
  user_settings_update: UserSettingsUpdateArgs;
  user_update: UserUpdateArgs;
  view_options_delete: ViewOptionsDeleteArgs;
  view_options_set: ViewOptionsSetArgs;
  workspace_add: WorkspaceAddArgs;
  workspace_delete: WorkspaceDeleteArgs;
  workspace_delete_user: WorkspaceDeleteUserArgs;
  workspace_filter_add: WorkspaceFilterAddArgs;
  workspace_filter_delete: WorkspaceFilterDeleteArgs;
  workspace_filter_update: WorkspaceFilterUpdateArgs;
  workspace_filter_update_orders: WorkspaceFilterUpdateOrdersArgs;
  workspace_invite: WorkspaceInviteArgs;
  workspace_leave: WorkspaceLeaveArgs;
  workspace_set_default_project_ordering: WorkspaceSetDefaultOrderArgs;
  workspace_update: WorkspaceUpdateArgs;
  workspace_update_user: WorkspaceUpdateUserArgs;
  workspace_update_user_project_sort_preference: WorkspaceUpdateUserProjectSortPreferenceArgs;
};

Maps each Sync API command type string to its corresponding argument type.

Example​

// TypeScript will enforce the correct args shape:
const command: SyncCommand<'item_add'> = {
    type: 'item_add',
    uuid: '...',
    args: { content: 'Buy milk' } // Must satisfy TaskAddArgs
}

Properties​

accept_invitation​

accept_invitation: AcceptInvitationArgs;

biz_accept_invitation​

biz_accept_invitation: BizAcceptInvitationArgs;

biz_reject_invitation​

biz_reject_invitation: BizRejectInvitationArgs;

calendar_account_restore_task_calendar​

calendar_account_restore_task_calendar: CalendarAccountRestoreTaskCalendarArgs;

calendar_account_update​

calendar_account_update: CalendarAccountUpdateArgs;

calendar_update​

calendar_update: CalendarUpdateArgs;

delete_collaborator​

delete_collaborator: DeleteCollaboratorArgs;

filter_add​

filter_add: FilterAddArgs;

filter_delete​

filter_delete: FilterDeleteArgs;

filter_update​

filter_update: FilterUpdateArgs;

filter_update_orders​

filter_update_orders: FilterUpdateOrdersArgs;

folder_add​

folder_add: FolderAddArgs;

folder_delete​

folder_delete: FolderDeleteArgs;

folder_update​

folder_update: FolderUpdateArgs;

id_mapping​

id_mapping: IdMappingArgs;

item_add​

item_add: TaskAddArgs;

item_complete​

item_complete: TaskCompleteArgs;

item_complete_undo​

item_complete_undo: TaskCompleteUndoArgs;

item_delete​

item_delete: TaskDeleteArgs;

item_move​

item_move: TaskMoveArgs;

item_reorder​

item_reorder: TaskReorderArgs;

item_uncomplete​

item_uncomplete: TaskUncompleteArgs;

item_update​

item_update: TaskUpdateArgs;

item_update_date_complete​

item_update_date_complete: TaskUpdateDateCompleteArgs;

item_update_day_orders​

item_update_day_orders: TaskUpdateDayOrderArgs;

label_add​

label_add: LabelAddArgs;

label_delete​

label_delete: LabelDeleteArgs;

label_delete_occurrences​

label_delete_occurrences: LabelDeleteOccurrencesArgs;

label_rename​

label_rename: LabelRenameArgs;

label_update​

label_update: LabelUpdateArgs;

label_update_orders​

label_update_orders: LabelUpdateOrdersArgs;

live_notifications_mark_read​

live_notifications_mark_read: LiveNotificationsMarkReadArgs;

live_notifications_mark_read_all​

live_notifications_mark_read_all: LiveNotificationsMarkReadAllArgs;

live_notifications_mark_unread​

live_notifications_mark_unread: LiveNotificationsMarkUnreadArgs;

live_notifications_set_last_read​

live_notifications_set_last_read: LiveNotificationsSetLastReadArgs;

note_add​

note_add: NoteAddArgs;

note_delete​

note_delete: NoteDeleteArgs;

note_reaction_add​

note_reaction_add: NoteReactionAddArgs;

note_reaction_remove​

note_reaction_remove: NoteReactionRemoveArgs;

note_update​

note_update: NoteUpdateArgs;

project_add​

project_add: ProjectAddArgs;

project_archive​

project_archive: ProjectArchiveArgs;

project_delete​

project_delete: ProjectDeleteArgs;

project_leave​

project_leave: ProjectLeaveArgs;

project_move​

project_move: ProjectMoveArgs;

project_move_to_personal​

project_move_to_personal: ProjectMoveToPersonalArgs;

project_move_to_workspace​

project_move_to_workspace: ProjectMoveToWorkspaceArgs;

project_reorder​

project_reorder: ProjectReorderArgs;

project_unarchive​

project_unarchive: ProjectUnarchiveArgs;

project_update​

project_update: ProjectUpdateArgs;

project_view_options_defaults_set​

project_view_options_defaults_set: ProjectViewOptionsDefaultsSetArgs;

reject_invitation​

reject_invitation: RejectInvitationArgs;

reminder_add​

reminder_add: ReminderAddArgs;

reminder_delete​

reminder_delete: ReminderDeleteArgs;

reminder_update​

reminder_update: ReminderUpdateArgs;

section_add​

section_add: SectionAddArgs;

section_archive​

section_archive: SectionArchiveArgs;

section_delete​

section_delete: SectionDeleteArgs;

section_move​

section_move: SectionMoveArgs;

section_reorder​

section_reorder: SectionReorderArgs;

section_unarchive​

section_unarchive: SectionUnarchiveArgs;

section_update​

section_update: SectionUpdateArgs;

share_project​

share_project: ShareProjectArgs;

suggestion_delete​

suggestion_delete: SuggestionDeleteArgs;

update_goals​

update_goals: UpdateGoalsArgs;

user_settings_update​

user_settings_update: UserSettingsUpdateArgs;

user_update​

user_update: UserUpdateArgs;

view_options_delete​

view_options_delete: ViewOptionsDeleteArgs;

view_options_set​

view_options_set: ViewOptionsSetArgs;

workspace_add​

workspace_add: WorkspaceAddArgs;

workspace_delete​

workspace_delete: WorkspaceDeleteArgs;

workspace_delete_user​

workspace_delete_user: WorkspaceDeleteUserArgs;

workspace_filter_add​

workspace_filter_add: WorkspaceFilterAddArgs;

workspace_filter_delete​

workspace_filter_delete: WorkspaceFilterDeleteArgs;

workspace_filter_update​

workspace_filter_update: WorkspaceFilterUpdateArgs;

workspace_filter_update_orders​

workspace_filter_update_orders: WorkspaceFilterUpdateOrdersArgs;

workspace_invite​

workspace_invite: WorkspaceInviteArgs;

workspace_leave​

workspace_leave: WorkspaceLeaveArgs;

workspace_set_default_project_ordering​

workspace_set_default_project_ordering: WorkspaceSetDefaultOrderArgs;

workspace_update​

workspace_update: WorkspaceUpdateArgs;

workspace_update_user​

workspace_update_user: WorkspaceUpdateUserArgs;

workspace_update_user_project_sort_preference​

workspace_update_user_project_sort_preference: WorkspaceUpdateUserProjectSortPreferenceArgs;