phrase 4.24.0 → 4.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d213192723604fbb4ef7a90d6a9f29acc732851fef5f2aca3fd4ca40b12c15d
-  data.tar.gz: 187feac87a11747ede044a04da9d66304dc683e66d6055c83091a570a2342e77
+  metadata.gz: 950c760b4ff662d461dc3b5ee1c2490949e2754537a02c512108ee2802eb6e37
+  data.tar.gz: 151f613ba922d317f0f492c9a3993cfe98718a68eaa64fe1f43709e9d98c2af0
 SHA512:
-  metadata.gz: 1c2184c4658be521ee20da21c7e10545aa9be346d993e2f35424188686e2584ade0e47d950f84f7c5116ea3098b177c829c8598281851ca9e03b78a716c6777d
-  data.tar.gz: 633b174f29f95e59035fdc6a7beb8fbc789cc9b79ddd314c4dcbd640e2a2a198d950281d0e05265812126f3871f35a6e4d6572150727211fa718c51c2718b123
+  metadata.gz: 921fc81ad5bf358718d0fe2bd1367c55511636c6291ce39b1298516ebe3f17efaa7ad0bd4361bba43cfc03fdea31147bab33bb88011f8e7517b9d433cc768a3d
+  data.tar.gz: c4cd0d523a362016d9aec722f94946d75969acf5f112d3a139aa843230d8672c189f193ca618eca790e9721099830ab0430cdeeaf6ba0a138092ce0e68324ab9

data/CHANGELOG.md

@@ -1,5 +1,40 @@
 # Changelog
 
+## [4.26.0](https://github.com/phrase/strings-openapi/compare/ruby-v4.25.0...ruby-v4.26.0) (2026-08-03)
+
+
+### Features
+
+* **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))
+* **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))
+* **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))
+
+
+### Bug Fixes
+
+* **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))
+* **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))
+* **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))
+* **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))
+* **API:** improve post /icu/skeleton documentation ([#1187](https://github.com/phrase/strings-openapi/issues/1187)) ([1bbf2dc](https://github.com/phrase/strings-openapi/commit/1bbf2dcf6306742bc802ff12d9d6ae6962c4182e))
+* **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))
+
+## [4.25.0](https://github.com/phrase/strings-openapi/compare/ruby-v4.24.0...ruby-v4.25.0) (2026-06-25)
+
+
+### Features
+
+* **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))
+* **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))
+* **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))
+* **API:** document branch compare output ([#1151](https://github.com/phrase/strings-openapi/issues/1151)) ([f082775](https://github.com/phrase/strings-openapi/commit/f0827755e1c6d6c3f66f10db5e6c26dc5003a679))
+* **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))
+
+
+### Bug Fixes
+
+* **API:** improve get /formats documentation ([#1196](https://github.com/phrase/strings-openapi/issues/1196)) ([46fd53b](https://github.com/phrase/strings-openapi/commit/46fd53bda361a5b928147ab965515c29dbf887d3))
+
 ## [4.24.0](https://github.com/phrase/strings-openapi/compare/ruby-v4.23.0...ruby-v4.24.0) (2026-06-11)
 
 

data/README.md

@@ -7,7 +7,7 @@ Phrase Strings is a translation management platform for software projects. You c
 ## This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 4.24.0
+- Package version: 4.26.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [https://developers.phrase.com/api/](https://developers.phrase.com/api/)
 
@@ -56,10 +56,10 @@ gem build phrase.gemspec
 Then install the gem locally:
 
 ```shell
-gem install ./phrase-4.24.0.gem
+gem install ./phrase-4.26.0.gem
 ```
 
-(for development, run `gem install --dev ./phrase-4.24.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./phrase-4.26.0.gem` to install the development dependencies)
 
 ## Getting Started
 
@@ -137,6 +137,8 @@ Class | Method | HTTP request | Description
 *Phrase::AuthorizationsApi* | [**authorization_show**](docs/AuthorizationsApi.md#authorization_show) | **GET** /authorizations/{id} | Get a single authorization
 *Phrase::AuthorizationsApi* | [**authorization_update**](docs/AuthorizationsApi.md#authorization_update) | **PATCH** /authorizations/{id} | Update an authorization
 *Phrase::AuthorizationsApi* | [**authorizations_list**](docs/AuthorizationsApi.md#authorizations_list) | **GET** /authorizations | List authorizations
+*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
+*Phrase::AutomationEventsApi* | [**automation_events_list**](docs/AutomationEventsApi.md#automation_events_list) | **GET** /accounts/{account_id}/automations/{automation_id}/events | List events for an automation
 *Phrase::AutomationsApi* | [**automation_activate**](docs/AutomationsApi.md#automation_activate) | **POST** /accounts/{account_id}/automations/{automation_id}/activate | Activate an automation
 *Phrase::AutomationsApi* | [**automation_create**](docs/AutomationsApi.md#automation_create) | **POST** /accounts/{account_id}/automations | Create an automation
 *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
 *Phrase::JobsApi* | [**job_update**](docs/JobsApi.md#job_update) | **PATCH** /projects/{project_id}/jobs/{id} | Update a job
 *Phrase::JobsApi* | [**jobs_by_account**](docs/JobsApi.md#jobs_by_account) | **GET** /accounts/{account_id}/jobs | List account jobs
 *Phrase::JobsApi* | [**jobs_list**](docs/JobsApi.md#jobs_list) | **GET** /projects/{project_id}/jobs | List jobs
+*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
 *Phrase::KeysApi* | [**key_create**](docs/KeysApi.md#key_create) | **POST** /projects/{project_id}/keys | Create a key
 *Phrase::KeysApi* | [**key_delete**](docs/KeysApi.md#key_delete) | **DELETE** /projects/{project_id}/keys/{id} | Delete a key
 *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
 *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
 *Phrase::OrganizationJobTemplatesApi* | [**organization_job_templates_list**](docs/OrganizationJobTemplatesApi.md#organization_job_templates_list) | **GET** /accounts/{account_id}/job_templates | List organization job templates
 *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
+*Phrase::PreTranslationsApi* | [**pre_translation_create**](docs/PreTranslationsApi.md#pre_translation_create) | **POST** /projects/{project_id}/pre_translations | Create a pre-translation job
+*Phrase::PreTranslationsApi* | [**pre_translation_show**](docs/PreTranslationsApi.md#pre_translation_show) | **GET** /projects/{project_id}/pre_translations/{id} | Get a single pre-translation job
+*Phrase::PreTranslationsApi* | [**pre_translations_list**](docs/PreTranslationsApi.md#pre_translations_list) | **GET** /projects/{project_id}/pre_translations | List pre-translation jobs
 *Phrase::ProjectsApi* | [**project_create**](docs/ProjectsApi.md#project_create) | **POST** /projects | Create a project
 *Phrase::ProjectsApi* | [**project_delete**](docs/ProjectsApi.md#project_delete) | **DELETE** /projects/{id} | Delete a project
 *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
  - [Phrase::AuthorizationUpdateParameters](docs/AuthorizationUpdateParameters.md)
  - [Phrase::AuthorizationWithToken](docs/AuthorizationWithToken.md)
  - [Phrase::Automation](docs/Automation.md)
+ - [Phrase::AutomationEvent](docs/AutomationEvent.md)
+ - [Phrase::AutomationEventProject](docs/AutomationEventProject.md)
  - [Phrase::AutomationsCreateParameters](docs/AutomationsCreateParameters.md)
  - [Phrase::AutomationsCreateParameters1](docs/AutomationsCreateParameters1.md)
  - [Phrase::BlacklistedKey](docs/BlacklistedKey.md)
  - [Phrase::BlacklistedKeyCreateParameters](docs/BlacklistedKeyCreateParameters.md)
  - [Phrase::BlacklistedKeyUpdateParameters](docs/BlacklistedKeyUpdateParameters.md)
  - [Phrase::Branch](docs/Branch.md)
+ - [Phrase::BranchComparison](docs/BranchComparison.md)
+ - [Phrase::BranchComparisonChange](docs/BranchComparisonChange.md)
+ - [Phrase::BranchComparisonDiff](docs/BranchComparisonDiff.md)
+ - [Phrase::BranchComparisonDiffConflictsValue](docs/BranchComparisonDiffConflictsValue.md)
  - [Phrase::BranchCreateComparisonParameters](docs/BranchCreateComparisonParameters.md)
  - [Phrase::BranchCreateParameters](docs/BranchCreateParameters.md)
  - [Phrase::BranchMergeParameters](docs/BranchMergeParameters.md)
@@ -478,6 +490,7 @@ Class | Method | HTTP request | Description
  - [Phrase::GlossaryTermUpdateParameters](docs/GlossaryTermUpdateParameters.md)
  - [Phrase::GlossaryUpdateParameters](docs/GlossaryUpdateParameters.md)
  - [Phrase::Icu](docs/Icu.md)
+ - [Phrase::IcuSkeletonError](docs/IcuSkeletonError.md)
  - [Phrase::IcuSkeletonParameters](docs/IcuSkeletonParameters.md)
  - [Phrase::Invitation](docs/Invitation.md)
  - [Phrase::InvitationCreateParameters](docs/InvitationCreateParameters.md)
@@ -514,10 +527,10 @@ Class | Method | HTTP request | Description
  - [Phrase::JobTemplateUpdateParameters](docs/JobTemplateUpdateParameters.md)
  - [Phrase::JobUpdateParameters](docs/JobUpdateParameters.md)
  - [Phrase::KeyCreateParameters](docs/KeyCreateParameters.md)
+ - [Phrase::KeyFormatAnnotationsList200ResponseInner](docs/KeyFormatAnnotationsList200ResponseInner.md)
  - [Phrase::KeyLink](docs/KeyLink.md)
  - [Phrase::KeyLinksBatchDestroyParameters](docs/KeyLinksBatchDestroyParameters.md)
  - [Phrase::KeyLinksCreateParameters](docs/KeyLinksCreateParameters.md)
- - [Phrase::KeyLinksIndex400Response](docs/KeyLinksIndex400Response.md)
  - [Phrase::KeyPreview](docs/KeyPreview.md)
  - [Phrase::KeyUpdateParameters](docs/KeyUpdateParameters.md)
  - [Phrase::KeysExcludeParameters](docs/KeysExcludeParameters.md)
@@ -556,6 +569,8 @@ Class | Method | HTTP request | Description
  - [Phrase::OrganizationJobTemplateLocaleUpdateParameters](docs/OrganizationJobTemplateLocaleUpdateParameters.md)
  - [Phrase::OrganizationJobTemplateLocalesCreateParameters](docs/OrganizationJobTemplateLocalesCreateParameters.md)
  - [Phrase::OrganizationJobTemplateUpdateParameters](docs/OrganizationJobTemplateUpdateParameters.md)
+ - [Phrase::PreTranslation](docs/PreTranslation.md)
+ - [Phrase::PreTranslationCreateParameters](docs/PreTranslationCreateParameters.md)
  - [Phrase::Project](docs/Project.md)
  - [Phrase::ProjectCreateParameters](docs/ProjectCreateParameters.md)
  - [Phrase::ProjectDetails](docs/ProjectDetails.md)

data/docs/AutomationEvent.md

@@ -0,0 +1,33 @@
+# Phrase::AutomationEvent
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier of the automation event. | [optional] 
+**automation_id** | **String** | Identifier of the automation that produced this event. | [optional] 
+**state** | **String** | Outcome of the automation run. | [optional] 
+**triggered_by** | **String** | What caused the automation to run. | [optional] 
+**created_at** | **Time** | Timestamp when the event was created. | [optional] 
+**jobs_created** | **Integer** | Number of jobs created during this automation run. | [optional] 
+**job_ids** | **Array<String>** | Identifiers of the jobs created during this automation run. | [optional] 
+**project** | [**AutomationEventProject**](AutomationEventProject.md) |  | [optional] 
+**details** | **String** | Error message describing the failure when state is `failure`; null otherwise. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::AutomationEvent.new(id: null,
+                                 automation_id: null,
+                                 state: null,
+                                 triggered_by: null,
+                                 created_at: null,
+                                 jobs_created: null,
+                                 job_ids: null,
+                                 project: null,
+                                 details: null)
+```
+
+

data/docs/AutomationEventProject.md

@@ -0,0 +1,19 @@
+# Phrase::AutomationEventProject
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Project identifier. | [optional] 
+**name** | **String** | Project name. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::AutomationEventProject.new(id: null,
+                                 name: null)
+```
+
+

data/docs/AutomationEventsApi.md

@@ -0,0 +1,168 @@
+# Phrase::AutomationEventsApi
+
+All URIs are relative to *https://api.phrase.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**account_automation_events_list**](AutomationEventsApi.md#account_automation_events_list) | **GET** /accounts/{account_id}/automation_events | List automation events for an account
+[**automation_events_list**](AutomationEventsApi.md#automation_events_list) | **GET** /accounts/{account_id}/automations/{automation_id}/events | List events for an automation
+
+
+
+## account_automation_events_list
+
+> Array<AutomationEvent> account_automation_events_list(account_id, opts)
+
+List automation events for an account
+
+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). 
+
+### Example
+
+```ruby
+# load the gem
+require 'phrase'
+# setup authorization
+Phrase.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  config.api_key_prefix['Authorization'] = 'token'
+end
+
+api_instance = Phrase::AutomationEventsApi.new
+account_id = 'account_id_example' # String | Account ID
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
+  page: 1, # Integer | Page number
+  per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
+  automation_id: 'automation_id_example', # String | Filter events to a single automation by its ID.
+  state: 'success', # String | Filter events by outcome state. Unrecognized values are ignored.
+  triggered_by: 'manual', # String | Filter events by what triggered the automation run. Unrecognized values are ignored.
+  project_id: 'project_id_example', # String | Filter events by project ID. Accepts a single ID or a comma-separated list of IDs.
+  project_ids: ['inner_example'], # Array<String> | Filter events by one or more project IDs.
+  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.
+  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.
+}
+
+begin
+  #List automation events for an account
+  result = api_instance.account_automation_events_list(account_id, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling AutomationEventsApi->account_automation_events_list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **String**| Account ID | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+ **page** | **Integer**| Page number | [optional] 
+ **per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional] 
+ **automation_id** | **String**| Filter events to a single automation by its ID. | [optional] 
+ **state** | **String**| Filter events by outcome state. Unrecognized values are ignored. | [optional] 
+ **triggered_by** | **String**| Filter events by what triggered the automation run. Unrecognized values are ignored. | [optional] 
+ **project_id** | **String**| Filter events by project ID. Accepts a single ID or a comma-separated list of IDs. | [optional] 
+ **project_ids** | [**Array&lt;String&gt;**](String.md)| Filter events by one or more project IDs. | [optional] 
+ **created_after** | **String**| Return only events created after this ISO 8601 timestamp. Returns 400 if the value is not a valid date-time. | [optional] 
+ **created_before** | **String**| Return only events created before this ISO 8601 timestamp. Returns 400 if the value is not a valid date-time. | [optional] 
+
+### Return type
+
+Response<([**Array&lt;AutomationEvent&gt;**](AutomationEvent.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## automation_events_list
+
+> Array&lt;AutomationEvent&gt; automation_events_list(account_id, id, opts)
+
+List events for an automation
+
+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). 
+
+### Example
+
+```ruby
+# load the gem
+require 'phrase'
+# setup authorization
+Phrase.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  config.api_key_prefix['Authorization'] = 'token'
+end
+
+api_instance = Phrase::AutomationEventsApi.new
+account_id = 'account_id_example' # String | Account ID
+id = 'id_example' # String | ID
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
+  page: 1, # Integer | Page number
+  per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
+  state: 'success', # String | Filter events by outcome state. Unrecognized values are ignored.
+  triggered_by: 'manual', # String | Filter events by what triggered the automation run. Unrecognized values are ignored.
+  project_id: 'project_id_example', # String | Filter events by project ID. Accepts a single ID or a comma-separated list of IDs.
+  project_ids: ['inner_example'], # Array<String> | Filter events by one or more project IDs.
+  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.
+  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.
+}
+
+begin
+  #List events for an automation
+  result = api_instance.automation_events_list(account_id, id, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling AutomationEventsApi->automation_events_list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **String**| Account ID | 
+ **id** | **String**| ID | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+ **page** | **Integer**| Page number | [optional] 
+ **per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional] 
+ **state** | **String**| Filter events by outcome state. Unrecognized values are ignored. | [optional] 
+ **triggered_by** | **String**| Filter events by what triggered the automation run. Unrecognized values are ignored. | [optional] 
+ **project_id** | **String**| Filter events by project ID. Accepts a single ID or a comma-separated list of IDs. | [optional] 
+ **project_ids** | [**Array&lt;String&gt;**](String.md)| Filter events by one or more project IDs. | [optional] 
+ **created_after** | **String**| Return only events created after this ISO 8601 timestamp. Returns 400 if the value is not a valid date-time. | [optional] 
+ **created_before** | **String**| Return only events created before this ISO 8601 timestamp. Returns 400 if the value is not a valid date-time. | [optional] 
+
+### Return type
+
+Response<([**Array&lt;AutomationEvent&gt;**](AutomationEvent.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/AutomationsCreateParameters.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | name of the automation | 
 **trigger** | **String** |  | 
-**project_ids** | **Array<String>** | 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.  | 
+**project_ids** | **Array<String>** | List of project IDs to associate with the automation. Providing more than one project ID requires the `advanced_job_automation` plan feature; accounts without this feature receive a 422 response with error field `project_ids`.  | 
 **job_template_id** | **String** | id of job template that the automation uses to create jobs from | [optional] 
 **status_filters** | **Array<String>** | Translation states used when selecting keys for a job.  States are derived from associated translations, not the keys themselves.  When review workflow is enabled, `ready_for_review` is internally treated as `translated`.  | 
 **tags** | **Array<String>** | used to filter which keys are added to jobs | [optional] 

data/docs/AutomationsCreateParameters1.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | name of the automation | 
 **trigger** | **String** |  | 
-**project_ids** | **Array<String>** | 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.  | 
+**project_ids** | **Array<String>** | List of project IDs to associate with the automation. Providing more than one project ID requires the `advanced_job_automation` plan feature; accounts without this feature receive a 422 response with error field `project_ids`.  | 
 **job_template_id** | **String** | id of job template that the automation uses to create jobs from | [optional] 
 **status_filters** | **Array<String>** | translation key statuses used to filter keys that are added to jobs | 
 **tags** | **Array<String>** | used to filter which keys are added to jobs | [optional] 

data/docs/BranchComparison.md

@@ -0,0 +1,23 @@
+# Phrase::BranchComparison
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**translation_keys** | [**BranchComparisonDiff**](BranchComparisonDiff.md) |  | [optional] 
+**translations** | [**BranchComparisonDiff**](BranchComparisonDiff.md) |  | [optional] 
+**locales** | [**BranchComparisonDiff**](BranchComparisonDiff.md) |  | [optional] 
+**tags** | [**BranchComparisonDiff**](BranchComparisonDiff.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::BranchComparison.new(translation_keys: null,
+                                 translations: null,
+                                 locales: null,
+                                 tags: null)
+```
+
+

data/docs/BranchComparisonChange.md

@@ -0,0 +1,19 @@
+# Phrase::BranchComparisonChange
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**from** | **Hash<String, Object>** |  | [optional] 
+**to** | **Hash<String, Object>** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::BranchComparisonChange.new(from: null,
+                                 to: null)
+```
+
+

data/docs/BranchComparisonDiff.md

@@ -0,0 +1,21 @@
+# Phrase::BranchComparisonDiff
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**base_changes** | [**Array<BranchComparisonChange>**](BranchComparisonChange.md) | Changes made to this resource type in the base branch since the branch was created. | [optional] 
+**head_changes** | [**Array<BranchComparisonChange>**](BranchComparisonChange.md) | Changes made to this resource type in the feature branch. | [optional] 
+**conflicts** | [**Hash<String, BranchComparisonDiffConflictsValue>**](BranchComparisonDiffConflictsValue.md) | Conflicting changes present in both branches, keyed by conflict type. Possible conflict type keys: `changed_in_head_changed_in_base`, `added_in_head_added_in_base`, `changed_in_head_deleted_in_base`, `deleted_in_head_changed_in_base`. Each value contains `base` and `head` arrays of changed attribute objects.  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::BranchComparisonDiff.new(base_changes: null,
+                                 head_changes: null,
+                                 conflicts: null)
+```
+
+

data/docs/BranchComparisonDiffConflictsValue.md

@@ -0,0 +1,19 @@
+# Phrase::BranchComparisonDiffConflictsValue
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**base** | **Array<Hash<String, Object>>** |  | [optional] 
+**head** | **Array<Hash<String, Object>>** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::BranchComparisonDiffConflictsValue.new(base: null,
+                                 head: null)
+```
+
+

data/docs/BranchesApi.md

@@ -18,7 +18,7 @@ Method | HTTP request | Description
 
 ## branch_compare
 
-> branch_compare(project_id, name, opts)
+> BranchComparison branch_compare(project_id, name, opts)
 
 Compare branches
 
@@ -49,7 +49,8 @@ opts = {
 
 begin
   #Compare branches
-  api_instance.branch_compare(project_id, name, opts)
+  result = api_instance.branch_compare(project_id, name, opts)
+  pp result
 rescue Phrase::ApiError => e
   puts "Exception when calling BranchesApi->branch_compare: #{e}"
 end
@@ -66,7 +67,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-Response<(nil (empty response body))>
+Response<([**BranchComparison**](BranchComparison.md))>
 
 ### Authorization
 
@@ -75,7 +76,7 @@ Response<(nil (empty response body))>
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: Not defined
+- **Accept**: application/json
 
 
 ## branch_comparison_create

data/docs/DocumentsApi.md

@@ -15,7 +15,7 @@ Method | HTTP request | Description
 
 Delete document
 
-Delete an existing document.
+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. 
 
 ### Example
 
@@ -77,7 +77,7 @@ Response<(nil (empty response body))>
 
 List documents
 
-List all documents the current user has access to.
+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. 
 
 ### Example
 
@@ -101,7 +101,7 @@ opts = {
   x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
   page: 1, # Integer | Page number
   per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
-  q: 'invoice' # String | Search query. Filters documents by name (case-insensitive substring match).
+  q: 'invoice' # String | Filter documents by name prefix. Returns documents whose name starts with the given value (case-insensitive).
 }
 
 begin
@@ -122,7 +122,7 @@ Name | Type | Description  | Notes
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
  **page** | **Integer**| Page number | [optional] 
  **per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional] 
- **q** | **String**| Search query. Filters documents by name (case-insensitive substring match). | [optional] 
+ **q** | **String**| Filter documents by name prefix. Returns documents whose name starts with the given value (case-insensitive). | [optional] 
 
 ### Return type
 

data/docs/Format.md

@@ -4,32 +4,32 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **String** |  | [optional] 
-**api_name** | **String** |  | [optional] 
-**description** | **String** |  | [optional] 
-**extension** | **String** |  | [optional] 
-**default_encoding** | **String** |  | [optional] 
-**importable** | **Boolean** |  | [optional] 
-**exportable** | **Boolean** |  | [optional] 
-**default_file** | **String** |  | [optional] 
-**renders_default_locale** | **Boolean** |  | [optional] 
-**includes_locale_information** | **Boolean** |  | [optional] 
+**name** | **String** | Human-readable display name of the format. | 
+**api_name** | **String** | Identifier used to reference this format in API requests, such as the file_format parameter on the uploads and downloads endpoints. | 
+**description** | **String** | Human-readable summary of the format and its typical use case. | 
+**extension** | **String** | Default file extension associated with this format. | 
+**default_encoding** | **String** | Default character encoding used when reading or writing files in this format. | 
+**importable** | **Boolean** | Whether locale files can be imported using this format. | 
+**exportable** | **Boolean** | Whether locale files can be exported using this format. | 
+**default_file** | **String** | Conventional file path pattern for this format. Contains locale_name as a placeholder for the locale identifier. | 
+**renders_default_locale** | **Boolean** | When true, exported files contain the default locale's content for any key that has no translation in the target locale. | 
+**includes_locale_information** | **Boolean** | When true, files in this format embed locale information so Phrase can detect the locale automatically on import. | 
 
 ## Code Sample
 
 ```ruby
 require 'Phrase'
 
-instance = Phrase::Format.new(name: null,
-                                 api_name: null,
-                                 description: null,
-                                 extension: null,
-                                 default_encoding: null,
-                                 importable: null,
-                                 exportable: null,
-                                 default_file: null,
-                                 renders_default_locale: null,
-                                 includes_locale_information: null)
+instance = Phrase::Format.new(name: Ruby/Rails YAML,
+                                 api_name: yml,
+                                 description: YAML file format for use with Ruby/Rails applications,
+                                 extension: yml,
+                                 default_encoding: UTF-8,
+                                 importable: true,
+                                 exportable: true,
+                                 default_file: ./config/locales/<locale_name>.yml,
+                                 renders_default_locale: false,
+                                 includes_locale_information: false)
 ```
 
 

data/docs/FormatsApi.md

@@ -14,7 +14,7 @@ Method | HTTP request | Description
 
 List formats
 
-Get a handy list of all localization file formats supported in Phrase.
+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. 
 
 ### Example
 

data/docs/ICUApi.md

@@ -14,7 +14,7 @@ Method | HTTP request | Description
 
 Build ICU skeletons
 
-Returns ICU skeletons for multiple locale codes based on a source content.
+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. 
 
 ### Example