@codecks/fetch 1.0.0 → 2.0.0

package/schema/models/milestone.md

@@ -1,39 +1,44 @@
 # milestone
 
+A date that cards are planned towards. It belongs to a list of projects, or with `isGlobal` to all projects of the organization.
+
 Key: `id`
 
 ## Fields
 
-- `id`: string
-- `name`: string
-- `color`: string
-- `date`: {year, month, day}
-- `startDate`: {year, month, day}, optional
-- `createdAt`: Date (ISO string)
-- `accountSeq`: number
-- `description`: string, optional
-- `isGlobal`: string
-- `handSyncEnabled`: string
-- `manualOrderLabels`: string
-- `stats`: object
-- `userCapacities`: object
-- `isDeleted`: boolean
-- `preferredOrder`: string, optional
-- `accountId`: string (foreign key ID) → account
-- `creatorId`: string (foreign key ID) → user
-- `coverFileId`: string (foreign key ID) → file, optional
+- `accountId`: [`AccountId`](account.md), foreign key of `account`
+- `accountSeq`: `number`
+  The milestone's number within the organization. The web app uses it in the milestone's URL: `/milestones/<accountSeq>`.
+- `color`: [`MilestoneColor`](../types.md#milestonecolor)
+- `coverFileId`: [`FileId`](file.md)` | null`, foreign key of `coverFile` — **preview**
+- `createdAt`: `Date` (sent as an ISO timestamp)
+- `creatorId`: [`UserId`](user.md), foreign key of `creator`
+- `date`: `{year: number; month: number; day: number}` (sent as `YYYY-MM-DD`)
+- `description`: `string | null`
+- `handSyncEnabled`: `boolean` — **preview**
+  Its cards that are not done and have an assignee are added to the assignee's Hand.
+- `id`: `MilestoneId`
+- `isDeleted`: `boolean`
+- `isGlobal`: `boolean`
+  The milestone belongs to all projects of the organization, also to projects created later.
+- `manualOrderLabels`: `(string | null)[]` — **preview**
+  The names of the zones the web app groups the cards into when they are ordered by hand, in order. `null` is the zone without a name.
+- `name`: `string`
+- `startDate`: `{year: number; month: number; day: number} | null` (sent as `YYYY-MM-DD`)
+- `userCapacities`: `{[userId: UserId]: number}` (uses [`UserId`](user.md)) — **preview**
+  The planned effort per user, keyed by user id. The web app compares it with the effort of the user's cards, where a card without `effort` counts as `account.fallbackEffort`.
 
 ## Relations
 
 ### belongsTo
 
 - `account` → [account](account.md) (via `accountId`)
+- `coverFile` → [file](file.md) (via `coverFileId`), optional — **preview**
 - `creator` → [user](user.md) (via `creatorId`)
-- `coverFile` → [file](file.md) (via `coverFileId`)
 
 ### hasMany
 
-- `milestoneProjects` → [milestoneProject](milestoneProject.md)
 - `cards` → [card](card.md)
-- `activities` → [activity](activity.md)
-- `progress` → [milestoneProgress](milestoneProgress.md)
+- `milestoneProjects` → [milestoneProject](milestoneProject.md)
+- `progress` → [milestoneProgress](milestoneProgress.md) — **preview**
+  The daily progress history.

package/schema/models/milestoneProgress.md

@@ -1,14 +1,20 @@
 # milestoneProgress
 
+The state of a milestone's cards on a day (UTC). A row is only written on days when the numbers change, so a day without a row has the numbers of the row before it.
+
+**preview**: this model may change in any release. Each change is listed in the [API changelog](https://manual.codecks.io/api-changelog/).
+
 Key: `milestoneId`, `date`
 
 ## Fields
 
-- `progress`: object
-- `milestoneId`: string (foreign key ID) → milestone
+- `date`: `string` — **preview**
+- `milestoneId`: [`MilestoneId`](milestone.md), foreign key of `milestone` — **preview**
+- `progress`: `unknown` — **preview**
+  Counts the cards in decks of active projects by their `derivedStatus`, with all done states counted as `done`. `cards` and `effort` have the card count and the effort sum for each state (`done`, `started`, `review`, `blocked`, `snoozing`, `assigned`, `unassigned`, `hero`), `stats` has `[count, effort sum, cards without effort]` for each state and `noEffortCards` counts the cards without effort. States without cards are left out.
 
 ## Relations
 
 ### belongsTo
 
-- `milestone` → [milestone](milestone.md) (via `milestoneId`)
+- `milestone` → [milestone](milestone.md) (via `milestoneId`) — **preview**

package/schema/models/milestoneProject.md

@@ -1,17 +1,19 @@
 # milestoneProject
 
+Links a milestone to a project whose cards and decks can use it. A milestone with `isGlobal` is linked to every project.
+
 Key: `milestoneId`, `projectId`
 
 ## Fields
 
-- `milestoneId`: string (foreign key ID) → milestone
-- `projectId`: string (foreign key ID) → project
-- `accountId`: string (foreign key ID) → account
+- `accountId`: [`AccountId`](account.md), foreign key of `account`
+- `milestoneId`: [`MilestoneId`](milestone.md), foreign key of `milestone`
+- `projectId`: [`ProjectId`](project.md), foreign key of `project`
 
 ## Relations
 
 ### belongsTo
 
+- `account` → [account](account.md) (via `accountId`)
 - `milestone` → [milestone](milestone.md) (via `milestoneId`)
 - `project` → [project](project.md) (via `projectId`)
-- `account` → [account](account.md) (via `accountId`)

package/schema/models/project.md

@@ -1,58 +1,34 @@
 # project
 
+Groups decks. A card belongs to the project of its deck.
+
 Key: `id`
 
 ## Fields
 
-- `id`: string
-- `name`: string
-- `visibility`: string
-- `defaultUserAccess`: string
-- `createdAt`: Date (ISO string)
-- `accountSeq`: number
-- `allowUpvotes`: string
-- `isPublic`: string
-- `commentsArePublic`: string
-- `publicRegistryAgreement`: string, optional
-- `publicLayoutVersion`: string
-- `publicIsExplicit`: string
-- `markerColor`: string, optional
-- `effortIcon`: string, optional
-- `spaces`: string
-- `publicPath`: string, optional
-- `publicMessage`: string, optional
-- `publicHeading`: string, optional
-- `publicBackgroundColor`: string, optional
-- `accountId`: string (foreign key ID) → account
-- `coverFileId`: string (foreign key ID) → file, optional
-- `publicBannerFileId`: string (foreign key ID) → file, optional
-- `publicTileFileId`: string (foreign key ID) → file, optional
-- `publicBackgroundImageId`: string (foreign key ID) → file, optional
+- `accountId`: [`AccountId`](account.md), foreign key of `account`
+- `coverFileId`: [`FileId`](file.md)` | null`, foreign key of `coverFile`
+- `createdAt`: `Date` (sent as an ISO timestamp)
+- `id`: `ProjectId`
+- `name`: `string`
+- `spaces`: `unknown` — **preview**
+  The spaces that group the project's decks. Removing a space moves its decks into the first remaining one.
+- `visibility`: `"default" | "archived" | "deleted" | (string & {})`
+  Setting `archived` or `deleted` closes all open comment threads on the project's cards.
 
 ## Relations
 
 ### belongsTo
 
 - `account` → [account](account.md) (via `accountId`)
-- `coverFile` → [file](file.md) (via `coverFileId`)
-- `publicBannerFile` → [file](file.md) (via `publicBannerFileId`)
-- `publicTileFile` → [file](file.md) (via `publicTileFileId`)
-- `publicBackgroundImage` → [file](file.md) (via `publicBackgroundImageId`)
-
-### hasOne
-
-- `publicProjectInfo` → [publicProjectInfo](publicProjectInfo.md)
+- `coverFile` → [file](file.md) (via `coverFileId`), optional
 
 ### hasMany
 
 - `decks` → [deck](deck.md)
 - `milestoneProjects` → [milestoneProject](milestoneProject.md)
+  Links to the milestones this project can use.
 - `sprintProjects` → [sprintProject](sprintProject.md)
-- `publicProjectVisits` → [publicProjectVisit](publicProjectVisit.md)
-- `dailyPublicProjectMembership` → [dailyPublicProjectMembership](dailyPublicProjectMembership.md)
-- `publicProjectMemberships` → [publicProjectMembership](publicProjectMembership.md)
-- `cardUpvotes` → [cardUpvote](cardUpvote.md)
+  Links to the run configs this project can use.
 - `tags` → [projectTag](projectTag.md)
-- `activities` → [activity](activity.md)
-- `explicitProjectUsers` → [projectUser](projectUser.md)
-- `access` → [userProjectAccess](userProjectAccess.md)
+  The project's tag list. A card in the project with one of these tags lists it in `masterTags`.

package/schema/models/projectTag.md

@@ -1,16 +1,21 @@
 # projectTag
 
+A tag in a project's tag list. A card in the project with this tag lists it in `masterTags`.
+
 Key: `id`
 
 ## Fields
 
-- `id`: string
-- `tag`: string
-- `color`: string, optional
-- `emoji`: string, optional
-- `description`: string, optional
-- `createdAt`: Date (ISO string)
-- `projectId`: string (foreign key ID) → project
+- `color`: `string | null`
+  A hex color like `#ff0000` for cards with this tag. The web app sets either `color` or `emoji`, not both.
+- `createdAt`: `Date` (sent as an ISO timestamp)
+- `description`: `string | null`
+  What the tag is for, as markdown.
+- `emoji`: `string | null`
+- `id`: `ProjectTagId`
+- `projectId`: [`ProjectId`](project.md), foreign key of `project`
+- `tag`: `string`
+  Without the `#`. Renaming it also renames the tag in the `content` and `masterTags` of the project's cards.
 
 ## Relations
 

package/schema/models/queueEntry.md

@@ -1,21 +1,25 @@
 # queueEntry
 
+A card in a user's Hand. When a card is done, its owner gets an entry in their Hand's done pile, even if the card wasn't in their Hand.
+
 Key: `id`
 
 ## Fields
 
-- `id`: string
-- `sortIndex`: number
-- `cardDoneAt`: Date (ISO string)
-- `createdAt`: Date (ISO string)
-- `accountId`: string (foreign key ID) → account
-- `userId`: string (foreign key ID) → user
-- `cardId`: string (foreign key ID) → card
+- `accountId`: [`AccountId`](account.md), foreign key of `account`
+- `cardDoneAt`: `Date | null` (sent as an ISO timestamp)
+  When the card was done. Other users' entries for the card are removed then. Setting the card back to not done moves the entry to the end of the Hand.
+- `cardId`: [`CardId`](card.md), foreign key of `card`
+- `createdAt`: `Date` (sent as an ISO timestamp)
+- `id`: `QueueEntryId`
+- `sortIndex`: `number | null`
+  The position in the Hand, `0` is the first card. `null` once the card is done.
+- `userId`: [`UserId`](user.md), foreign key of `user`
 
 ## Relations
 
 ### belongsTo
 
 - `account` → [account](account.md) (via `accountId`)
-- `user` → [user](user.md) (via `userId`)
 - `card` → [card](card.md) (via `cardId`)
+- `user` → [user](user.md) (via `userId`)

package/schema/models/release.md

@@ -1,12 +1,14 @@
 # release
 
+An entry in the Codecks changelog. It's the same for every organization.
+
 Key: `id`
 
 ## Fields
 
-- `id`: string
-- `version`: string
-- `isLive`: string
-- `content`: string
-- `title`: string
-- `createdAt`: Date (ISO string)
+- `content`: `string`
+  The release notes as markdown.
+- `createdAt`: `Date` (sent as an ISO timestamp)
+- `id`: `ReleaseId`
+- `title`: `string`
+- `version`: `string`

package/schema/models/resolvable.md

@@ -1,32 +1,36 @@
 # resolvable
 
+A comment thread on a card. Its `context` says if it's a plain conversation or if it marks the card as blocked or in review.
+
 Key: `id`
 
 ## Fields
 
-- `id`: string
-- `context`: string
-- `contextAsPrio`: number
-- `isClosed`: boolean
-- `closedAt`: Date (ISO string), optional
-- `createdAt`: Date (ISO string)
-- `isPublic`: boolean
-- `cardId`: string (foreign key ID) → card
-- `accountId`: string (foreign key ID) → account
-- `creatorId`: string (foreign key ID) → user
-- `closedById`: string (foreign key ID) → user, optional
+- `accountId`: [`AccountId`](account.md), foreign key of `account`
+- `cardId`: [`CardId`](card.md), foreign key of `card`
+- `closedAt`: `Date | null` (sent as an ISO timestamp)
+- `context`: `"block" | "review" | "comment" | (string & {})`
+  `block` marks the card as blocked and `review` marks it as in review while the thread is open (see `card.derivedStatus`). `comment` is a plain conversation.
+- `createdAt`: `Date` (sent as an ISO timestamp)
+- `creatorId`: [`UserId`](user.md), foreign key of `creator`
+- `id`: `ResolvableId`
+- `isClosed`: `boolean`
+  Archiving or deleting the card closes its open threads.
+- `reopenedAt`: `Date | null` (sent as an ISO timestamp)
+  Only set while the thread is open again after being closed. Closing it clears the value.
 
 ## Relations
 
 ### belongsTo
 
-- `card` → [card](card.md) (via `cardId`)
 - `account` → [account](account.md) (via `accountId`)
+- `card` → [card](card.md) (via `cardId`)
+- `closedBy` → [user](user.md), optional
+  `null` while the thread is open, or when it was closed automatically.
 - `creator` → [user](user.md) (via `creatorId`)
-- `closedBy` → [user](user.md) (via `closedById`)
+- `reopenedBy` → [user](user.md), optional
+  Only set while the thread is open again after being closed.
 
 ### hasMany
 
-- `participants` → [resolvableParticipant](resolvableParticipant.md)
-- `participantHistories` → [resolvableParticipantHistory](resolvableParticipantHistory.md)
 - `entries` → [resolvableEntry](resolvableEntry.md)

package/schema/models/resolvableEntry.md

@@ -1,28 +1,31 @@
 # resolvableEntry
 
+A comment in a comment thread.
+
 Key: `entryId`
 
 ## Fields
 
-- `entryId`: string
-- `content`: string
-- `lastChangedAt`: Date (ISO string)
-- `createdAt`: Date (ISO string)
-- `version`: number
-- `meta`: object
-- `resolvableId`: string (foreign key ID) → resolvable
-- `cardId`: string (foreign key ID) → card
-- `authorId`: string (foreign key ID) → user
+- `authorId`: [`UserId`](user.md), foreign key of `author`
+- `cardId`: [`CardId`](card.md), foreign key of `card`
+- `content`: `string`
+  Markdown. Mentions are stored as `@[userId:<id>]`.
+- `createdAt`: `Date` (sent as an ISO timestamp)
+- `entryId`: `ResolvableEntryId`
+- `lastChangedAt`: `Date` (sent as an ISO timestamp)
+  When the comment was last edited. Same as `createdAt` if it never was.
+- `resolvableId`: [`ResolvableId`](resolvable.md), foreign key of `resolvable`
+- `version`: `number` — **preview**
+  Starts at 1 and goes up with every edit.
 
 ## Relations
 
 ### belongsTo
 
-- `resolvable` → [resolvable](resolvable.md) (via `resolvableId`)
-- `card` → [card](card.md) (via `cardId`)
 - `author` → [user](user.md) (via `authorId`)
+- `card` → [card](card.md) (via `cardId`)
+- `resolvable` → [resolvable](resolvable.md) (via `resolvableId`)
 
 ### hasMany
 
-- `reactions` → [resolvableEntryReaction](resolvableEntryReaction.md)
-- `histories` → [resolvableEntryHistory](resolvableEntryHistory.md)
+- `reactions` → [resolvableEntryReaction](resolvableEntryReaction.md) — **preview**

package/schema/models/resolvableEntryReaction.md

@@ -1,23 +1,27 @@
 # resolvableEntryReaction
 
+An emoji reaction to a comment. A user can add each emoji only once per comment.
+
+**preview**: this model may change in any release. Each change is listed in the [API changelog](https://manual.codecks.io/api-changelog/).
+
 Key: `id`
 
 ## Fields
 
-- `id`: string
-- `value`: object
-- `createdAt`: Date (ISO string)
-- `isPublic`: boolean
-- `resolvableEntryId`: string (foreign key ID) → resolvableEntry
-- `accountId`: string (foreign key ID) → account
-- `userId`: string (foreign key ID) → user
-- `resolvableId`: string (foreign key ID) → resolvable
+- `accountId`: [`AccountId`](account.md), foreign key of `account` — **preview**
+- `createdAt`: `Date` (sent as an ISO timestamp) — **preview**
+- `entryId`: [`ResolvableEntryId`](resolvableEntry.md), foreign key of `resolvableEntry` — **preview**
+- `id`: `ResolvableEntryReactionId`
+- `resolvableId`: [`ResolvableId`](resolvable.md), foreign key of `resolvable` — **preview**
+- `userId`: [`UserId`](user.md), foreign key of `user` — **preview**
+- `value`: `{type: "emoji" | (string & {}); value: string}` — **preview**
+  `{"type": "emoji", "value": "👍"}`. `value` is the emoji character itself.
 
 ## Relations
 
 ### belongsTo
 
-- `resolvableEntry` → [resolvableEntry](resolvableEntry.md) (via `resolvableEntryId`)
-- `account` → [account](account.md) (via `accountId`)
-- `user` → [user](user.md) (via `userId`)
-- `resolvable` → [resolvable](resolvable.md) (via `resolvableId`)
+- `account` → [account](account.md) (via `accountId`) — **preview**
+- `resolvable` → [resolvable](resolvable.md) (via `resolvableId`) — **preview**
+- `resolvableEntry` → [resolvableEntry](resolvableEntry.md) (via `entryId`) — **preview**
+- `user` → [user](user.md) (via `userId`) — **preview**

package/schema/models/sprint.md

@@ -1,42 +1,52 @@
 # sprint
 
+A run: one time box of a Run Config, from `startDate` to `endDate`. Codecks creates the upcoming runs ahead of time and completes a run when it ends.
+
 Key: `id`
 
 ## Fields
 
-- `id`: string
-- `description`: string
-- `name`: string, optional
-- `accountSeq`: number
-- `index`: number
-- `startDate`: {year, month, day}
-- `endDate`: {year, month, day}
-- `stats`: object
-- `manualOrderLabels`: string
-- `userCapacities`: object
-- `handSyncEnabled`: string
-- `createdAt`: Date (ISO string)
-- `isDeleted`: boolean
-- `completedAt`: Date (ISO string), optional
-- `lockedAt`: Date (ISO string), optional
-- `accountId`: string (foreign key ID) → account
-- `sprintConfigId`: string (foreign key ID) → sprintConfig
-- `creatorId`: string (foreign key ID) → user
-- `coverFileId`: string (foreign key ID) → file, optional
-- `autoMilestoneId`: string (foreign key ID) → milestone, optional
+- `accountId`: [`AccountId`](account.md), foreign key of `account`
+- `accountSeq`: `number`
+  The run's number within the organization. The web app uses it in the run's URL: `/milestones/run/<accountSeq>`.
+- `autoMilestoneId`: [`MilestoneId`](milestone.md)` | null`, foreign key of `autoMilestone` — **preview**
+  Cards that are added to this run get this milestone, unless they already have one.
+- `completedAt`: `Date | null` (sent as an ISO timestamp)
+  When the run was completed, at its end or with `complete` in `sprints/updateSprint`.
+- `coverFileId`: [`FileId`](file.md)` | null`, foreign key of `coverFile` — **preview**
+- `createdAt`: `Date` (sent as an ISO timestamp)
+- `description`: `string | null`
+- `endDate`: `{year: number; month: number; day: number}` (sent as `YYYY-MM-DD`)
+  The last day of the run.
+- `handSyncEnabled`: `boolean` — **preview**
+  A card that is created in this run with an assignee is added to the assignee's Hand.
+- `id`: `SprintId`
+- `index`: `number`
+  The position of the run within its Run Config, starting at 0. The web app shows `index + 1` as the run's number.
+- `isDeleted`: `boolean`
+- `lockedAt`: `Date | null` (sent as an ISO timestamp) — **preview**
+  When Beast Mode started for this run. In Beast Mode the run's cards are locked in, and moving one of them to another run raises its Beast level. `null` while it is off.
+- `manualOrderLabels`: `(string | null)[]` — **preview**
+  The names of the zones the web app groups the cards into when they are ordered by hand, in order. `null` is the zone without a name. A new run starts with the zones of the run before it.
+- `name`: `string | null`
+  `null` unless set by hand. The web app then shows a label from the Run Config's `runLabelTemplate`, or `Run <index + 1>`.
+- `sprintConfigId`: [`SprintConfigId`](sprintConfig.md), foreign key of `sprintConfig`
+- `startDate`: `{year: number; month: number; day: number}` (sent as `YYYY-MM-DD`)
+- `userCapacities`: `{[userId: UserId]: number}` (uses [`UserId`](user.md)) — **preview**
+  The planned effort per user, keyed by user id. The web app compares it with the effort of the user's cards, where a card without `effort` counts as `account.fallbackEffort`. A new run starts with the capacities of the run before it.
 
 ## Relations
 
 ### belongsTo
 
 - `account` → [account](account.md) (via `accountId`)
+- `autoMilestone` → [milestone](milestone.md) (via `autoMilestoneId`), optional — **preview**
+  Cards that are added to this run get this milestone, unless they already have one.
+- `coverFile` → [file](file.md) (via `coverFileId`), optional — **preview**
 - `sprintConfig` → [sprintConfig](sprintConfig.md) (via `sprintConfigId`)
-- `creator` → [user](user.md) (via `creatorId`)
-- `coverFile` → [file](file.md) (via `coverFileId`)
-- `autoMilestone` → [milestone](milestone.md) (via `autoMilestoneId`)
 
 ### hasMany
 
 - `cards` → [card](card.md)
-- `progress` → [sprintProgress](sprintProgress.md)
-- `activities` → [activity](activity.md)
+- `progress` → [sprintProgress](sprintProgress.md) — **preview**
+  The daily progress history.

package/schema/models/sprintConfig.md

@@ -1,28 +1,31 @@
 # sprintConfig
 
+A Run Config. It creates runs of the same length one after the other, like sprints, for its projects.
+
 Key: `id`
 
 ## Fields
 
-- `id`: string
-- `name`: string
-- `color`: string
-- `stopOn`: {year, month, day}, optional
-- `isGlobal`: string
-- `upcomingSprints`: number
-- `sprintDurationWeeks`: number
-- `sprintStartWeekday`: number
-- `endHour`: number
-- `endHourTimezone`: string
-- `createdAt`: Date (ISO string)
-- `preferredOrder`: string, optional
-- `moveOnFinish`: string
-- `autoBeastModeDurationHours`: number, optional
-- `autoAssignStartedCard`: boolean
-- `autoAssignNewCard`: boolean
-- `beastGracePeriodHours`: number
-- `accountId`: string (foreign key ID) → account
-- `creatorId`: string (foreign key ID) → user
+- `accountId`: [`AccountId`](account.md), foreign key of `account`
+- `autoAssignNewCard`: `boolean` — **preview**
+  The web app puts new cards in its projects into the current run. Journeys do the same, `cards/create` doesn't.
+- `autoAssignStartedCard`: `boolean` — **preview**
+  A card in one of its projects that is started without a run is added to the current run.
+- `autoBeastModeDurationHours`: `number | null` — **preview**
+  Beast Mode starts on its own this many hours after the start of a run, counted from midnight in the Run Config's time zone. `0` starts it right away, `null` turns it off.
+- `beastGracePeriodHours`: `number` — **preview**
+  In Beast Mode, a card added to the run is only locked in after this many hours. Until then it can move to another run without raising its Beast level.
+- `color`: [`MilestoneColor`](../types.md#milestonecolor)
+- `createdAt`: `Date` (sent as an ISO timestamp)
+- `creatorId`: [`UserId`](user.md), foreign key of `creator`
+- `id`: `SprintConfigId`
+- `isGlobal`: `boolean`
+  The Run Config belongs to all projects of the organization, also to projects created later.
+- `moveOnFinish`: `("undone" | "review" | "blocked" | (string & {}))[]` — **preview**
+  Which cards move to the next run when a run ends: `review` for cards with an open review, `blocked` for cards with an open blocker and `undone` for all other cards that aren't done. Archived cards and docs stay.
+- `name`: `string`
+- `runLabelTemplate`: `string | null` — **preview**
+  The label for runs without a `name`. `%RUN_NR%` becomes the run's `index + 1` and `%CALENDAR_WEEK%` the ISO week of its `startDate`. `null` means `Run %RUN_NR%`.
 
 ## Relations
 
@@ -33,6 +36,7 @@ Key: `id`
 
 ### hasMany
 
+- `progress` → [sprintConfigProgress](sprintConfigProgress.md) — **preview**
+  The daily history of the done cards across all runs.
 - `sprintProjects` → [sprintProject](sprintProject.md)
 - `sprints` → [sprint](sprint.md)
-- `progress` → [sprintConfigProgress](sprintConfigProgress.md)

package/schema/models/sprintConfigProgress.md

@@ -1,14 +1,20 @@
 # sprintConfigProgress
 
+The done cards of all runs of a Run Config on a day (UTC). A row is only written on days when the numbers change, so a day without a row has the numbers of the row before it.
+
+**preview**: this model may change in any release. Each change is listed in the [API changelog](https://manual.codecks.io/api-changelog/).
+
 Key: `sprintConfigId`, `date`
 
 ## Fields
 
-- `progress`: object
-- `sprintConfigId`: string (foreign key ID) → sprintConfig
+- `date`: `string` — **preview**
+- `progress`: `unknown` — **preview**
+  `stats.done` is `[count, effort sum, cards without effort]` of the done cards in all runs, counting only cards in decks of active projects.
+- `sprintConfigId`: [`SprintConfigId`](sprintConfig.md), foreign key of `sprintConfig` — **preview**
 
 ## Relations
 
 ### belongsTo
 
-- `sprintConfig` → [sprintConfig](sprintConfig.md) (via `sprintConfigId`)
+- `sprintConfig` → [sprintConfig](sprintConfig.md) (via `sprintConfigId`) — **preview**

package/schema/models/sprintProgress.md

@@ -1,14 +1,20 @@
 # sprintProgress
 
+The state of a run's cards on a day (UTC). A row is only written on days when the numbers change, so a day without a row has the numbers of the row before it.
+
+**preview**: this model may change in any release. Each change is listed in the [API changelog](https://manual.codecks.io/api-changelog/).
+
 Key: `sprintId`, `date`
 
 ## Fields
 
-- `progress`: object
-- `sprintId`: string (foreign key ID) → sprint
+- `date`: `string` — **preview**
+- `progress`: `unknown` — **preview**
+  Counts the cards in decks of active projects by their `derivedStatus`, with all done states counted as `done`. `cards` and `effort` have the card count and the effort sum for each state (`done`, `started`, `review`, `blocked`, `snoozing`, `assigned`, `unassigned`, `hero`), `stats` has `[count, effort sum, cards without effort]` for each state and `noEffortCards` counts the cards without effort. States without cards are left out.
+- `sprintId`: [`SprintId`](sprint.md), foreign key of `sprint` — **preview**
 
 ## Relations
 
 ### belongsTo
 
-- `sprint` → [sprint](sprint.md) (via `sprintId`)
+- `sprint` → [sprint](sprint.md) (via `sprintId`) — **preview**

package/schema/models/sprintProject.md

@@ -1,17 +1,19 @@
 # sprintProject
 
+Links a run config to a project whose cards can be planned into its runs. A run config with `isGlobal` is linked to every project.
+
 Key: `sprintConfigId`, `projectId`
 
 ## Fields
 
-- `sprintConfigId`: string (foreign key ID) → sprintConfig
-- `projectId`: string (foreign key ID) → project
-- `accountId`: string (foreign key ID) → account
+- `accountId`: [`AccountId`](account.md), foreign key of `account`
+- `projectId`: [`ProjectId`](project.md), foreign key of `project`
+- `sprintConfigId`: [`SprintConfigId`](sprintConfig.md), foreign key of `sprintConfig`
 
 ## Relations
 
 ### belongsTo
 
-- `sprintConfig` → [sprintConfig](sprintConfig.md) (via `sprintConfigId`)
-- `project` → [project](project.md) (via `projectId`)
 - `account` → [account](account.md) (via `accountId`)
+- `project` → [project](project.md) (via `projectId`)
+- `sprintConfig` → [sprintConfig](sprintConfig.md) (via `sprintConfigId`)