phrase 4.25.0 → 4.27.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 (113) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +29 -0
  3. data/README.md +26 -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/CheckIssue.md +33 -0
  10. data/docs/ChecksApi.md +146 -0
  11. data/docs/DocumentsApi.md +4 -4
  12. data/docs/ICUApi.md +1 -1
  13. data/docs/IcuSkeletonError.md +17 -0
  14. data/docs/IcuSkeletonParameters.md +11 -11
  15. data/docs/JobCreateParameters.md +1 -1
  16. data/docs/JobsApi.md +2 -2
  17. data/docs/KeyCreateParameters.md +1 -1
  18. data/docs/KeyFormatAnnotationsApi.md +74 -0
  19. data/docs/KeyFormatAnnotationsList200ResponseInner.md +19 -0
  20. data/docs/KeyLinksBatchDestroyParameters.md +6 -4
  21. data/docs/KeyLinksCreateParameters.md +2 -2
  22. data/docs/KeyUpdateParameters.md +1 -1
  23. data/docs/LinkedKeysApi.md +14 -13
  24. data/docs/Locale.md +6 -0
  25. data/docs/LocaleCreateParameters.md +2 -0
  26. data/docs/LocaleDetails.md +6 -0
  27. data/docs/LocaleUpdateParameters.md +2 -0
  28. data/docs/MachineTranslationApi.md +263 -0
  29. data/docs/MachineTranslationLocaleProviderMapping.md +21 -0
  30. data/docs/MachineTranslationLocaleProviderMappingsCreateParameters.md +21 -0
  31. data/docs/MachineTranslationSettings.md +23 -0
  32. data/docs/MachineTranslationSettingsUpdateParameters.md +17 -0
  33. data/docs/PreTranslation.md +29 -0
  34. data/docs/PreTranslationCreateParameters.md +19 -0
  35. data/docs/PreTranslationsApi.md +210 -0
  36. data/docs/ProjectCreateParameters.md +8 -2
  37. data/docs/ProjectDetails.md +3 -1
  38. data/docs/ProjectUpdateParameters.md +8 -2
  39. data/docs/ScreenshotUpdateParameters.md +1 -1
  40. data/docs/ScreenshotsApi.md +2 -2
  41. data/docs/Upload.md +3 -1
  42. data/docs/UploadsApi.md +4 -4
  43. data/lib/phrase/api/automation_events_api.rb +215 -0
  44. data/lib/phrase/api/checks_api.rb +174 -0
  45. data/lib/phrase/api/documents_api.rb +6 -6
  46. data/lib/phrase/api/icu_api.rb +2 -6
  47. data/lib/phrase/api/key_format_annotations_api.rb +85 -0
  48. data/lib/phrase/api/linked_keys_api.rb +19 -23
  49. data/lib/phrase/api/machine_translation_api.rb +302 -0
  50. data/lib/phrase/api/pre_translations_api.rb +240 -0
  51. data/lib/phrase/api/screenshots_api.rb +4 -4
  52. data/lib/phrase/api/uploads_api.rb +6 -6
  53. data/lib/phrase/models/automation_event.rb +325 -0
  54. data/lib/phrase/models/automation_event_project.rb +208 -0
  55. data/lib/phrase/models/automations_create_parameters.rb +1 -1
  56. data/lib/phrase/models/automations_create_parameters1.rb +1 -1
  57. data/lib/phrase/models/check_issue.rb +319 -0
  58. data/lib/phrase/models/{key_links_index400_response.rb → icu_skeleton_error.rb} +11 -10
  59. data/lib/phrase/models/icu_skeleton_parameters.rb +6 -6
  60. data/lib/phrase/models/job_create_parameters.rb +1 -1
  61. data/lib/phrase/models/key_format_annotations_list200_response_inner.rb +207 -0
  62. data/lib/phrase/models/key_links_batch_destroy_parameters.rb +52 -6
  63. data/lib/phrase/models/key_links_create_parameters.rb +1 -1
  64. data/lib/phrase/models/locale.rb +31 -1
  65. data/lib/phrase/models/locale_create_parameters.rb +11 -1
  66. data/lib/phrase/models/locale_details.rb +31 -1
  67. data/lib/phrase/models/locale_update_parameters.rb +11 -1
  68. data/lib/phrase/models/machine_translation_locale_provider_mapping.rb +217 -0
  69. data/lib/phrase/models/machine_translation_locale_provider_mappings_create_parameters.rb +232 -0
  70. data/lib/phrase/models/machine_translation_settings.rb +230 -0
  71. data/lib/phrase/models/machine_translation_settings_update_parameters.rb +198 -0
  72. data/lib/phrase/models/pre_translation.rb +301 -0
  73. data/lib/phrase/models/pre_translation_create_parameters.rb +241 -0
  74. data/lib/phrase/models/project_create_parameters.rb +35 -1
  75. data/lib/phrase/models/project_details.rb +10 -1
  76. data/lib/phrase/models/project_update_parameters.rb +35 -1
  77. data/lib/phrase/models/upload.rb +13 -1
  78. data/lib/phrase/response.rb +2 -2
  79. data/lib/phrase/version.rb +1 -1
  80. data/lib/phrase.rb +16 -1
  81. data/phrase.gemspec +1 -1
  82. data/spec/api/automation_events_api_spec.rb +67 -0
  83. data/spec/api/checks_api_spec.rb +56 -0
  84. data/spec/api/documents_api_spec.rb +3 -3
  85. data/spec/api/icu_api_spec.rb +1 -1
  86. data/spec/api/key_format_annotations_api_spec.rb +38 -0
  87. data/spec/api/linked_keys_api_spec.rb +7 -7
  88. data/spec/api/machine_translation_api_spec.rb +79 -0
  89. data/spec/api/pre_translations_api_spec.rb +70 -0
  90. data/spec/api/screenshots_api_spec.rb +2 -2
  91. data/spec/models/automation_event_project_spec.rb +35 -0
  92. data/spec/models/automation_event_spec.rb +85 -0
  93. data/spec/models/check_issue_spec.rb +85 -0
  94. data/spec/models/{key_links_index400_response_spec.rb → icu_skeleton_error_spec.rb} +7 -7
  95. data/spec/models/key_format_annotations_list200_response_inner_spec.rb +35 -0
  96. data/spec/models/key_links_batch_destroy_parameters_spec.rb +10 -0
  97. data/spec/models/locale_create_parameters_spec.rb +6 -0
  98. data/spec/models/locale_details_spec.rb +18 -0
  99. data/spec/models/locale_spec.rb +18 -0
  100. data/spec/models/locale_update_parameters_spec.rb +6 -0
  101. data/spec/models/machine_translation_locale_provider_mapping_spec.rb +41 -0
  102. data/spec/models/machine_translation_locale_provider_mappings_create_parameters_spec.rb +41 -0
  103. data/spec/models/machine_translation_settings_spec.rb +47 -0
  104. data/spec/models/machine_translation_settings_update_parameters_spec.rb +29 -0
  105. data/spec/models/pre_translation_create_parameters_spec.rb +39 -0
  106. data/spec/models/pre_translation_spec.rb +73 -0
  107. data/spec/models/project_create_parameters_spec.rb +18 -0
  108. data/spec/models/project_details_spec.rb +6 -0
  109. data/spec/models/project_update_parameters_spec.rb +18 -0
  110. data/spec/models/upload_spec.rb +6 -0
  111. data/spec/response_spec.rb +53 -0
  112. metadata +313 -251
  113. data/docs/KeyLinksIndex400Response.md +0 -17
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e6cad43dbdeb14af43039a96509f173dcd8c3358bbaab868cb16cf04cb4fc05f
4
- data.tar.gz: 3721a11b575861aad15b88d6dd410dd826405f57178286542dc37149de357b73
3
+ metadata.gz: b9d9e28741eb8f8bbe8e1665cf606df481812ed7d6a46373d6bd53b56e3f2900
4
+ data.tar.gz: b54de0daa747506e05f1bb22ff187140cb03c1d897e0289c326b62e7fb882c56
5
5
  SHA512:
6
- metadata.gz: 427e8f756767ed00efba125b3f5e168b51ec77b041e8aaa41d9af0a0a19a553a433941f5bc1988f2ab069c95170b8491fca8b4c5639c0590e94fe0eead400807
7
- data.tar.gz: 1e52d069831312b3b82526499e19f6297e9e231e9b3106e6eb301277d667788d88753632cc8b76972be9bb219a0f34370224a14b054c60cfd413eba6bf09f1f8
6
+ metadata.gz: 939db696e111f5c0a02c237b46cf55a6418413693afc17a2bdeeff6d9fe98c5bd88476c6fa9c316d24472932fc0f535ec6d7c6265c7c135538c7e571b2df70d6
7
+ data.tar.gz: d33c4748b40ae24fb0162c9f57ad801daca3e1ff26a1da4af11cefe755d93af40fd3bdee36dd75e7dee3fdee2351f6365d753c35d2c96204689e917d06f1c625
data/CHANGELOG.md CHANGED
@@ -1,5 +1,34 @@
1
1
  # Changelog
2
2
 
3
+ ## [4.27.0](https://github.com/phrase/strings-openapi/compare/ruby-v4.26.0...ruby-v4.27.0) (2026-09-11)
4
+
5
+
6
+ ### Features
7
+
8
+ * **API:** add Checks API endpoints ([#1242](https://github.com/phrase/strings-openapi/issues/1242)) ([0be2f2c](https://github.com/phrase/strings-openapi/commit/0be2f2c9f17f2488a936387e4f6824760c3b6a7c))
9
+ * **API:** add created_since filter to check issues list #STRINGS-3043 ([#1256](https://github.com/phrase/strings-openapi/issues/1256)) ([01f2da7](https://github.com/phrase/strings-openapi/commit/01f2da7da6fcae20ca8d76d1e8ab42a7f31a8918))
10
+ * **API:** add machine translation settings and locale provider mapping endpoints #STRINGS-2977 ([#1252](https://github.com/phrase/strings-openapi/issues/1252)) ([eeb265f](https://github.com/phrase/strings-openapi/commit/eeb265f432a2ae9c43fdc2f41ad09a01ef35690d))
11
+ * **API:** document tm_ids and term_base_ids params on projects API ([#1244](https://github.com/phrase/strings-openapi/issues/1244)) ([c8a2eea](https://github.com/phrase/strings-openapi/commit/c8a2eeab870236e46a8f87770c5499f0d6ffd2ca))
12
+
13
+ ## [4.26.0](https://github.com/phrase/strings-openapi/compare/ruby-v4.25.0...ruby-v4.26.0) (2026-08-03)
14
+
15
+
16
+ ### Features
17
+
18
+ * **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))
19
+ * **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))
20
+ * **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))
21
+
22
+
23
+ ### Bug Fixes
24
+
25
+ * **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))
26
+ * **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))
27
+ * **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))
28
+ * **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))
29
+ * **API:** improve post /icu/skeleton documentation ([#1187](https://github.com/phrase/strings-openapi/issues/1187)) ([1bbf2dc](https://github.com/phrase/strings-openapi/commit/1bbf2dcf6306742bc802ff12d9d6ae6962c4182e))
30
+ * **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))
31
+
3
32
  ## [4.25.0](https://github.com/phrase/strings-openapi/compare/ruby-v4.24.0...ruby-v4.25.0) (2026-06-25)
4
33
 
5
34
 
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.25.0
10
+ - Package version: 4.27.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.25.0.gem
59
+ gem install ./phrase-4.27.0.gem
60
60
  ```
61
61
 
62
- (for development, run `gem install --dev ./phrase-4.25.0.gem` to install the development dependencies)
62
+ (for development, run `gem install --dev ./phrase-4.27.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
@@ -159,6 +161,8 @@ Class | Method | HTTP request | Description
159
161
  *Phrase::BranchesApi* | [**branch_sync**](docs/BranchesApi.md#branch_sync) | **PATCH** /projects/{project_id}/branches/{name}/sync | Sync a branch
160
162
  *Phrase::BranchesApi* | [**branch_update**](docs/BranchesApi.md#branch_update) | **PATCH** /projects/{project_id}/branches/{name} | Update a branch
161
163
  *Phrase::BranchesApi* | [**branches_list**](docs/BranchesApi.md#branches_list) | **GET** /projects/{project_id}/branches | List branches
164
+ *Phrase::ChecksApi* | [**check_issue_dismiss**](docs/ChecksApi.md#check_issue_dismiss) | **PATCH** /projects/{project_id}/checks/issues/{id}/dismiss | Dismiss a check issue
165
+ *Phrase::ChecksApi* | [**check_issues_list**](docs/ChecksApi.md#check_issues_list) | **GET** /projects/{project_id}/checks/issues | List check issues
162
166
  *Phrase::CommentReactionsApi* | [**reaction_create**](docs/CommentReactionsApi.md#reaction_create) | **POST** /projects/{project_id}/keys/{key_id}/comments/{comment_id}/reactions | Create a reaction
163
167
  *Phrase::CommentReactionsApi* | [**reaction_delete**](docs/CommentReactionsApi.md#reaction_delete) | **DELETE** /projects/{project_id}/keys/{key_id}/comments/{comment_id}/reactions/{id} | Delete a reaction
164
168
  *Phrase::CommentReactionsApi* | [**reaction_show**](docs/CommentReactionsApi.md#reaction_show) | **GET** /projects/{project_id}/keys/{key_id}/comments/{comment_id}/reactions/{id} | Get a single reaction
@@ -258,6 +262,7 @@ Class | Method | HTTP request | Description
258
262
  *Phrase::JobsApi* | [**job_update**](docs/JobsApi.md#job_update) | **PATCH** /projects/{project_id}/jobs/{id} | Update a job
259
263
  *Phrase::JobsApi* | [**jobs_by_account**](docs/JobsApi.md#jobs_by_account) | **GET** /accounts/{account_id}/jobs | List account jobs
260
264
  *Phrase::JobsApi* | [**jobs_list**](docs/JobsApi.md#jobs_list) | **GET** /projects/{project_id}/jobs | List jobs
265
+ *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
266
  *Phrase::KeysApi* | [**key_create**](docs/KeysApi.md#key_create) | **POST** /projects/{project_id}/keys | Create a key
262
267
  *Phrase::KeysApi* | [**key_delete**](docs/KeysApi.md#key_delete) | **DELETE** /projects/{project_id}/keys/{id} | Delete a key
263
268
  *Phrase::KeysApi* | [**key_show**](docs/KeysApi.md#key_show) | **GET** /projects/{project_id}/keys/{id} | Get a single key
@@ -284,6 +289,10 @@ Class | Method | HTTP request | Description
284
289
  *Phrase::LocalesApi* | [**locale_show**](docs/LocalesApi.md#locale_show) | **GET** /projects/{project_id}/locales/{id} | Get a single locale
285
290
  *Phrase::LocalesApi* | [**locale_update**](docs/LocalesApi.md#locale_update) | **PATCH** /projects/{project_id}/locales/{id} | Update a locale
286
291
  *Phrase::LocalesApi* | [**locales_list**](docs/LocalesApi.md#locales_list) | **GET** /projects/{project_id}/locales | List locales
292
+ *Phrase::MachineTranslationApi* | [**machine_translation_locale_provider_mappings_create**](docs/MachineTranslationApi.md#machine_translation_locale_provider_mappings_create) | **POST** /accounts/{account_id}/machine_translation_locale_provider_mappings | Create a locale provider mapping
293
+ *Phrase::MachineTranslationApi* | [**machine_translation_locale_provider_mappings_destroy**](docs/MachineTranslationApi.md#machine_translation_locale_provider_mappings_destroy) | **DELETE** /accounts/{account_id}/machine_translation_locale_provider_mappings | Delete a locale provider mapping
294
+ *Phrase::MachineTranslationApi* | [**machine_translation_settings_show**](docs/MachineTranslationApi.md#machine_translation_settings_show) | **GET** /accounts/{account_id}/machine_translation_settings | Get machine translation settings
295
+ *Phrase::MachineTranslationApi* | [**machine_translation_settings_update**](docs/MachineTranslationApi.md#machine_translation_settings_update) | **PATCH** /accounts/{account_id}/machine_translation_settings | Update machine translation settings
287
296
  *Phrase::MembersApi* | [**member_delete**](docs/MembersApi.md#member_delete) | **DELETE** /accounts/{account_id}/members/{id} | Remove a user from the account
288
297
  *Phrase::MembersApi* | [**member_show**](docs/MembersApi.md#member_show) | **GET** /accounts/{account_id}/members/{id} | Get single member
289
298
  *Phrase::MembersApi* | [**member_update**](docs/MembersApi.md#member_update) | **PATCH** /accounts/{account_id}/members/{id} | Update a member
@@ -310,6 +319,9 @@ Class | Method | HTTP request | Description
310
319
  *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
320
  *Phrase::OrganizationJobTemplatesApi* | [**organization_job_templates_list**](docs/OrganizationJobTemplatesApi.md#organization_job_templates_list) | **GET** /accounts/{account_id}/job_templates | List organization job templates
312
321
  *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
322
+ *Phrase::PreTranslationsApi* | [**pre_translation_create**](docs/PreTranslationsApi.md#pre_translation_create) | **POST** /projects/{project_id}/pre_translations | Create a pre-translation job
323
+ *Phrase::PreTranslationsApi* | [**pre_translation_show**](docs/PreTranslationsApi.md#pre_translation_show) | **GET** /projects/{project_id}/pre_translations/{id} | Get a single pre-translation job
324
+ *Phrase::PreTranslationsApi* | [**pre_translations_list**](docs/PreTranslationsApi.md#pre_translations_list) | **GET** /projects/{project_id}/pre_translations | List pre-translation jobs
313
325
  *Phrase::ProjectsApi* | [**project_create**](docs/ProjectsApi.md#project_create) | **POST** /projects | Create a project
314
326
  *Phrase::ProjectsApi* | [**project_delete**](docs/ProjectsApi.md#project_delete) | **DELETE** /projects/{id} | Delete a project
315
327
  *Phrase::ProjectsApi* | [**project_show**](docs/ProjectsApi.md#project_show) | **GET** /projects/{id} | Get a single project
@@ -431,6 +443,8 @@ Class | Method | HTTP request | Description
431
443
  - [Phrase::AuthorizationUpdateParameters](docs/AuthorizationUpdateParameters.md)
432
444
  - [Phrase::AuthorizationWithToken](docs/AuthorizationWithToken.md)
433
445
  - [Phrase::Automation](docs/Automation.md)
446
+ - [Phrase::AutomationEvent](docs/AutomationEvent.md)
447
+ - [Phrase::AutomationEventProject](docs/AutomationEventProject.md)
434
448
  - [Phrase::AutomationsCreateParameters](docs/AutomationsCreateParameters.md)
435
449
  - [Phrase::AutomationsCreateParameters1](docs/AutomationsCreateParameters1.md)
436
450
  - [Phrase::BlacklistedKey](docs/BlacklistedKey.md)
@@ -447,6 +461,7 @@ Class | Method | HTTP request | Description
447
461
  - [Phrase::BranchName](docs/BranchName.md)
448
462
  - [Phrase::BranchSyncParameters](docs/BranchSyncParameters.md)
449
463
  - [Phrase::BranchUpdateParameters](docs/BranchUpdateParameters.md)
464
+ - [Phrase::CheckIssue](docs/CheckIssue.md)
450
465
  - [Phrase::Comment](docs/Comment.md)
451
466
  - [Phrase::CommentCreateParameters](docs/CommentCreateParameters.md)
452
467
  - [Phrase::CommentCreateParameters1](docs/CommentCreateParameters1.md)
@@ -482,6 +497,7 @@ Class | Method | HTTP request | Description
482
497
  - [Phrase::GlossaryTermUpdateParameters](docs/GlossaryTermUpdateParameters.md)
483
498
  - [Phrase::GlossaryUpdateParameters](docs/GlossaryUpdateParameters.md)
484
499
  - [Phrase::Icu](docs/Icu.md)
500
+ - [Phrase::IcuSkeletonError](docs/IcuSkeletonError.md)
485
501
  - [Phrase::IcuSkeletonParameters](docs/IcuSkeletonParameters.md)
486
502
  - [Phrase::Invitation](docs/Invitation.md)
487
503
  - [Phrase::InvitationCreateParameters](docs/InvitationCreateParameters.md)
@@ -518,10 +534,10 @@ Class | Method | HTTP request | Description
518
534
  - [Phrase::JobTemplateUpdateParameters](docs/JobTemplateUpdateParameters.md)
519
535
  - [Phrase::JobUpdateParameters](docs/JobUpdateParameters.md)
520
536
  - [Phrase::KeyCreateParameters](docs/KeyCreateParameters.md)
537
+ - [Phrase::KeyFormatAnnotationsList200ResponseInner](docs/KeyFormatAnnotationsList200ResponseInner.md)
521
538
  - [Phrase::KeyLink](docs/KeyLink.md)
522
539
  - [Phrase::KeyLinksBatchDestroyParameters](docs/KeyLinksBatchDestroyParameters.md)
523
540
  - [Phrase::KeyLinksCreateParameters](docs/KeyLinksCreateParameters.md)
524
- - [Phrase::KeyLinksIndex400Response](docs/KeyLinksIndex400Response.md)
525
541
  - [Phrase::KeyPreview](docs/KeyPreview.md)
526
542
  - [Phrase::KeyUpdateParameters](docs/KeyUpdateParameters.md)
527
543
  - [Phrase::KeysExcludeParameters](docs/KeysExcludeParameters.md)
@@ -543,6 +559,10 @@ Class | Method | HTTP request | Description
543
559
  - [Phrase::LocaleTeamPreview](docs/LocaleTeamPreview.md)
544
560
  - [Phrase::LocaleUpdateParameters](docs/LocaleUpdateParameters.md)
545
561
  - [Phrase::LocaleUserPreview](docs/LocaleUserPreview.md)
562
+ - [Phrase::MachineTranslationLocaleProviderMapping](docs/MachineTranslationLocaleProviderMapping.md)
563
+ - [Phrase::MachineTranslationLocaleProviderMappingsCreateParameters](docs/MachineTranslationLocaleProviderMappingsCreateParameters.md)
564
+ - [Phrase::MachineTranslationSettings](docs/MachineTranslationSettings.md)
565
+ - [Phrase::MachineTranslationSettingsUpdateParameters](docs/MachineTranslationSettingsUpdateParameters.md)
546
566
  - [Phrase::Member](docs/Member.md)
547
567
  - [Phrase::MemberProjectDetail](docs/MemberProjectDetail.md)
548
568
  - [Phrase::MemberProjectDetailProjectRolesInner](docs/MemberProjectDetailProjectRolesInner.md)
@@ -560,6 +580,8 @@ Class | Method | HTTP request | Description
560
580
  - [Phrase::OrganizationJobTemplateLocaleUpdateParameters](docs/OrganizationJobTemplateLocaleUpdateParameters.md)
561
581
  - [Phrase::OrganizationJobTemplateLocalesCreateParameters](docs/OrganizationJobTemplateLocalesCreateParameters.md)
562
582
  - [Phrase::OrganizationJobTemplateUpdateParameters](docs/OrganizationJobTemplateUpdateParameters.md)
583
+ - [Phrase::PreTranslation](docs/PreTranslation.md)
584
+ - [Phrase::PreTranslationCreateParameters](docs/PreTranslationCreateParameters.md)
563
585
  - [Phrase::Project](docs/Project.md)
564
586
  - [Phrase::ProjectCreateParameters](docs/ProjectCreateParameters.md)
565
587
  - [Phrase::ProjectDetails](docs/ProjectDetails.md)
@@ -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
+
@@ -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
+
@@ -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
+
@@ -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]
@@ -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]
@@ -0,0 +1,33 @@
1
+ # Phrase::CheckIssue
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **id** | **String** | | [optional]
8
+ **check_name** | **String** | Identifier of the check that reported this issue. One of: &#x60;translation_content_length&#x60;, &#x60;translation_placeholder_usage&#x60;, &#x60;translation_glossary_usage&#x60;. | [optional]
9
+ **state** | **String** | Current state of the check issue. One of: &#x60;active&#x60;, &#x60;solved&#x60;, &#x60;dismissed&#x60;. | [optional]
10
+ **description** | **String** | Human-readable description of the reported issue, always in English. This message is intended for display only. Its wording may change at any time and it should not be parsed or relied upon programmatically. | [optional]
11
+ **dismissed_at** | **Time** | | [optional]
12
+ **solved_at** | **Time** | | [optional]
13
+ **created_at** | **Time** | | [optional]
14
+ **updated_at** | **Time** | | [optional]
15
+ **translation** | [**Translation**](Translation.md) | | [optional]
16
+
17
+ ## Code Sample
18
+
19
+ ```ruby
20
+ require 'Phrase'
21
+
22
+ instance = Phrase::CheckIssue.new(id: null,
23
+ check_name: null,
24
+ state: null,
25
+ description: null,
26
+ dismissed_at: null,
27
+ solved_at: null,
28
+ created_at: null,
29
+ updated_at: null,
30
+ translation: null)
31
+ ```
32
+
33
+
data/docs/ChecksApi.md ADDED
@@ -0,0 +1,146 @@
1
+ # Phrase::ChecksApi
2
+
3
+ All URIs are relative to *https://api.phrase.com/v2*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**check_issue_dismiss**](ChecksApi.md#check_issue_dismiss) | **PATCH** /projects/{project_id}/checks/issues/{id}/dismiss | Dismiss a check issue
8
+ [**check_issues_list**](ChecksApi.md#check_issues_list) | **GET** /projects/{project_id}/checks/issues | List check issues
9
+
10
+
11
+
12
+ ## check_issue_dismiss
13
+
14
+ > CheckIssue check_issue_dismiss(project_id, id, opts)
15
+
16
+ Dismiss a check issue
17
+
18
+ **Note:** The Checks API is still in development and might change in subsequent releases. Mark a check issue as dismissed so it no longer appears on the list of active check issues.
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::ChecksApi.new
37
+ project_id = 'project_id_example' # String | Project ID
38
+ id = 'id_example' # String | Check Issue ID
39
+ opts = {
40
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
41
+ }
42
+
43
+ begin
44
+ #Dismiss a check issue
45
+ result = api_instance.check_issue_dismiss(project_id, id, opts)
46
+ pp result
47
+ rescue Phrase::ApiError => e
48
+ puts "Exception when calling ChecksApi->check_issue_dismiss: #{e}"
49
+ end
50
+ ```
51
+
52
+ ### Parameters
53
+
54
+
55
+ Name | Type | Description | Notes
56
+ ------------- | ------------- | ------------- | -------------
57
+ **project_id** | **String**| Project ID |
58
+ **id** | **String**| Check Issue ID |
59
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
60
+
61
+ ### Return type
62
+
63
+ Response<([**CheckIssue**](CheckIssue.md))>
64
+
65
+ ### Authorization
66
+
67
+ [Basic](../README.md#Basic), [Token](../README.md#Token)
68
+
69
+ ### HTTP request headers
70
+
71
+ - **Content-Type**: Not defined
72
+ - **Accept**: application/json
73
+
74
+
75
+ ## check_issues_list
76
+
77
+ > Array&lt;CheckIssue&gt; check_issues_list(project_id, opts)
78
+
79
+ List check issues
80
+
81
+ **Note:** The Checks API is still in development and might change in subsequent releases. List check issues for the given project. Results can be filtered by locale, check name, and state.
82
+
83
+ ### Example
84
+
85
+ ```ruby
86
+ # load the gem
87
+ require 'phrase'
88
+ # setup authorization
89
+ Phrase.configure do |config|
90
+ # Configure HTTP basic authorization: Basic
91
+ config.username = 'YOUR USERNAME'
92
+ config.password = 'YOUR PASSWORD'
93
+
94
+ # Configure API key authorization: Token
95
+ config.api_key['Authorization'] = 'YOUR API KEY'
96
+ config.api_key_prefix['Authorization'] = 'token'
97
+ end
98
+
99
+ api_instance = Phrase::ChecksApi.new
100
+ project_id = 'project_id_example' # String | Project ID
101
+ opts = {
102
+ x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
103
+ page: 1, # Integer | Page number
104
+ per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
105
+ state: 'active', # String | Filter by state of the check issue. Can be one of: `active`, `solved`, `dismissed`, `all`. Defaults to `active`.
106
+ locale_ids: ['inner_example'], # Array<String> | Filter by one or more locale IDs.
107
+ check_names: ['translation_content_length'], # Array<String> | Filter by one or more check names. Valid values are: - `translation_content_length` — the translation exceeds the maximum character limit configured for the key. - `translation_placeholder_usage` — the translation is missing placeholders present in the source, or contains unexpected ones. - `translation_glossary_usage` — the translation does not follow the glossary term translations.
108
+ created_since: '2026-01-01T12:00:00Z' # String | Return only check issues created on or after this ISO 8601 datetime. Returns 400 if the value is not a valid date-time.
109
+ }
110
+
111
+ begin
112
+ #List check issues
113
+ result = api_instance.check_issues_list(project_id, opts)
114
+ pp result
115
+ rescue Phrase::ApiError => e
116
+ puts "Exception when calling ChecksApi->check_issues_list: #{e}"
117
+ end
118
+ ```
119
+
120
+ ### Parameters
121
+
122
+
123
+ Name | Type | Description | Notes
124
+ ------------- | ------------- | ------------- | -------------
125
+ **project_id** | **String**| Project ID |
126
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
127
+ **page** | **Integer**| Page number | [optional]
128
+ **per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
129
+ **state** | **String**| Filter by state of the check issue. Can be one of: &#x60;active&#x60;, &#x60;solved&#x60;, &#x60;dismissed&#x60;, &#x60;all&#x60;. Defaults to &#x60;active&#x60;. | [optional] [default to &#39;active&#39;]
130
+ **locale_ids** | [**Array&lt;String&gt;**](String.md)| Filter by one or more locale IDs. | [optional]
131
+ **check_names** | [**Array&lt;String&gt;**](String.md)| Filter by one or more check names. Valid values are: - &#x60;translation_content_length&#x60; — the translation exceeds the maximum character limit configured for the key. - &#x60;translation_placeholder_usage&#x60; — the translation is missing placeholders present in the source, or contains unexpected ones. - &#x60;translation_glossary_usage&#x60; — the translation does not follow the glossary term translations. | [optional]
132
+ **created_since** | **String**| Return only check issues created on or after this ISO 8601 datetime. Returns 400 if the value is not a valid date-time. | [optional]
133
+
134
+ ### Return type
135
+
136
+ Response<([**Array&lt;CheckIssue&gt;**](CheckIssue.md))>
137
+
138
+ ### Authorization
139
+
140
+ [Basic](../README.md#Basic), [Token](../README.md#Token)
141
+
142
+ ### HTTP request headers
143
+
144
+ - **Content-Type**: Not defined
145
+ - **Accept**: application/json
146
+
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