Skip to content

feat: actualize API methods for Crowdin and Crowdin Enterprise - #285

Merged
andrii-bodnar merged 12 commits into
mainfrom
feat/api-actualization
Sep 30, 2026
Merged

andrii-bodnar merged 12 commits into
mainfrom
feat/api-actualization

Conversation

@andrii-bodnar

Copy link
Copy Markdown
Member

Brings the client in line with the current Crowdin API v2 and Crowdin Enterprise API v2 specs (file-based and string-based projects).

Added

  • New resources: Advisors, System Placeholders; Enterprise-only Project Placeholders, Custom Placeholders, Custom Spellcheckers, External QA Checks and Organization.
  • Newly registered on the client (these classes existed but were not reachable): branches, notifications, organization_webhooks, clients, string_corrections.
  • Split by platform: source_strings and machine_translations return Enterprise-specific classes on Enterprise.
  • New endpoints:
    • AI: snippets, request log exports, usage members, all provider models, project AI settings
    • Applications: key-value storage, Integrations API, bundle upload, installation updates
    • Strings: upload strings, reviewed source files builds
    • Bundles: bundle branches
    • Tasks: user and organization task lists
    • Users: edit authenticated user
    • Enterprise: user and team project permissions, organization-level reports and report templates, MT engine management
    • QA checks: validate text
  • Updated parameters: missing query params, body fields and patch paths on ~120 existing methods.

Deprecated

  • AI custom placeholder methods; use AI Snippets instead.
  • upload_translation; use import_translations instead.
  • Enterprise project-level report settings templates; use the organization-level ones instead.
  • API-deprecated params such as translateUntranslatedOnly, glossaryAccess and splitFiles.

Fixed

  • Clients, organization webhooks and security logs used paths with a leading /, which dropped /api/v2 from the URL.
  • Application data methods sent a JSON string instead of a dict.
  • Label unassign methods crashed when given a single id.
  • QA checks revalidation status and cancel now take revalidationId. Calls without it keep the old path and emit a deprecation warning.
  • The strings exporter settings edit now sends a JSON Patch body.
  • The group report path used the group id where the report id belongs.
  • Several patch-path enums and query keys now match the spec.

Heads-up

Some fixes change what is sent on the wire:

  • Leading / added to some patch-path enums: ProjectPatchPath.NORMALIZE_PLACEHOLDER and SAVE_META_INFO_IN_SOURCE, and all ReportSettingsTemplatesPatchPath values.
  • list_group_managers sends teamIds and orderBy.
  • The group task-usage report sends typeTasks instead of typeTask.
  • add_team_to_project no longer sends accessToAllWorkflowSteps and managerAccess unless they are set.

Also: documentation links now point to support.crowdin.com.

andrii-bodnar and others added 12 commits September 30, 2026 12:59
Replace developer.crowdin.com links in docstrings and README with the
support.crowdin.com/developer equivalents and update the AGENTS.md rule.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…settings

- Add AI Snippets CRUD, List All AI Provider Models, AI Request Logs
  export/status/download, AI Usage members and Get Project AI Settings
  for both Crowdin and Enterprise
- Deprecate AI custom placeholder methods in favour of AI Snippets
- Extend AI settings patch paths, provider types and prompt configs

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
… API; add Advisors

- Add application bundle upload, installation update get/apply, KV storage
  records CRUD and the file-based Integrations API methods
- Support manifest-based installation and installedBy/orderBy filters
- Fix application data methods sending a JSON string instead of a dict
- Deprecate misspelled edit_applicatoin_installation
- Add AdvisorsResource (checks and insights)
- Add shared convert_to_query_list helper

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…ders

- Add missing add/edit project fields and patch paths (AI prompts, QA
  checks, style guides, Enterprise workflow/group/vendor settings)
- Deprecate glossaryAccess and preTranslationAiPromptId params
- Fix strings exporter settings edit to send a JSON Patch body
- Add SystemPlaceholdersResource and Enterprise ProjectPlaceholdersResource

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…sh paths

- Add Custom Placeholders, Custom Spellcheckers, External QA Checks and
  Organization resources (Enterprise)
- Add Enterprise MT engine add/edit/delete and groupId filter
- Fix clients, organization webhooks and security logs paths that dropped
  the /api/v2 prefix
- Update fields, style guides, groups, workflows and webhook events

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- Add List User Tasks (Crowdin) and organization-level List Tasks (Enterprise)
- Add missing Add Task fields and Edit Task patch paths per platform,
  including generateCostEstimate/generateTranslationCost/reportSettingsTemplateId
- Add timeSpent to task comments

Refs #282

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- Add parserVersion, name, replaceModifiedContext and Enterprise fields to
  file methods; bring import/export options and patch paths up to date
- Add isProtected, branch deletion status and bundle branches
- Fix label unassign methods crashing on a single id; add isSystem filter
- Add regression test for importTranslations in update_file (#246)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- Add updateOption to Edit String and String Batch Operations (#253)
- Add Upload Strings (string-based) and Enterprise reviewed source files builds
- Add fileId/isShared to string comments and fix attachments format
- Update screenshots filters, auto-tag options and labelIds patch path
- Use pagination for string corrections list

Closes #253

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
… QA validation

- Add directoryIds, branchIds and other missing Apply Pre-Translation
  fields; make fileIds optional (#283)
- Add missing build/export fields and Enterprise approval filters
- Fix QA checks revalidation status/cancel paths (revalidationId)
- Add Validate Text by QA Checks
- Deprecate upload_translation in favour of import_translations

Closes #283

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…sions

- Add Enterprise organization/group report generation, status and download
  and organization report settings templates; expose user-level templates
- Add new report types and missing report fields
- Add Edit Authenticated User, Enterprise user/team project permissions
- Fix group report path and query key names

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- Add filter/userId/isShared/groupId to glossaries and TMs, croql to TM
  segments, translationOfTermId to terms, Enterprise fields on terms/concepts
- Add new export filters and patch paths; add TM export format enum
- Document deprecated distribution fileIds/exportMode

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…ient

- Register advisors, branches, notifications, organization_webhooks and
  system_placeholders
- Register Enterprise-only clients, custom_placeholders,
  custom_spellcheckers, external_qa_checks, organization,
  project_placeholders and string_corrections
- Return Enterprise-specific classes for source_strings and
  machine_translations on Enterprise

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@andrii-bodnar
andrii-bodnar merged commit fead64f into main Sep 30, 2026
6 checks passed
@andrii-bodnar
andrii-bodnar deleted the feat/api-actualization branch September 30, 2026 11:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant