@codecks/fetch 1.0.1 → 2.0.0

package/schema/actions.md

@@ -0,0 +1,789 @@
+# Actions
+
+Every change goes through an action, sent with `dispatch`. It returns the action's response, or `undefined` for an action without one.
+
+```ts
+const {id, accountSeq} = await dispatch("cards/create", {content: "Fix login", deckId});
+await dispatch("cards/update", {id, status: "done"});
+```
+
+An enum in the params lists only the values the API accepts, unlike the open enums of the models. A param that is optional and nullable has three meanings: left out, it stays as it is; `null` clears it; a value sets it.
+
+## bookmarks/addCards
+
+Bookmarks cards for a user, at the end of their bookmarks. Cards that are already bookmarked move to the end.
+
+Requires `handCard:writeOwn` or `handCard:writeAny`, depending on the call.
+
+Params:
+
+- `ids`: [`CardId`](models/card.md)`[]`
+- `userId`: [`UserId`](models/user.md)
+
+Response: none.
+
+## bookmarks/removeCards
+
+Removes cards from a user's bookmarks.
+
+Requires `handCard:writeOwn` or `handCard:writeAny`, depending on the call.
+
+Params:
+
+- `ids`: [`CardId`](models/card.md)`[]`
+- `userId`: [`UserId`](models/user.md)
+
+Response: none.
+
+## bookmarks/setOrders
+
+Moves cards to the top of a user's bookmarks, in the given order. The other bookmarks follow in their current order. Cards that aren't bookmarked yet get bookmarked.
+
+Requires `handCard:writeOwn` or `handCard:writeAny`, depending on the call.
+
+Params:
+
+- `cardIds`: [`CardId`](models/card.md)`[]`
+- `userId`: [`UserId`](models/user.md)
+
+Response: none.
+
+## cardOrders/addAfter
+
+Puts cards into a manual order right after `targetId`, in the order of `cardIds`, and into the zone `label`.
+
+**preview**: this action may change in any release. Each change is listed in the [API changelog](https://manual.codecks.io/api-changelog/).
+
+Requires `cardOrder:write`.
+
+Params:
+
+- `targetId`: [`CardId`](models/card.md)` | null`
+  `null` puts the cards at the end.
+- `cardIds`: [`CardId`](models/card.md)`[]`
+- `context`: `"milestone" | "deck" | "sprint"`
+  Which manual order to change: the one of the cards' deck, milestone or run. A card has one position in each.
+- `label`: `string | null`
+  The zone, one of the `manualOrderLabels` of the deck, milestone or run. `null` is the zone without a name.
+
+Response: none.
+
+## cardOrders/addBefore
+
+Puts cards into a manual order right before `targetId`, in the order of `cardIds`, and into the zone `label`.
+
+**preview**: this action may change in any release. Each change is listed in the [API changelog](https://manual.codecks.io/api-changelog/).
+
+Requires `cardOrder:write`.
+
+Params:
+
+- `targetId`: [`CardId`](models/card.md)` | null`
+  `null` puts the cards at the start.
+- `cardIds`: [`CardId`](models/card.md)`[]`
+- `context`: `"milestone" | "deck" | "sprint"`
+  Which manual order to change: the one of the cards' deck, milestone or run. A card has one position in each.
+- `label`: `string | null`
+  The zone, one of the `manualOrderLabels` of the deck, milestone or run. `null` is the zone without a name.
+
+Response: none.
+
+## cardOrders/updateLabel
+
+Moves cards into another zone of a manual order and keeps their position. Cards that have no position in that order yet are skipped.
+
+**preview**: this action may change in any release. Each change is listed in the [API changelog](https://manual.codecks.io/api-changelog/).
+
+Requires `cardOrder:write`.
+
+Params:
+
+- `cardIds`: [`CardId`](models/card.md)`[]`
+- `context`: `"milestone" | "deck" | "sprint"`
+  Which manual order to change: the one of the cards' deck, milestone or run. A card has one position in each.
+- `label`: `string | null`
+  The zone, one of the `manualOrderLabels` of the deck, milestone or run. `null` is the zone without a name.
+
+Response: none.
+
+## cards/bulkUpdate
+
+Sets the same values on every card in `ids`. Look at `cards/update` for the property details.
+
+Requires `card:write`.
+
+Params:
+
+- `ids`: [`CardId`](models/card.md)`[]`
+- `priority`: `"a" | "b" | "c" | null` (optional)
+- `effort`: `number | null` (optional)
+- `status`: `"not_started" | "started" | "done"` (optional)
+- `assigneeId`: [`UserId`](models/user.md)` | null` (optional)
+- `deckId`: [`DeckId`](models/deck.md) (optional)
+- `visibility`: `"default" | "archived" | "deleted"` (optional)
+- `milestoneId`: [`MilestoneId`](models/milestone.md)` | null` (optional)
+- `sprintId`: [`SprintId`](models/sprint.md)` | null` (optional)
+- `dueDate`: `string | null` (optional)
+  `YYYY-MM-DD`, or `null` to remove it. Fails unless the organization's plan includes due dates.
+- `isDoc`: `boolean` (optional)
+- `addMasterTag`: `string` (optional)
+  Adds this tag to every card's `masterTags`.
+- `removeMasterTag`: `string` (optional)
+  Removes this tag from every card, ignoring case.
+- `parentCardId`: [`CardId`](models/card.md)` | null` (optional)
+
+Response: none.
+
+## cards/copy
+
+Copies each card into a deck, as `not_started` and with the same `content`. A copied sub card is added to its hero card right after the original.
+
+**preview**: this action may change in any release. Each change is listed in the [API changelog](https://manual.codecks.io/api-changelog/).
+
+Requires `card:write`.
+
+Params:
+
+- `ids`: [`CardId`](models/card.md)`[]`
+- `props`: `("effort" | "priority" | "assigneeId" | "masterTags" | "attachments" | "milestoneId" | "sprintId")[]`
+  The fields to copy besides `content`.
+- `target`: `string`
+  The id of the deck to copy into.
+
+Response: none.
+
+## cards/create
+
+Creates a card as `not_started`. The first line of `content` becomes its `title`. Everyone mentioned in `content` is subscribed to the card.
+
+Requires `card:write`.
+
+Params:
+
+- `content`: `string`
+  Markdown. Its first line becomes the card's `title`.
+- `priority`: `"a" | "b" | "c" | null` (optional)
+- `effort`: `number | null` (optional)
+- `assigneeId`: [`UserId`](models/user.md)` | null` (optional)
+- `deckId`: [`DeckId`](models/deck.md)` | null`
+  `null` creates a private card, and bookmarks it for you.
+- `masterTags`: `string[]` (optional)
+  Project tags, on top of those written as `#tag` in `content`.
+- `milestoneId`: [`MilestoneId`](models/milestone.md)` | null` (optional)
+- `sprintId`: [`SprintId`](models/sprint.md)` | null` (optional)
+- `parentCardId`: [`CardId`](models/card.md)` | null` (optional)
+  Adds the card as the last sub card of this hero card.
+- `dueDate`: `string | null` (optional)
+  `YYYY-MM-DD`. Fails unless the organization's plan includes due dates.
+- `isDoc`: `boolean` (optional)
+- `addAsBookmark`: `boolean` (optional)
+  Bookmarks the card for you.
+- `putInQueue`: `boolean` (optional)
+  Adds the card to its assignee's Hand, or to yours when it has none. Fails when that Hand has no free slot (`account.maxHandSlotCount`).
+- `subscribeCreator`: `boolean` (optional)
+  Subscribes you to the card, so you're notified about its changes and comments.
+
+Response:
+
+- `id`: [`CardId`](models/card.md)
+- `accountSeq`: `number`
+  The card's number, see `card.accountSeq`.
+
+## cards/createMany
+
+Creates cards in one deck and returns their ids in the same order. Unlike `cards/create`, it doesn't subscribe you to them.
+
+Requires `card:write`.
+
+Params:
+
+- `cards`: `{content: string; priority?: "a" | "b" | "c" | null; effort?: number | null; assigneeId?: UserId | null; isDoc?: boolean; visibility?: "archived" | "default" | "deleted"; status?: "not_started" | "started" | "done" | null}[]` (uses [`UserId`](models/user.md))
+  The first line of each `content` becomes the card's `title`. `status` defaults to `not_started`, `visibility` to `default`.
+- `deckId`: [`DeckId`](models/deck.md)
+- `parentCardId`: [`CardId`](models/card.md)` | null` (optional)
+  Adds the cards as the last sub cards of this hero card.
+
+Response:
+
+- `cards`: `{id: CardId; accountSeq: number}[]` (uses [`CardId`](models/card.md))
+
+## cards/update
+
+Changes the given fields of a card. Some writes change other fields too: `content` sets `title` and `tags`, and giving a started card another assignee sets it back to `not_started`.
+
+Requires `card:write`.
+
+Params:
+
+- `id`: [`CardId`](models/card.md)
+- `content`: `string` (optional)
+  Markdown. Its first line becomes the card's `title`.
+- `priority`: `"a" | "b" | "c" | null` (optional)
+- `effort`: `number | null` (optional)
+- `status`: `"not_started" | "started" | "done"` (optional)
+  A Hero Card can't be started.
+- `assigneeId`: [`UserId`](models/user.md)` | null` (optional)
+- `deckId`: [`DeckId`](models/deck.md) (optional)
+- `masterTags`: `string[]` (optional)
+  Replaces the project tags. Those written as `#tag` in `content` stay.
+- `visibility`: `"default" | "archived" | "deleted"` (optional)
+  Archiving or deleting a started card sets it back to `not_started`. Deleting also removes its dependencies.
+- `milestoneId`: [`MilestoneId`](models/milestone.md)` | null` (optional)
+- `sprintId`: [`SprintId`](models/sprint.md)` | null` (optional)
+- `parentCardId`: [`CardId`](models/card.md)` | null` (optional)
+  The hero card to make this card a sub card of.
+- `childCards`: [`CardId`](models/card.md)`[] | null` (optional) — **preview**
+  A hero card's sub cards, in order.
+- `inDeps`: [`CardId`](models/card.md)`[]` (optional) — **preview**
+  The cards that have to be done before this one. Fails when it would make a cycle.
+- `outDeps`: [`CardId`](models/card.md)`[]` (optional) — **preview**
+  The cards that are blocked by this one.
+- `dueDate`: `string | null` (optional)
+  `YYYY-MM-DD`, or `null` to remove it. Fails unless the organization's plan includes due dates.
+- `isDoc`: `boolean` (optional)
+
+Response: none.
+
+## cards/updateMany
+
+Updates several cards, each with its own values. Cards that don't exist or that you can't see are skipped.
+
+Requires `card:write`.
+
+Params:
+
+- `cards`: `{id: CardId; content?: string | null; title?: string | null; priority?: "a" | "b" | "c" | null; effort?: number | null; assigneeId?: UserId | null; isDoc?: boolean; visibility?: "archived" | "default" | "deleted"; status?: "not_started" | "started" | "done" | null; masterTags?: string[]}[]` (uses [`CardId`](models/card.md), [`UserId`](models/user.md))
+  Each needs a `content` or a `title`. With both, the content becomes the title, an empty line and `content`. A `title` alone replaces the first line of the current content. Project tags in `masterTags` that the project doesn't have yet are created.
+
+Response: none.
+
+## decks/addToSpaceAfter
+
+Moves decks into a project's space, right after `targetId` and in the order of `deckIds`. Decks from another project move with their cards.
+
+**preview**: this action may change in any release. Each change is listed in the [API changelog](https://manual.codecks.io/api-changelog/).
+
+Requires `deck:write`.
+
+Params:
+
+- `deckIds`: [`DeckId`](models/deck.md)`[]`
+- `targetId`: [`DeckId`](models/deck.md)` | null`
+  `null` puts the decks at the end of the space.
+- `targetProjectId`: [`ProjectId`](models/project.md)
+- `targetSpaceId`: `number`
+  One of the ids in `project.spaces`.
+
+Response: none.
+
+## decks/addToSpaceBefore
+
+Moves decks into a project's space, right before `targetId` and in the order of `deckIds`. Decks from another project move with their cards.
+
+**preview**: this action may change in any release. Each change is listed in the [API changelog](https://manual.codecks.io/api-changelog/).
+
+Requires `deck:write`.
+
+Params:
+
+- `deckIds`: [`DeckId`](models/deck.md)`[]`
+- `targetId`: [`DeckId`](models/deck.md)` | null`
+  `null` puts the decks at the start of the space.
+- `targetProjectId`: [`ProjectId`](models/project.md)
+- `targetSpaceId`: `number`
+  One of the ids in `project.spaces`.
+
+Response: none.
+
+## decks/create
+
+Creates a deck at the end of the project's first space. `deckType` defaults to that space's `defaultDeckType`.
+
+Requires `deck:write`.
+
+Params:
+
+- `title`: `string`
+- `projectId`: [`ProjectId`](models/project.md)
+- `coverColor`: `string | null` (optional) — **preview**
+  A hex color like `#ff8800`.
+- `deckType`: `"task" | "hero" | "doc" | "mixed"` (optional)
+
+Response:
+
+- `id`: [`DeckId`](models/deck.md)
+
+## decks/delete
+
+Sets `isDeleted` on the deck and archives its cards, their sub cards in other decks, and the journey steps that create cards in this deck.
+
+Requires `deck:delete`.
+
+Params:
+
+- `id`: [`DeckId`](models/deck.md)
+
+Response: none.
+
+## decks/renameZone
+
+Renames a zone of the deck's manual order. The cards in that zone move to the new name with it, including archived ones.
+
+**preview**: this action may change in any release. Each change is listed in the [API changelog](https://manual.codecks.io/api-changelog/).
+
+Requires `deck:write` and `cardOrder:write`.
+
+Params:
+
+- `id`: [`DeckId`](models/deck.md)
+- `label`: `string | null`
+  The zone to rename, one of `manualOrderLabels`. `null` is the zone without a name.
+- `newLabel`: `string`
+  Trimmed. Fails if the deck already has a zone with that name.
+
+Response: none.
+
+## decks/update
+
+Requires `deck:write` or `project:write`, depending on the call.
+
+Params:
+
+- `id`: [`DeckId`](models/deck.md)
+- `milestoneId`: [`MilestoneId`](models/milestone.md)` | null` (optional)
+  Also puts the deck's cards that aren't archived or deleted into this milestone. `null` only takes it from cards that were in the deck's old milestone.
+- `title`: `string` (optional)
+- `description`: `string` (optional)
+- `handSyncEnabled`: `boolean` (optional) — **preview**
+  Turning it on adds the deck's assigned cards that aren't done to their assignee's Hand.
+- `defaultProjectTagId`: [`ProjectTagId`](models/projectTag.md)` | null` (optional)
+  The deck's auto tag. Changing it removes the old tag from all of the deck's cards and adds the new one.
+- `manualOrderLabels`: `(string | null)[]` (optional) — **preview**
+  The zone names are trimmed, and duplicates are dropped. Renaming a zone here leaves its cards with the old name; use `decks/renameZone` instead.
+- `coverColor`: `string | null` (optional) — **preview**
+  A hex color like `#ff8800`.
+- `deckType`: `"task" | "hero" | "doc" | "mixed"` (optional)
+  Switching to `hero` sets the deck's started cards back to `not_started`. Switching to `hero` or `doc` fails while journey steps create their cards in this deck.
+
+Response: none.
+
+## decks/updateGuardians
+
+Sets the deck's guardians to exactly `userIds` and updates `hasGuardians`. Fails unless the organization's plan includes guardians or `userIds` is empty.
+
+**preview**: this action may change in any release. Each change is listed in the [API changelog](https://manual.codecks.io/api-changelog/).
+
+Requires `deckGuardian:write`.
+
+Params:
+
+- `id`: [`DeckId`](models/deck.md)
+- `userIds`: [`UserId`](models/user.md)`[]`
+
+Response: none.
+
+## handQueue/addCardsToHand
+
+Adds cards to the end of a user's Hand. Cards that are done, deleted, archived or already in that Hand are skipped. A card without an owner gets the user as owner. Fails when the Hand doesn't have enough free slots (`account.maxHandSlotCount`).
+
+Requires `queueEntry:write`.
+
+Params:
+
+- `cardIds`: [`CardId`](models/card.md)`[]`
+- `userId`: [`UserId`](models/user.md)
+
+Response:
+
+- `queueEntries`: `{id: QueueEntryId; cardId: CardId}[]` (uses [`QueueEntryId`](models/queueEntry.md), [`CardId`](models/card.md))
+  The new entries, one for each added card.
+
+## handQueue/removeCards
+
+Removes cards from a user's Hand, or from every Hand when `userId` is left out. This includes entries in the done pile.
+
+Requires `queueEntry:write`.
+
+Params:
+
+- `cardIds`: [`CardId`](models/card.md)`[]`
+- `userId`: [`UserId`](models/user.md) (optional)
+
+Response: none.
+
+## handQueue/setCardOrders
+
+Sets the order of a user's Hand and can add cards to it. A card added this way that has no owner gets the user as owner. Fails when the Hand doesn't have enough free slots for the added cards (`account.maxHandSlotCount`).
+
+Requires `queueEntry:write`.
+
+Params:
+
+- `cardIds`: [`CardId`](models/card.md)`[]`
+  The new order from the first card on. Cards of the Hand that are missing here follow in their current order. Cards that are neither in the Hand nor in `draggedCardIds` are ignored.
+- `draggedCardIds`: [`CardId`](models/card.md)`[]`
+  The cards that moved, from within the Hand or from outside. Cards from outside are added. Nothing changes if it is empty or none of them can be in a Hand, e.g. because they are deleted.
+- `userId`: [`UserId`](models/user.md)
+
+Response:
+
+- `queueEntries`: `{id: QueueEntryId; cardId: CardId}[]` (uses [`QueueEntryId`](models/queueEntry.md), [`CardId`](models/card.md))
+  The Hand's entries after the change.
+
+## milestones/create
+
+Creates a milestone for the projects in `projectIds`, or for all projects with `isGlobal`.
+
+Requires `milestone:write`.
+
+Params:
+
+- `accountId`: [`AccountId`](models/account.md)
+- `name`: `string`
+- `description`: `string` (optional)
+- `color`: `"gray" | "brown" | "yellow" | "red" | "pink" | "blue" | "green"`
+- `date`: `string`
+  `YYYY-MM-DD`.
+- `startDate`: `string | null` (optional)
+  `YYYY-MM-DD`.
+- `isGlobal`: `boolean`
+- `projectIds`: [`ProjectId`](models/project.md)`[] | null`
+  Ignored when `isGlobal` is set.
+
+Response:
+
+- `id`: [`MilestoneId`](models/milestone.md)
+- `accountSeq`: `number`
+  The milestone's number, see `milestone.accountSeq`.
+
+## milestones/delete
+
+Marks a milestone as deleted (`isDeleted`). It's removed from all its cards and decks, and nobody has it pinned anymore.
+
+Requires `milestone:write`.
+
+Params:
+
+- `id`: [`MilestoneId`](models/milestone.md)
+
+Response: none.
+
+## milestones/pin
+
+Pins a milestone for a user. The web app shows it in the user's Hand. A user has one pinned milestone per organization, so pinning another one replaces it.
+
+**preview**: this action may change in any release. Each change is listed in the [API changelog](https://manual.codecks.io/api-changelog/).
+
+Requires `pinnedMilestone:writeOwn` or `pinnedMilestone:writeAny`, depending on the call.
+
+Params:
+
+- `milestoneId`: [`MilestoneId`](models/milestone.md)` | null`
+  `null` removes the user's pin.
+- `userId`: [`UserId`](models/user.md)
+  The token's own user. For a personal token, that's you.
+
+Response: none.
+
+## milestones/renameZone
+
+Renames a zone of the milestone's manual order. The cards in that zone move to the new name with it, including archived ones.
+
+**preview**: this action may change in any release. Each change is listed in the [API changelog](https://manual.codecks.io/api-changelog/).
+
+Requires `milestone:write` and `cardOrder:write`.
+
+Params:
+
+- `id`: [`MilestoneId`](models/milestone.md)
+- `label`: `string | null`
+  The zone to rename, one of `manualOrderLabels`. `null` is the zone without a name.
+- `newLabel`: `string`
+  Trimmed. Fails if the milestone already has a zone with that name.
+
+Response: none.
+
+## milestones/update
+
+Requires `milestone:write`.
+
+Params:
+
+- `id`: [`MilestoneId`](models/milestone.md)
+- `name`: `string` (optional)
+- `description`: `string` (optional)
+- `color`: `"gray" | "brown" | "yellow" | "red" | "pink" | "blue" | "green"` (optional)
+- `date`: `string` (optional)
+  `YYYY-MM-DD`.
+- `startDate`: `string | null` (optional)
+  `YYYY-MM-DD`, or `null` to remove it.
+- `handSyncEnabled`: `boolean` (optional) — **preview**
+  Turning it on also adds the milestone's cards that are not done and have an assignee to the assignee's Hand.
+- `isGlobal`: `boolean` (optional)
+  `true` links the milestone to all projects. `false` needs `projectIds` if the milestone is global.
+- `projectIds`: [`ProjectId`](models/project.md)`[] | null` (optional)
+  Replaces the milestone's projects and makes it non-global. Ignored with `isGlobal: true`. Cards and decks of projects that are removed lose the milestone.
+- `manualOrderLabels`: `(string | null)[]` (optional) — **preview**
+  Labels are trimmed, and duplicates are removed. Renaming a zone here leaves its cards with the old name; use `milestones/renameZone` instead.
+- `userCapacities`: `{[key: string]: number}` (optional) — **preview**
+  Replaces all capacities. Fails with a value above 0 unless the organization's plan includes capacity tracking.
+
+Response: none.
+
+## resolvables/addReaction
+
+Adds your reaction to a comment. Fails if you already reacted with the same emoji.
+
+**preview**: this action may change in any release. Each change is listed in the [API changelog](https://manual.codecks.io/api-changelog/).
+
+Requires `resolvableEntryReaction:writeOwn`.
+
+Params:
+
+- `entryId`: [`ResolvableEntryId`](models/resolvableEntry.md)
+- `value`: `{type: "emoji"; value: string}`
+  `value` is the emoji character itself, like `👍`.
+
+Response:
+
+- `id`: [`ResolvableEntryReactionId`](models/resolvableEntryReaction.md)
+
+## resolvables/close
+
+Closes a comment thread. Closing a `block` or `review` thread ends the card's blocked or in review state. In a deck with guardians, only a guardian, a producer or an admin may close a `review`, unless the guardians in it approved and you are the card's assignee.
+
+Requires `resolvable:write` or `card:write`, depending on the call.
+
+Params:
+
+- `id`: [`ResolvableId`](models/resolvable.md)
+- `markCardDone`: `boolean` (optional)
+  Also sets the card's `status` to `done`.
+
+Response:
+
+- `cardId`: [`CardId`](models/card.md)
+
+## resolvables/comment
+
+Adds a comment to a thread. You and everyone mentioned in `content` join the thread, even if you opted out before. The other participants who didn't opt out are notified.
+
+Requires `resolvableEntry:writeOwn`.
+
+Params:
+
+- `resolvableId`: [`ResolvableId`](models/resolvable.md)
+- `content`: `string`
+  Markdown. `@name` mentions of the organization's users are stored as `@[userId:<id>]`.
+
+Response:
+
+- `id`: [`ResolvableEntryId`](models/resolvableEntry.md)
+
+## resolvables/create
+
+Starts a comment thread on a card with its first comment. You, the card's assignee and everyone mentioned in `content` join it, and everyone watching the card is notified.
+
+Requires `resolvable:write` or `card:write`, depending on the call.
+
+Params:
+
+- `cardId`: [`CardId`](models/card.md)
+- `context`: `"block" | "review" | "comment"`
+  `block` or `review` sets the card back to `not_started` and marks it as blocked or in review until the thread is closed. A `review` thread also adds the deck's guardians.
+- `content`: `string`
+  Markdown. `@name` mentions of the organization's users are stored as `@[userId:<id>]`.
+
+Response:
+
+- `id`: [`ResolvableId`](models/resolvable.md)
+
+## resolvables/removeReaction
+
+**preview**: this action may change in any release. Each change is listed in the [API changelog](https://manual.codecks.io/api-changelog/).
+
+Requires `resolvableEntryReaction:writeOwn` or `resolvableEntryReaction:writeAny`, depending on the call.
+
+Params:
+
+- `reactionId`: [`ResolvableEntryReactionId`](models/resolvableEntryReaction.md)
+
+Response: none.
+
+## resolvables/reopen
+
+Opens a closed comment thread again. Reopening a `block` or `review` thread sets the card back to `not_started`, and fails for doc cards, hero cards and cards that already have an open `block` or `review` thread.
+
+Requires `resolvable:write` or `card:write`, depending on the call.
+
+Params:
+
+- `id`: [`ResolvableId`](models/resolvable.md)
+
+Response: none.
+
+## resolvables/updateComment
+
+Changes a comment's `content`. If the thread is open, users newly mentioned in it join the thread.
+
+Requires `resolvableEntry:writeOwn` or `resolvableEntry:writeAny`, depending on the call.
+
+Params:
+
+- `entryId`: [`ResolvableEntryId`](models/resolvableEntry.md)
+- `content`: `string`
+  Markdown. `@name` mentions of the organization's users are stored as `@[userId:<id>]`.
+
+Response: none.
+
+## resolvables/updateParticipantDone
+
+Opts a participant out of a comment thread (`done: true`) or back in (`done: false`). Participants who opted out aren't notified about new comments. The card's assignee can't opt out.
+
+**preview**: this action may change in any release. Each change is listed in the [API changelog](https://manual.codecks.io/api-changelog/).
+
+Requires `resolvableParticipant:writeOwn` or `resolvableParticipant:writeAny`, depending on the call.
+
+Params:
+
+- `resolvableId`: [`ResolvableId`](models/resolvable.md)
+- `userId`: [`UserId`](models/user.md)
+- `done`: `boolean`
+- `status`: `"active" | "opt_out" | "approve"` (optional)
+  Defaults to `opt_out` with `done: true` and to `active` otherwise. A guardian uses `approve` with `done: true` to approve a `review` thread.
+
+Response: none.
+
+## sprints/renameZone
+
+Renames a zone of the run's manual order. The cards in that zone move to the new name with it, including archived ones.
+
+**preview**: this action may change in any release. Each change is listed in the [API changelog](https://manual.codecks.io/api-changelog/).
+
+Requires `sprint:write` and `cardOrder:write`.
+
+Params:
+
+- `id`: [`SprintId`](models/sprint.md)
+- `label`: `string | null`
+  The zone to rename, one of `manualOrderLabels`. `null` is the zone without a name.
+- `newLabel`: `string`
+  Trimmed. Fails if the run already has a zone with that name.
+
+Response: none.
+
+## sprints/updateConfig
+
+Changes the given fields of a Run Config. A new `autoBeastModeDurationHours` starts Beast Mode for the current run right away if that time has already passed.
+
+Requires `sprintConfig:write`.
+
+Params:
+
+- `id`: [`SprintConfigId`](models/sprintConfig.md)
+- `name`: `string` (optional)
+- `color`: `"gray" | "brown" | "yellow" | "red" | "pink" | "blue" | "green"` (optional)
+- `isGlobal`: `boolean` (optional)
+  `true` links the Run Config to all projects. `false` needs `projectIds` if the Run Config is global.
+- `autoBeastModeDurationHours`: `number | null` (optional) — **preview**
+  Fails with a value above 0 unless the organization's plan includes Beast Mode.
+- `beastGracePeriodHours`: `number` (optional) — **preview**
+  Fails with a value above 0 unless the organization's plan includes Beast Mode.
+- `projectIds`: [`ProjectId`](models/project.md)`[] | null` (optional)
+  Replaces the Run Config's projects and makes it non-global. Ignored with `isGlobal: true`. Cards of projects that are removed are taken out of their run.
+- `moveOnFinish`: `("undone" | "review" | "blocked")[]` (optional) — **preview**
+- `autoAssignStartedCard`: `boolean` (optional) — **preview**
+- `autoAssignNewCard`: `boolean` (optional) — **preview**
+- `runLabelTemplate`: `string | null` (optional) — **preview**
+  Has to contain `%RUN_NR%` or `%CALENDAR_WEEK%`.
+
+Response: none.
+
+## sprints/updateSprint
+
+Changes the given fields of a run, and can start its Beast Mode or complete it.
+
+Requires `sprint:write`.
+
+Params:
+
+- `id`: [`SprintId`](models/sprint.md)
+- `name`: `string | null` (optional)
+  `null` makes the web app show the label from the Run Config's `runLabelTemplate`.
+- `description`: `string` (optional)
+- `handSyncEnabled`: `boolean` (optional) — **preview**
+- `manualOrderLabels`: `(string | null)[]` (optional) — **preview**
+  Labels are trimmed, and duplicates are removed. Renaming a zone here leaves its cards with the old name; use `sprints/renameZone` instead.
+- `userCapacities`: `{[key: string]: number}` (optional) — **preview**
+  Replaces all capacities. Fails with a value above 0 unless the organization's plan includes capacity tracking.
+- `autoMilestoneId`: [`MilestoneId`](models/milestone.md)` | null` (optional) — **preview**
+  Also gives this milestone to the run's cards that have none.
+- `lockIn`: `boolean` (optional) — **preview**
+  `true` starts Beast Mode for the run now and locks in all its cards. Fails if it's already on, or unless the organization's plan includes Beast Mode.
+- `complete`: `boolean` (optional)
+  `true` completes the run now, as if it ended. Cards move to the next run as set in the Run Config's `moveOnFinish`. Fails if the run is already completed.
+
+Response: none.
+
+## watchings/addCard
+
+Watches a card for you, so you're notified about its changes and new comment threads. Does nothing if you already watch it.
+
+**preview**: this action may change in any release. Each change is listed in the [API changelog](https://manual.codecks.io/api-changelog/).
+
+Requires `cardSubscription:writeOwn`.
+
+Params:
+
+- `cardId`: [`CardId`](models/card.md)
+
+Response:
+
+- `id`: `string`
+
+## watchings/addDeck
+
+Makes a user watch a deck. That's the same as watching every card in it, including cards added later. Does nothing if the user already watches it.
+
+**preview**: this action may change in any release. Each change is listed in the [API changelog](https://manual.codecks.io/api-changelog/).
+
+Requires `deckSubscription:writeOwn` or `deckSubscription:writeAny`, depending on the call.
+
+Params:
+
+- `deckId`: [`DeckId`](models/deck.md)
+- `userId`: [`UserId`](models/user.md)
+  The token's own user. For a personal token, that's you.
+
+Response:
+
+- `id`: `string`
+
+## watchings/removeCard
+
+Stops watching a card. You still get its notifications while you watch its deck.
+
+**preview**: this action may change in any release. Each change is listed in the [API changelog](https://manual.codecks.io/api-changelog/).
+
+Requires `cardSubscription:writeOwn`.
+
+Params:
+
+- `cardId`: [`CardId`](models/card.md)
+
+Response: none.
+
+## watchings/removeDeck
+
+Stops a user from watching a deck. Cards the user watches on their own stay watched.
+
+**preview**: this action may change in any release. Each change is listed in the [API changelog](https://manual.codecks.io/api-changelog/).
+
+Requires `deckSubscription:writeOwn` or `deckSubscription:writeAny`, depending on the call.
+
+Params:
+
+- `deckId`: [`DeckId`](models/deck.md)
+- `userId`: [`UserId`](models/user.md)
+
+Response: none.