phrase 4.24.0 → 4.26.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (115) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +35 -0
  3. data/README.md +19 -4
  4. data/docs/AutomationEvent.md +33 -0
  5. data/docs/AutomationEventProject.md +19 -0
  6. data/docs/AutomationEventsApi.md +168 -0
  7. data/docs/AutomationsCreateParameters.md +1 -1
  8. data/docs/AutomationsCreateParameters1.md +1 -1
  9. data/docs/BranchComparison.md +23 -0
  10. data/docs/BranchComparisonChange.md +19 -0
  11. data/docs/BranchComparisonDiff.md +21 -0
  12. data/docs/BranchComparisonDiffConflictsValue.md +19 -0
  13. data/docs/BranchesApi.md +5 -4
  14. data/docs/DocumentsApi.md +4 -4
  15. data/docs/Format.md +20 -20
  16. data/docs/FormatsApi.md +1 -1
  17. data/docs/ICUApi.md +1 -1
  18. data/docs/IcuSkeletonError.md +17 -0
  19. data/docs/IcuSkeletonParameters.md +11 -11
  20. data/docs/Job.md +3 -1
  21. data/docs/JobDetails.md +2 -0
  22. data/docs/JobsApi.md +2 -2
  23. data/docs/KeyCreateParameters.md +1 -1
  24. data/docs/KeyFormatAnnotationsApi.md +74 -0
  25. data/docs/KeyFormatAnnotationsList200ResponseInner.md +19 -0
  26. data/docs/KeyLinksBatchDestroyParameters.md +6 -4
  27. data/docs/KeyLinksCreateParameters.md +2 -2
  28. data/docs/KeyUpdateParameters.md +1 -1
  29. data/docs/LinkedKeysApi.md +14 -13
  30. data/docs/Locale.md +2 -0
  31. data/docs/LocaleCreateParameters.md +3 -1
  32. data/docs/LocaleDetails.md +2 -0
  33. data/docs/LocaleDownloadCreateParameters.md +4 -0
  34. data/docs/LocaleUpdateParameters.md +3 -1
  35. data/docs/LocalesApi.md +2 -2
  36. data/docs/PreTranslation.md +29 -0
  37. data/docs/PreTranslationCreateParameters.md +19 -0
  38. data/docs/PreTranslationsApi.md +210 -0
  39. data/docs/ProjectCreateParameters.md +1 -1
  40. data/docs/ProjectUpdateParameters.md +1 -1
  41. data/docs/RepoSync.md +2 -0
  42. data/docs/RepoSyncCreateParameters.md +2 -0
  43. data/docs/ScreenshotUpdateParameters.md +1 -1
  44. data/docs/ScreenshotsApi.md +11 -11
  45. data/lib/phrase/api/automation_events_api.rb +215 -0
  46. data/lib/phrase/api/branches_api.rb +5 -3
  47. data/lib/phrase/api/documents_api.rb +6 -6
  48. data/lib/phrase/api/formats_api.rb +2 -2
  49. data/lib/phrase/api/icu_api.rb +2 -6
  50. data/lib/phrase/api/key_format_annotations_api.rb +85 -0
  51. data/lib/phrase/api/linked_keys_api.rb +19 -23
  52. data/lib/phrase/api/locales_api.rb +2 -2
  53. data/lib/phrase/api/pre_translations_api.rb +240 -0
  54. data/lib/phrase/api/screenshots_api.rb +20 -16
  55. data/lib/phrase/models/automation_event.rb +325 -0
  56. data/lib/phrase/models/automation_event_project.rb +208 -0
  57. data/lib/phrase/models/automations_create_parameters.rb +1 -1
  58. data/lib/phrase/models/automations_create_parameters1.rb +1 -1
  59. data/lib/phrase/models/branch_comparison.rb +224 -0
  60. data/lib/phrase/models/branch_comparison_change.rb +212 -0
  61. data/lib/phrase/models/branch_comparison_diff.rb +223 -0
  62. data/lib/phrase/models/branch_comparison_diff_conflicts_value.rb +209 -0
  63. data/lib/phrase/models/format.rb +60 -0
  64. data/lib/phrase/models/{key_links_index400_response.rb → icu_skeleton_error.rb} +11 -10
  65. data/lib/phrase/models/icu_skeleton_parameters.rb +6 -6
  66. data/lib/phrase/models/job.rb +16 -5
  67. data/lib/phrase/models/job_details.rb +12 -1
  68. data/lib/phrase/models/key_format_annotations_list200_response_inner.rb +207 -0
  69. data/lib/phrase/models/key_links_batch_destroy_parameters.rb +52 -6
  70. data/lib/phrase/models/key_links_create_parameters.rb +1 -1
  71. data/lib/phrase/models/locale.rb +10 -1
  72. data/lib/phrase/models/locale_create_parameters.rb +14 -4
  73. data/lib/phrase/models/locale_details.rb +10 -1
  74. data/lib/phrase/models/locale_download_create_parameters.rb +21 -1
  75. data/lib/phrase/models/locale_update_parameters.rb +14 -4
  76. data/lib/phrase/models/pre_translation.rb +301 -0
  77. data/lib/phrase/models/pre_translation_create_parameters.rb +241 -0
  78. data/lib/phrase/models/repo_sync.rb +29 -1
  79. data/lib/phrase/models/repo_sync_create_parameters.rb +27 -1
  80. data/lib/phrase/response.rb +2 -2
  81. data/lib/phrase/version.rb +1 -1
  82. data/lib/phrase.rb +13 -1
  83. data/phrase.gemspec +1 -1
  84. data/spec/api/automation_events_api_spec.rb +67 -0
  85. data/spec/api/branches_api_spec.rb +1 -1
  86. data/spec/api/documents_api_spec.rb +3 -3
  87. data/spec/api/formats_api_spec.rb +1 -1
  88. data/spec/api/icu_api_spec.rb +1 -1
  89. data/spec/api/key_format_annotations_api_spec.rb +38 -0
  90. data/spec/api/linked_keys_api_spec.rb +7 -7
  91. data/spec/api/pre_translations_api_spec.rb +70 -0
  92. data/spec/api/screenshots_api_spec.rb +6 -6
  93. data/spec/models/automation_event_project_spec.rb +35 -0
  94. data/spec/models/automation_event_spec.rb +85 -0
  95. data/spec/models/branch_comparison_change_spec.rb +35 -0
  96. data/spec/models/branch_comparison_diff_conflicts_value_spec.rb +35 -0
  97. data/spec/models/branch_comparison_diff_spec.rb +41 -0
  98. data/spec/models/branch_comparison_spec.rb +47 -0
  99. data/spec/models/{key_links_index400_response_spec.rb → icu_skeleton_error_spec.rb} +7 -7
  100. data/spec/models/job_details_spec.rb +6 -0
  101. data/spec/models/job_spec.rb +6 -0
  102. data/spec/models/key_format_annotations_list200_response_inner_spec.rb +35 -0
  103. data/spec/models/key_links_batch_destroy_parameters_spec.rb +10 -0
  104. data/spec/models/locale_create_parameters_spec.rb +6 -0
  105. data/spec/models/locale_details_spec.rb +6 -0
  106. data/spec/models/locale_download_create_parameters_spec.rb +12 -0
  107. data/spec/models/locale_spec.rb +6 -0
  108. data/spec/models/locale_update_parameters_spec.rb +6 -0
  109. data/spec/models/pre_translation_create_parameters_spec.rb +39 -0
  110. data/spec/models/pre_translation_spec.rb +73 -0
  111. data/spec/models/repo_sync_create_parameters_spec.rb +6 -0
  112. data/spec/models/repo_sync_spec.rb +6 -0
  113. data/spec/response_spec.rb +53 -0
  114. metadata +304 -254
  115. data/docs/KeyLinksIndex400Response.md +0 -17
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 8d213192723604fbb4ef7a90d6a9f29acc732851fef5f2aca3fd4ca40b12c15d
4
- data.tar.gz: 187feac87a11747ede044a04da9d66304dc683e66d6055c83091a570a2342e77
3
+ metadata.gz: 950c760b4ff662d461dc3b5ee1c2490949e2754537a02c512108ee2802eb6e37
4
+ data.tar.gz: 151f613ba922d317f0f492c9a3993cfe98718a68eaa64fe1f43709e9d98c2af0
5
5
  SHA512:
6
- metadata.gz: 1c2184c4658be521ee20da21c7e10545aa9be346d993e2f35424188686e2584ade0e47d950f84f7c5116ea3098b177c829c8598281851ca9e03b78a716c6777d
7
- data.tar.gz: 633b174f29f95e59035fdc6a7beb8fbc789cc9b79ddd314c4dcbd640e2a2a198d950281d0e05265812126f3871f35a6e4d6572150727211fa718c51c2718b123
6
+ metadata.gz: 921fc81ad5bf358718d0fe2bd1367c55511636c6291ce39b1298516ebe3f17efaa7ad0bd4361bba43cfc03fdea31147bab33bb88011f8e7517b9d433cc768a3d
7
+ data.tar.gz: c4cd0d523a362016d9aec722f94946d75969acf5f112d3a139aa843230d8672c189f193ca618eca790e9721099830ab0430cdeeaf6ba0a138092ce0e68324ab9
data/CHANGELOG.md CHANGED
@@ -1,5 +1,40 @@
1
1
  # Changelog
2
2
 
3
+ ## [4.26.0](https://github.com/phrase/strings-openapi/compare/ruby-v4.25.0...ruby-v4.26.0) (2026-08-03)
4
+
5
+
6
+ ### Features
7
+
8
+ * **API:** add automation events list endpoints #STRINGS-2826 ([#1227](https://github.com/phrase/strings-openapi/issues/1227)) ([c0ffc83](https://github.com/phrase/strings-openapi/commit/c0ffc839d71105d16b7633f8fea68ff08fbbb5fa))
9
+ * **API:** add key format annotations list endpoint #STRINGS-3028 ([#1222](https://github.com/phrase/strings-openapi/issues/1222)) ([c43cc32](https://github.com/phrase/strings-openapi/commit/c43cc32cd6eadad3d7e2a49e31ca8f070033cf73))
10
+ * **API:** add pre_translations resource to API ([#1224](https://github.com/phrase/strings-openapi/issues/1224)) ([d4ca2d0](https://github.com/phrase/strings-openapi/commit/d4ca2d0a1a47c10ac4b6f0bbe812b52d44974c5c))
11
+
12
+
13
+ ### Bug Fixes
14
+
15
+ * **API:** extract cldr_version enum to fix TypeScript client build ([#1223](https://github.com/phrase/strings-openapi/issues/1223)) ([9a3aa7f](https://github.com/phrase/strings-openapi/commit/9a3aa7f8f1cb61676e554db5e72777a347805a53))
16
+ * **API:** improve delete /projects/{project_id}/keys/{id}/key_links documentation ([#1193](https://github.com/phrase/strings-openapi/issues/1193)) ([b0b2e3f](https://github.com/phrase/strings-openapi/commit/b0b2e3f03407fb59dff1fd6004cf77d7a0aab503))
17
+ * **API:** improve delete /projects/{project_id}/keys/{id}/key_links/{child_key_id} documentation ([#1194](https://github.com/phrase/strings-openapi/issues/1194)) ([c0055b4](https://github.com/phrase/strings-openapi/commit/c0055b46575dfdaec95ee6e13f59b68015493f8b))
18
+ * **API:** improve get /projects/{project_id}/keys/{id}/key_links documentation ([#1188](https://github.com/phrase/strings-openapi/issues/1188)) ([41ae4c9](https://github.com/phrase/strings-openapi/commit/41ae4c93f946012032f41c4f206f53c97121d264))
19
+ * **API:** improve post /icu/skeleton documentation ([#1187](https://github.com/phrase/strings-openapi/issues/1187)) ([1bbf2dc](https://github.com/phrase/strings-openapi/commit/1bbf2dcf6306742bc802ff12d9d6ae6962c4182e))
20
+ * **ruby:** pin link-header-parser to >=7.0 and fix its new keyword arg ([#1229](https://github.com/phrase/strings-openapi/issues/1229)) ([34b7d82](https://github.com/phrase/strings-openapi/commit/34b7d8292cd0ea56da3c2f51d1fc76705b7910cd))
21
+
22
+ ## [4.25.0](https://github.com/phrase/strings-openapi/compare/ruby-v4.24.0...ruby-v4.25.0) (2026-06-25)
23
+
24
+
25
+ ### Features
26
+
27
+ * **API:** Add language_ai_profile to locales ([#1207](https://github.com/phrase/strings-openapi/issues/1207)) ([1dbfc65](https://github.com/phrase/strings-openapi/commit/1dbfc65767a9feead5ec18b35f306b728d7b2779))
28
+ * **API:** add name field to repo sync schema and create endpoint ([#1203](https://github.com/phrase/strings-openapi/issues/1203)) ([ed5dabd](https://github.com/phrase/strings-openapi/commit/ed5dabdc5483e98ac3742466272e9de2f7949a56))
29
+ * **API:** Add translation_key_prefix and filter_by_prefix to async locale download ([#1210](https://github.com/phrase/strings-openapi/issues/1210)) ([9c0dd12](https://github.com/phrase/strings-openapi/commit/9c0dd12d938626d49ee828b6eedf6692d4669414))
30
+ * **API:** document branch compare output ([#1151](https://github.com/phrase/strings-openapi/issues/1151)) ([f082775](https://github.com/phrase/strings-openapi/commit/f0827755e1c6d6c3f66f10db5e6c26dc5003a679))
31
+ * **API:** include review_due_date in job responses ([#1205](https://github.com/phrase/strings-openapi/issues/1205)) ([649d5ab](https://github.com/phrase/strings-openapi/commit/649d5ab6001f46f8c785d8d73cb13ac2062d179b))
32
+
33
+
34
+ ### Bug Fixes
35
+
36
+ * **API:** improve get /formats documentation ([#1196](https://github.com/phrase/strings-openapi/issues/1196)) ([46fd53b](https://github.com/phrase/strings-openapi/commit/46fd53bda361a5b928147ab965515c29dbf887d3))
37
+
3
38
  ## [4.24.0](https://github.com/phrase/strings-openapi/compare/ruby-v4.23.0...ruby-v4.24.0) (2026-06-11)
4
39
 
5
40
 
data/README.md CHANGED
@@ -7,7 +7,7 @@ Phrase Strings is a translation management platform for software projects. You c
7
7
  ## This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
8
 
9
9
  - API version: 2.0.0
10
- - Package version: 4.24.0
10
+ - Package version: 4.26.0
11
11
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
12
12
  For more information, please visit [https://developers.phrase.com/api/](https://developers.phrase.com/api/)
13
13
 
@@ -56,10 +56,10 @@ gem build phrase.gemspec
56
56
  Then install the gem locally:
57
57
 
58
58
  ```shell
59
- gem install ./phrase-4.24.0.gem
59
+ gem install ./phrase-4.26.0.gem
60
60
  ```
61
61
 
62
- (for development, run `gem install --dev ./phrase-4.24.0.gem` to install the development dependencies)
62
+ (for development, run `gem install --dev ./phrase-4.26.0.gem` to install the development dependencies)
63
63
 
64
64
  ## Getting Started
65
65
 
@@ -137,6 +137,8 @@ Class | Method | HTTP request | Description
137
137
  *Phrase::AuthorizationsApi* | [**authorization_show**](docs/AuthorizationsApi.md#authorization_show) | **GET** /authorizations/{id} | Get a single authorization
138
138
  *Phrase::AuthorizationsApi* | [**authorization_update**](docs/AuthorizationsApi.md#authorization_update) | **PATCH** /authorizations/{id} | Update an authorization
139
139
  *Phrase::AuthorizationsApi* | [**authorizations_list**](docs/AuthorizationsApi.md#authorizations_list) | **GET** /authorizations | List authorizations
140
+ *Phrase::AutomationEventsApi* | [**account_automation_events_list**](docs/AutomationEventsApi.md#account_automation_events_list) | **GET** /accounts/{account_id}/automation_events | List automation events for an account
141
+ *Phrase::AutomationEventsApi* | [**automation_events_list**](docs/AutomationEventsApi.md#automation_events_list) | **GET** /accounts/{account_id}/automations/{automation_id}/events | List events for an automation
140
142
  *Phrase::AutomationsApi* | [**automation_activate**](docs/AutomationsApi.md#automation_activate) | **POST** /accounts/{account_id}/automations/{automation_id}/activate | Activate an automation
141
143
  *Phrase::AutomationsApi* | [**automation_create**](docs/AutomationsApi.md#automation_create) | **POST** /accounts/{account_id}/automations | Create an automation
142
144
  *Phrase::AutomationsApi* | [**automation_deactivate**](docs/AutomationsApi.md#automation_deactivate) | **POST** /accounts/{account_id}/automations/{automation_id}/deactivate | Deactivate an automation
@@ -258,6 +260,7 @@ Class | Method | HTTP request | Description
258
260
  *Phrase::JobsApi* | [**job_update**](docs/JobsApi.md#job_update) | **PATCH** /projects/{project_id}/jobs/{id} | Update a job
259
261
  *Phrase::JobsApi* | [**jobs_by_account**](docs/JobsApi.md#jobs_by_account) | **GET** /accounts/{account_id}/jobs | List account jobs
260
262
  *Phrase::JobsApi* | [**jobs_list**](docs/JobsApi.md#jobs_list) | **GET** /projects/{project_id}/jobs | List jobs
263
+ *Phrase::KeyFormatAnnotationsApi* | [**key_format_annotations_list**](docs/KeyFormatAnnotationsApi.md#key_format_annotations_list) | **GET** /projects/{project_id}/keys/{id}/format_annotations | List format annotations for a key
261
264
  *Phrase::KeysApi* | [**key_create**](docs/KeysApi.md#key_create) | **POST** /projects/{project_id}/keys | Create a key
262
265
  *Phrase::KeysApi* | [**key_delete**](docs/KeysApi.md#key_delete) | **DELETE** /projects/{project_id}/keys/{id} | Delete a key
263
266
  *Phrase::KeysApi* | [**key_show**](docs/KeysApi.md#key_show) | **GET** /projects/{project_id}/keys/{id} | Get a single key
@@ -310,6 +313,9 @@ Class | Method | HTTP request | Description
310
313
  *Phrase::OrganizationJobTemplatesApi* | [**organization_job_template_update**](docs/OrganizationJobTemplatesApi.md#organization_job_template_update) | **PATCH** /accounts/{account_id}/job_templates/{id} | Update an organization job template
311
314
  *Phrase::OrganizationJobTemplatesApi* | [**organization_job_templates_list**](docs/OrganizationJobTemplatesApi.md#organization_job_templates_list) | **GET** /accounts/{account_id}/job_templates | List organization job templates
312
315
  *Phrase::OrganizationJobTemplatesApi* | [**organization_job_templates_show**](docs/OrganizationJobTemplatesApi.md#organization_job_templates_show) | **GET** /accounts/{account_id}/job_templates/{id} | Get a single organization job template
316
+ *Phrase::PreTranslationsApi* | [**pre_translation_create**](docs/PreTranslationsApi.md#pre_translation_create) | **POST** /projects/{project_id}/pre_translations | Create a pre-translation job
317
+ *Phrase::PreTranslationsApi* | [**pre_translation_show**](docs/PreTranslationsApi.md#pre_translation_show) | **GET** /projects/{project_id}/pre_translations/{id} | Get a single pre-translation job
318
+ *Phrase::PreTranslationsApi* | [**pre_translations_list**](docs/PreTranslationsApi.md#pre_translations_list) | **GET** /projects/{project_id}/pre_translations | List pre-translation jobs
313
319
  *Phrase::ProjectsApi* | [**project_create**](docs/ProjectsApi.md#project_create) | **POST** /projects | Create a project
314
320
  *Phrase::ProjectsApi* | [**project_delete**](docs/ProjectsApi.md#project_delete) | **DELETE** /projects/{id} | Delete a project
315
321
  *Phrase::ProjectsApi* | [**project_show**](docs/ProjectsApi.md#project_show) | **GET** /projects/{id} | Get a single project
@@ -431,12 +437,18 @@ Class | Method | HTTP request | Description
431
437
  - [Phrase::AuthorizationUpdateParameters](docs/AuthorizationUpdateParameters.md)
432
438
  - [Phrase::AuthorizationWithToken](docs/AuthorizationWithToken.md)
433
439
  - [Phrase::Automation](docs/Automation.md)
440
+ - [Phrase::AutomationEvent](docs/AutomationEvent.md)
441
+ - [Phrase::AutomationEventProject](docs/AutomationEventProject.md)
434
442
  - [Phrase::AutomationsCreateParameters](docs/AutomationsCreateParameters.md)
435
443
  - [Phrase::AutomationsCreateParameters1](docs/AutomationsCreateParameters1.md)
436
444
  - [Phrase::BlacklistedKey](docs/BlacklistedKey.md)
437
445
  - [Phrase::BlacklistedKeyCreateParameters](docs/BlacklistedKeyCreateParameters.md)
438
446
  - [Phrase::BlacklistedKeyUpdateParameters](docs/BlacklistedKeyUpdateParameters.md)
439
447
  - [Phrase::Branch](docs/Branch.md)
448
+ - [Phrase::BranchComparison](docs/BranchComparison.md)
449
+ - [Phrase::BranchComparisonChange](docs/BranchComparisonChange.md)
450
+ - [Phrase::BranchComparisonDiff](docs/BranchComparisonDiff.md)
451
+ - [Phrase::BranchComparisonDiffConflictsValue](docs/BranchComparisonDiffConflictsValue.md)
440
452
  - [Phrase::BranchCreateComparisonParameters](docs/BranchCreateComparisonParameters.md)
441
453
  - [Phrase::BranchCreateParameters](docs/BranchCreateParameters.md)
442
454
  - [Phrase::BranchMergeParameters](docs/BranchMergeParameters.md)
@@ -478,6 +490,7 @@ Class | Method | HTTP request | Description
478
490
  - [Phrase::GlossaryTermUpdateParameters](docs/GlossaryTermUpdateParameters.md)
479
491
  - [Phrase::GlossaryUpdateParameters](docs/GlossaryUpdateParameters.md)
480
492
  - [Phrase::Icu](docs/Icu.md)
493
+ - [Phrase::IcuSkeletonError](docs/IcuSkeletonError.md)
481
494
  - [Phrase::IcuSkeletonParameters](docs/IcuSkeletonParameters.md)
482
495
  - [Phrase::Invitation](docs/Invitation.md)
483
496
  - [Phrase::InvitationCreateParameters](docs/InvitationCreateParameters.md)
@@ -514,10 +527,10 @@ Class | Method | HTTP request | Description
514
527
  - [Phrase::JobTemplateUpdateParameters](docs/JobTemplateUpdateParameters.md)
515
528
  - [Phrase::JobUpdateParameters](docs/JobUpdateParameters.md)
516
529
  - [Phrase::KeyCreateParameters](docs/KeyCreateParameters.md)
530
+ - [Phrase::KeyFormatAnnotationsList200ResponseInner](docs/KeyFormatAnnotationsList200ResponseInner.md)
517
531
  - [Phrase::KeyLink](docs/KeyLink.md)
518
532
  - [Phrase::KeyLinksBatchDestroyParameters](docs/KeyLinksBatchDestroyParameters.md)
519
533
  - [Phrase::KeyLinksCreateParameters](docs/KeyLinksCreateParameters.md)
520
- - [Phrase::KeyLinksIndex400Response](docs/KeyLinksIndex400Response.md)
521
534
  - [Phrase::KeyPreview](docs/KeyPreview.md)
522
535
  - [Phrase::KeyUpdateParameters](docs/KeyUpdateParameters.md)
523
536
  - [Phrase::KeysExcludeParameters](docs/KeysExcludeParameters.md)
@@ -556,6 +569,8 @@ Class | Method | HTTP request | Description
556
569
  - [Phrase::OrganizationJobTemplateLocaleUpdateParameters](docs/OrganizationJobTemplateLocaleUpdateParameters.md)
557
570
  - [Phrase::OrganizationJobTemplateLocalesCreateParameters](docs/OrganizationJobTemplateLocalesCreateParameters.md)
558
571
  - [Phrase::OrganizationJobTemplateUpdateParameters](docs/OrganizationJobTemplateUpdateParameters.md)
572
+ - [Phrase::PreTranslation](docs/PreTranslation.md)
573
+ - [Phrase::PreTranslationCreateParameters](docs/PreTranslationCreateParameters.md)
559
574
  - [Phrase::Project](docs/Project.md)
560
575
  - [Phrase::ProjectCreateParameters](docs/ProjectCreateParameters.md)
561
576
  - [Phrase::ProjectDetails](docs/ProjectDetails.md)
data/docs/AutomationEvent.md ADDED
@@ -0,0 +1,33 @@
1
+ # Phrase::AutomationEvent
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **id** | **String** | Unique identifier of the automation event. | [optional]
8
+ **automation_id** | **String** | Identifier of the automation that produced this event. | [optional]
9
+ **state** | **String** | Outcome of the automation run. | [optional]
10
+ **triggered_by** | **String** | What caused the automation to run. | [optional]
11
+ **created_at** | **Time** | Timestamp when the event was created. | [optional]
12
+ **jobs_created** | **Integer** | Number of jobs created during this automation run. | [optional]
13
+ **job_ids** | **Array<String>** | Identifiers of the jobs created during this automation run. | [optional]
14
+ **project** | [**AutomationEventProject**](AutomationEventProject.md) | | [optional]
15
+ **details** | **String** | Error message describing the failure when state is `failure`; null otherwise. | [optional]
16
+
17
+ ## Code Sample
18
+
19
+ ```ruby
20
+ require 'Phrase'
21
+
22
+ instance = Phrase::AutomationEvent.new(id: null,
23
+ automation_id: null,
24
+ state: null,
25
+ triggered_by: null,
26
+ created_at: null,
27
+ jobs_created: null,
28
+ job_ids: null,
29
+ project: null,
30
+ details: null)
31
+ ```
32
+
33
+
data/docs/AutomationEventProject.md ADDED
@@ -0,0 +1,19 @@
1
+ # Phrase::AutomationEventProject
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **id** | **String** | Project identifier. | [optional]
8
+ **name** | **String** | Project name. | [optional]
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'Phrase'
14
+
15
+ instance = Phrase::AutomationEventProject.new(id: null,
16
+ name: null)
17
+ ```
18
+
19
+
data/docs/AutomationEventsApi.md ADDED
@@ -0,0 +1,168 @@
1
+ # Phrase::AutomationEventsApi
2
+
3
+ All URIs are relative to *https://api.phrase.com/v2*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**account_automation_events_list**](AutomationEventsApi.md#account_automation_events_list) | **GET** /accounts/{account_id}/automation_events | List automation events for an account
8
+ [**automation_events_list**](AutomationEventsApi.md#automation_events_list) | **GET** /accounts/{account_id}/automations/{automation_id}/events | List events for an automation
9
+
10
+
11
+
12
+ ## account_automation_events_list
13
+
14
+ > Array<AutomationEvent> account_automation_events_list(account_id, opts)
15
+
16
+ List automation events for an account
17
+
18
+ Returns the run history across all automations in the account, newest-first. Use `automation_id` to narrow results to a single automation. Use `project_id` or `project_ids` to narrow by project. For feature availability, see [Jobs (Strings)](https://support.phrase.com/hc/en-us/articles/5784100517788-Jobs-Strings).
19
+
20
+ ### Example
21
+
22
+ ```ruby
23
+ # load the gem
24
+ require 'phrase'
25
+ # setup authorization
26
+ Phrase.configure do |config|
27
+ # Configure HTTP basic authorization: Basic
28
+ config.username = 'YOUR USERNAME'
29
+ config.password = 'YOUR PASSWORD'
30
+
31
+ # Configure API key authorization: Token
32
+ config.api_key['Authorization'] = 'YOUR API KEY'
33
+ config.api_key_prefix['Authorization'] = 'token'
34
+ end
35
+
36
+ api_instance = Phrase::AutomationEventsApi.new
37
+ account_id = 'account_id_example' # String | Account ID
38
+ opts = {
39
+ x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
40
+ page: 1, # Integer | Page number
41
+ per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
42
+ automation_id: 'automation_id_example', # String | Filter events to a single automation by its ID.
43
+ state: 'success', # String | Filter events by outcome state. Unrecognized values are ignored.
44
+ triggered_by: 'manual', # String | Filter events by what triggered the automation run. Unrecognized values are ignored.
45
+ project_id: 'project_id_example', # String | Filter events by project ID. Accepts a single ID or a comma-separated list of IDs.
46
+ project_ids: ['inner_example'], # Array<String> | Filter events by one or more project IDs.
47
+ created_after: '2023-01-01T00:00:00Z', # String | Return only events created after this ISO 8601 timestamp. Returns 400 if the value is not a valid date-time.
48
+ created_before: '2023-01-01T00:00:00Z' # String | Return only events created before this ISO 8601 timestamp. Returns 400 if the value is not a valid date-time.
49
+ }
50
+
51
+ begin
52
+ #List automation events for an account
53
+ result = api_instance.account_automation_events_list(account_id, opts)
54
+ pp result
55
+ rescue Phrase::ApiError => e
56
+ puts "Exception when calling AutomationEventsApi->account_automation_events_list: #{e}"
57
+ end
58
+ ```
59
+
60
+ ### Parameters
61
+
62
+
63
+ Name | Type | Description | Notes
64
+ ------------- | ------------- | ------------- | -------------
65
+ **account_id** | **String**| Account ID |
66
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
67
+ **page** | **Integer**| Page number | [optional]
68
+ **per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
69
+ **automation_id** | **String**| Filter events to a single automation by its ID. | [optional]
70
+ **state** | **String**| Filter events by outcome state. Unrecognized values are ignored. | [optional]
71
+ **triggered_by** | **String**| Filter events by what triggered the automation run. Unrecognized values are ignored. | [optional]
72
+ **project_id** | **String**| Filter events by project ID. Accepts a single ID or a comma-separated list of IDs. | [optional]
73
+ **project_ids** | [**Array&lt;String&gt;**](String.md)| Filter events by one or more project IDs. | [optional]
74
+ **created_after** | **String**| Return only events created after this ISO 8601 timestamp. Returns 400 if the value is not a valid date-time. | [optional]
75
+ **created_before** | **String**| Return only events created before this ISO 8601 timestamp. Returns 400 if the value is not a valid date-time. | [optional]
76
+
77
+ ### Return type
78
+
79
+ Response<([**Array&lt;AutomationEvent&gt;**](AutomationEvent.md))>
80
+
81
+ ### Authorization
82
+
83
+ [Basic](../README.md#Basic), [Token](../README.md#Token)
84
+
85
+ ### HTTP request headers
86
+
87
+ - **Content-Type**: Not defined
88
+ - **Accept**: application/json
89
+
90
+
91
+ ## automation_events_list
92
+
93
+ > Array&lt;AutomationEvent&gt; automation_events_list(account_id, id, opts)
94
+
95
+ List events for an automation
96
+
97
+ Returns the run history for a specific automation, newest-first. For feature availability, see [Jobs (Strings)](https://support.phrase.com/hc/en-us/articles/5784100517788-Jobs-Strings).
98
+
99
+ ### Example
100
+
101
+ ```ruby
102
+ # load the gem
103
+ require 'phrase'
104
+ # setup authorization
105
+ Phrase.configure do |config|
106
+ # Configure HTTP basic authorization: Basic
107
+ config.username = 'YOUR USERNAME'
108
+ config.password = 'YOUR PASSWORD'
109
+
110
+ # Configure API key authorization: Token
111
+ config.api_key['Authorization'] = 'YOUR API KEY'
112
+ config.api_key_prefix['Authorization'] = 'token'
113
+ end
114
+
115
+ api_instance = Phrase::AutomationEventsApi.new
116
+ account_id = 'account_id_example' # String | Account ID
117
+ id = 'id_example' # String | ID
118
+ opts = {
119
+ x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
120
+ page: 1, # Integer | Page number
121
+ per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
122
+ state: 'success', # String | Filter events by outcome state. Unrecognized values are ignored.
123
+ triggered_by: 'manual', # String | Filter events by what triggered the automation run. Unrecognized values are ignored.
124
+ project_id: 'project_id_example', # String | Filter events by project ID. Accepts a single ID or a comma-separated list of IDs.
125
+ project_ids: ['inner_example'], # Array<String> | Filter events by one or more project IDs.
126
+ created_after: '2023-01-01T00:00:00Z', # String | Return only events created after this ISO 8601 timestamp. Returns 400 if the value is not a valid date-time.
127
+ created_before: '2023-01-01T00:00:00Z' # String | Return only events created before this ISO 8601 timestamp. Returns 400 if the value is not a valid date-time.
128
+ }
129
+
130
+ begin
131
+ #List events for an automation
132
+ result = api_instance.automation_events_list(account_id, id, opts)
133
+ pp result
134
+ rescue Phrase::ApiError => e
135
+ puts "Exception when calling AutomationEventsApi->automation_events_list: #{e}"
136
+ end
137
+ ```
138
+
139
+ ### Parameters
140
+
141
+
142
+ Name | Type | Description | Notes
143
+ ------------- | ------------- | ------------- | -------------
144
+ **account_id** | **String**| Account ID |
145
+ **id** | **String**| ID |
146
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
147
+ **page** | **Integer**| Page number | [optional]
148
+ **per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
149
+ **state** | **String**| Filter events by outcome state. Unrecognized values are ignored. | [optional]
150
+ **triggered_by** | **String**| Filter events by what triggered the automation run. Unrecognized values are ignored. | [optional]
151
+ **project_id** | **String**| Filter events by project ID. Accepts a single ID or a comma-separated list of IDs. | [optional]
152
+ **project_ids** | [**Array&lt;String&gt;**](String.md)| Filter events by one or more project IDs. | [optional]
153
+ **created_after** | **String**| Return only events created after this ISO 8601 timestamp. Returns 400 if the value is not a valid date-time. | [optional]
154
+ **created_before** | **String**| Return only events created before this ISO 8601 timestamp. Returns 400 if the value is not a valid date-time. | [optional]
155
+
156
+ ### Return type
157
+
158
+ Response<([**Array&lt;AutomationEvent&gt;**](AutomationEvent.md))>
159
+
160
+ ### Authorization
161
+
162
+ [Basic](../README.md#Basic), [Token](../README.md#Token)
163
+
164
+ ### HTTP request headers
165
+
166
+ - **Content-Type**: Not defined
167
+ - **Accept**: application/json
168
+
data/docs/AutomationsCreateParameters.md CHANGED
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **name** | **String** | name of the automation |
8
8
  **trigger** | **String** | |
9
- **project_ids** | **Array&lt;String&gt;** | List of project IDs to associate with the automation. Currently, only the first ID in the array is used. The array format leaves room for future support of multiple projects. |
9
+ **project_ids** | **Array&lt;String&gt;** | List of project IDs to associate with the automation. Providing more than one project ID requires the &#x60;advanced_job_automation&#x60; plan feature; accounts without this feature receive a 422 response with error field &#x60;project_ids&#x60;. |
10
10
  **job_template_id** | **String** | id of job template that the automation uses to create jobs from | [optional]
11
11
  **status_filters** | **Array&lt;String&gt;** | Translation states used when selecting keys for a job. States are derived from associated translations, not the keys themselves. When review workflow is enabled, &#x60;ready_for_review&#x60; is internally treated as &#x60;translated&#x60;. |
12
12
  **tags** | **Array&lt;String&gt;** | used to filter which keys are added to jobs | [optional]
data/docs/AutomationsCreateParameters1.md CHANGED
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **name** | **String** | name of the automation |
8
8
  **trigger** | **String** | |
9
- **project_ids** | **Array&lt;String&gt;** | List of project IDs to associate with the automation. Currently, only the first ID in the array is used. The array format leaves room for future support of multiple projects. |
9
+ **project_ids** | **Array&lt;String&gt;** | List of project IDs to associate with the automation. Providing more than one project ID requires the &#x60;advanced_job_automation&#x60; plan feature; accounts without this feature receive a 422 response with error field &#x60;project_ids&#x60;. |
10
10
  **job_template_id** | **String** | id of job template that the automation uses to create jobs from | [optional]
11
11
  **status_filters** | **Array&lt;String&gt;** | translation key statuses used to filter keys that are added to jobs |
12
12
  **tags** | **Array&lt;String&gt;** | used to filter which keys are added to jobs | [optional]
data/docs/BranchComparison.md ADDED
@@ -0,0 +1,23 @@
1
+ # Phrase::BranchComparison
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **translation_keys** | [**BranchComparisonDiff**](BranchComparisonDiff.md) | | [optional]
8
+ **translations** | [**BranchComparisonDiff**](BranchComparisonDiff.md) | | [optional]
9
+ **locales** | [**BranchComparisonDiff**](BranchComparisonDiff.md) | | [optional]
10
+ **tags** | [**BranchComparisonDiff**](BranchComparisonDiff.md) | | [optional]
11
+
12
+ ## Code Sample
13
+
14
+ ```ruby
15
+ require 'Phrase'
16
+
17
+ instance = Phrase::BranchComparison.new(translation_keys: null,
18
+ translations: null,
19
+ locales: null,
20
+ tags: null)
21
+ ```
22
+
23
+
data/docs/BranchComparisonChange.md ADDED
@@ -0,0 +1,19 @@
1
+ # Phrase::BranchComparisonChange
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **from** | **Hash&lt;String, Object&gt;** | | [optional]
8
+ **to** | **Hash&lt;String, Object&gt;** | | [optional]
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'Phrase'
14
+
15
+ instance = Phrase::BranchComparisonChange.new(from: null,
16
+ to: null)
17
+ ```
18
+
19
+
data/docs/BranchComparisonDiff.md ADDED
@@ -0,0 +1,21 @@
1
+ # Phrase::BranchComparisonDiff
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **base_changes** | [**Array&lt;BranchComparisonChange&gt;**](BranchComparisonChange.md) | Changes made to this resource type in the base branch since the branch was created. | [optional]
8
+ **head_changes** | [**Array&lt;BranchComparisonChange&gt;**](BranchComparisonChange.md) | Changes made to this resource type in the feature branch. | [optional]
9
+ **conflicts** | [**Hash&lt;String, BranchComparisonDiffConflictsValue&gt;**](BranchComparisonDiffConflictsValue.md) | Conflicting changes present in both branches, keyed by conflict type. Possible conflict type keys: &#x60;changed_in_head_changed_in_base&#x60;, &#x60;added_in_head_added_in_base&#x60;, &#x60;changed_in_head_deleted_in_base&#x60;, &#x60;deleted_in_head_changed_in_base&#x60;. Each value contains &#x60;base&#x60; and &#x60;head&#x60; arrays of changed attribute objects. | [optional]
10
+
11
+ ## Code Sample
12
+
13
+ ```ruby
14
+ require 'Phrase'
15
+
16
+ instance = Phrase::BranchComparisonDiff.new(base_changes: null,
17
+ head_changes: null,
18
+ conflicts: null)
19
+ ```
20
+
21
+
data/docs/BranchComparisonDiffConflictsValue.md ADDED
@@ -0,0 +1,19 @@
1
+ # Phrase::BranchComparisonDiffConflictsValue
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **base** | **Array&lt;Hash&lt;String, Object&gt;&gt;** | | [optional]
8
+ **head** | **Array&lt;Hash&lt;String, Object&gt;&gt;** | | [optional]
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'Phrase'
14
+
15
+ instance = Phrase::BranchComparisonDiffConflictsValue.new(base: null,
16
+ head: null)
17
+ ```
18
+
19
+
data/docs/BranchesApi.md CHANGED
@@ -18,7 +18,7 @@ Method | HTTP request | Description
18
18
 
19
19
  ## branch_compare
20
20
 
21
- > branch_compare(project_id, name, opts)
21
+ > BranchComparison branch_compare(project_id, name, opts)
22
22
 
23
23
  Compare branches
24
24
 
@@ -49,7 +49,8 @@ opts = {
49
49
 
50
50
  begin
51
51
  #Compare branches
52
- api_instance.branch_compare(project_id, name, opts)
52
+ result = api_instance.branch_compare(project_id, name, opts)
53
+ pp result
53
54
  rescue Phrase::ApiError => e
54
55
  puts "Exception when calling BranchesApi->branch_compare: #{e}"
55
56
  end
@@ -66,7 +67,7 @@ Name | Type | Description | Notes
66
67
 
67
68
  ### Return type
68
69
 
69
- Response<(nil (empty response body))>
70
+ Response<([**BranchComparison**](BranchComparison.md))>
70
71
 
71
72
  ### Authorization
72
73
 
@@ -75,7 +76,7 @@ Response<(nil (empty response body))>
75
76
  ### HTTP request headers
76
77
 
77
78
  - **Content-Type**: Not defined
78
- - **Accept**: Not defined
79
+ - **Accept**: application/json
79
80
 
80
81
 
81
82
  ## branch_comparison_create
data/docs/DocumentsApi.md CHANGED
@@ -15,7 +15,7 @@ Method | HTTP request | Description
15
15
 
16
16
  Delete document
17
17
 
18
- Delete an existing document.
18
+ Permanently deletes a document and all of its associated translation segments from the project. Use this when you want to remove a document that is no longer needed; the deletion cannot be reversed and all associated segments will be lost.
19
19
 
20
20
  ### Example
21
21
 
@@ -77,7 +77,7 @@ Response<(nil (empty response body))>
77
77
 
78
78
  List documents
79
79
 
80
- List all documents the current user has access to.
80
+ Returns all documents in a project that the authenticated user has read access to. A Document is a source file — an HTML or DOCX file — that has been uploaded to Phrase Strings and whose content is segmented into translation keys for localization. Use this endpoint to enumerate documents before downloading, previewing, or triggering translation workflows for individual files. The q parameter performs a prefix match on the document name (case-insensitive). For example, passing q=invoice returns documents whose names begin with \"invoice\" but not documents containing \"invoice\" elsewhere in the name.
81
81
 
82
82
  ### Example
83
83
 
@@ -101,7 +101,7 @@ opts = {
101
101
  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
102
102
  page: 1, # Integer | Page number
103
103
  per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
104
- q: 'invoice' # String | Search query. Filters documents by name (case-insensitive substring match).
104
+ q: 'invoice' # String | Filter documents by name prefix. Returns documents whose name starts with the given value (case-insensitive).
105
105
  }
106
106
 
107
107
  begin
@@ -122,7 +122,7 @@ Name | Type | Description | Notes
122
122
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
123
123
  **page** | **Integer**| Page number | [optional]
124
124
  **per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
125
- **q** | **String**| Search query. Filters documents by name (case-insensitive substring match). | [optional]
125
+ **q** | **String**| Filter documents by name prefix. Returns documents whose name starts with the given value (case-insensitive). | [optional]
126
126
 
127
127
  ### Return type
128
128
 
data/docs/Format.md CHANGED
@@ -4,32 +4,32 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **name** | **String** | | [optional]
8
- **api_name** | **String** | | [optional]
9
- **description** | **String** | | [optional]
10
- **extension** | **String** | | [optional]
11
- **default_encoding** | **String** | | [optional]
12
- **importable** | **Boolean** | | [optional]
13
- **exportable** | **Boolean** | | [optional]
14
- **default_file** | **String** | | [optional]
15
- **renders_default_locale** | **Boolean** | | [optional]
16
- **includes_locale_information** | **Boolean** | | [optional]
7
+ **name** | **String** | Human-readable display name of the format. |
8
+ **api_name** | **String** | Identifier used to reference this format in API requests, such as the file_format parameter on the uploads and downloads endpoints. |
9
+ **description** | **String** | Human-readable summary of the format and its typical use case. |
10
+ **extension** | **String** | Default file extension associated with this format. |
11
+ **default_encoding** | **String** | Default character encoding used when reading or writing files in this format. |
12
+ **importable** | **Boolean** | Whether locale files can be imported using this format. |
13
+ **exportable** | **Boolean** | Whether locale files can be exported using this format. |
14
+ **default_file** | **String** | Conventional file path pattern for this format. Contains locale_name as a placeholder for the locale identifier. |
15
+ **renders_default_locale** | **Boolean** | When true, exported files contain the default locale&#39;s content for any key that has no translation in the target locale. |
16
+ **includes_locale_information** | **Boolean** | When true, files in this format embed locale information so Phrase can detect the locale automatically on import. |
17
17
 
18
18
  ## Code Sample
19
19
 
20
20
  ```ruby
21
21
  require 'Phrase'
22
22
 
23
- instance = Phrase::Format.new(name: null,
24
- api_name: null,
25
- description: null,
26
- extension: null,
27
- default_encoding: null,
28
- importable: null,
29
- exportable: null,
30
- default_file: null,
31
- renders_default_locale: null,
32
- includes_locale_information: null)
23
+ instance = Phrase::Format.new(name: Ruby/Rails YAML,
24
+ api_name: yml,
25
+ description: YAML file format for use with Ruby/Rails applications,
26
+ extension: yml,
27
+ default_encoding: UTF-8,
28
+ importable: true,
29
+ exportable: true,
30
+ default_file: ./config/locales/&lt;locale_name&gt;.yml,
31
+ renders_default_locale: false,
32
+ includes_locale_information: false)
33
33
  ```
34
34
 
35
35
 
data/docs/FormatsApi.md CHANGED
@@ -14,7 +14,7 @@ Method | HTTP request | Description
14
14
 
15
15
  List formats
16
16
 
17
- Get a handy list of all localization file formats supported in Phrase.
17
+ Returns all file formats that Phrase Strings supports. Use the api_name value from each format as the file_format parameter when uploading or downloading locale files. Not every format supports both directions: check the importable and exportable fields before using a format in a workflow. This endpoint does not require authentication and is not subject to rate limiting.
18
18
 
19
19
  ### Example
20
20
 
data/docs/ICUApi.md CHANGED
@@ -14,7 +14,7 @@ Method | HTTP request | Description
14
14
 
15
15
  Build ICU skeletons
16
16
 
17
- Returns ICU skeletons for multiple locale codes based on a source content.
17
+ Generates ICU (International Components for Unicode) message format skeletons for a given source string across one or more locales. An ICU skeleton strips the literal text from a pluralized or select message while preserving its structural rules — argument names, plural categories, select cases, and ordinal forms — adjusted to the pluralization rules of each requested locale. Use this endpoint to normalize translation templates before importing them into locale files, or to validate that a source string carries the plural forms required by a target language. Either `content` or `id` must be provided — supplying both or neither returns 400. When `id` is used and the referenced translation does not exist, the endpoint returns 404. When the source string is not valid ICU message format syntax, the endpoint returns 422 with an `error` field describing the parse failure.
18
18
 
19
19
  ### Example
20
20