crowdin / crowdin/crowdin-api-client-js
Tasks API updates - syncScope, originalWordsCount, and model fixes
- Dominant language
- TypeScript
- Stars
- 139
- Forks
- 67
- Avg merge
- 3h 52m
- Merged PRs (30d)
- 13
Description
Several updates landed on the Tasks API models that typed client libraries should pick up:
**New response fields:**
- `originalWordsCount` (integer) on the Task model — the number of words when the task was created, preserved when source strings are later removed (`wordsCount` reflects the current count). Both Crowdin and Crowdin Enterprise.
- `syncScope` (nullable object: `syncedWords`, `pendingWords`, `skippedWords` — all integers) on the Enterprise task models (project tasks, organization task list, user tasks). It is `null` when the task is fully synced, not shared, or the counterpart is unavailable — **Crowdin Enterprise only**.
**Type fixes:**
- Task `creatorId` corrected from string to **integer**.
- Enterprise Add Task forms: `status` corrected from integer to **string** enum (`todo`, `in_progress`).
**Edit Project Task (Enterprise):** the inter-organizational task patch `path` enum gains `/generateCostEstimate`, `/generateTranslationCost`, and `/reportSettingsTemplateId`.
Affected endpoints: **List/Add/Get/Edit Project Task** (`api.projects.tasks.getMany`/`post`/`get`/`patch`), **List Tasks** (Enterprise organization level, `api.tasks.getMany`), **List User Tasks** (`api.users.tasks.getMany` on crowdin.com).
**References:**
- [List Project Tasks](https://support.crowdin.com/developer/api/v2/#operation/api.projects.tasks.getMany)
- [Edit Task](https://support.crowdin.com/developer/api/v2/#operation/api.projects.tasks.patch)
- Crowdin Enterprise: [List Tasks](https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.tasks.getMany), [Edit Task](https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.tasks.patch)
Contributor guide
Research direction
Start by locating the TypeScript models and endpoint definitions for List/Add/Get/Edit Project Task, Enterprise List Tasks, and List User Tasks. Compare them with the linked Crowdin API references, then update the response fields, corrected types, and Enterprise path enum. Done means all listed endpoints expose the requested shapes for Crowdin and Enterprise without changing unrelated models.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 72/100