phrase 4.24.0 → 4.26.0

data/docs/PreTranslationsApi.md

@@ -0,0 +1,210 @@
+# Phrase::PreTranslationsApi
+
+All URIs are relative to *https://api.phrase.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**pre_translation_create**](PreTranslationsApi.md#pre_translation_create) | **POST** /projects/{project_id}/pre_translations | Create a pre-translation job
+[**pre_translation_show**](PreTranslationsApi.md#pre_translation_show) | **GET** /projects/{project_id}/pre_translations/{id} | Get a single pre-translation job
+[**pre_translations_list**](PreTranslationsApi.md#pre_translations_list) | **GET** /projects/{project_id}/pre_translations | List pre-translation jobs
+
+
+
+## pre_translation_create
+
+> PreTranslation pre_translation_create(project_id, pre_translation_create_parameters, opts)
+
+Create a pre-translation job
+
+Triggers a pre-translation job for a resource within a project, addressed by `translatable_type` (`locale`, `job`, `translation_key`, or `upload`) and `translatable_id` (its ID).  Enqueues machine translation using the project's configured MT engine. 
+
+### 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::PreTranslationsApi.new
+project_id = 'project_id_example' # String | Project ID
+pre_translation_create_parameters = Phrase::PreTranslationCreateParameters.new # PreTranslationCreateParameters | 
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Create a pre-translation job
+  result = api_instance.pre_translation_create(project_id, pre_translation_create_parameters, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling PreTranslationsApi->pre_translation_create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **pre_translation_create_parameters** | [**PreTranslationCreateParameters**](PreTranslationCreateParameters.md)|  | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+
+### Return type
+
+Response<([**PreTranslation**](PreTranslation.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## pre_translation_show
+
+> PreTranslation pre_translation_show(project_id, id, opts)
+
+Get a single pre-translation job
+
+Returns a single pre-translation job identified by its ID. 
+
+### 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::PreTranslationsApi.new
+project_id = 'project_id_example' # String | Project ID
+id = 'id_example' # String | ID
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
+  if_modified_since: 'if_modified_since_example', # String | Last modified condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional)
+  if_none_match: 'if_none_match_example' # String | ETag condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional)
+}
+
+begin
+  #Get a single pre-translation job
+  result = api_instance.pre_translation_show(project_id, id, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling PreTranslationsApi->pre_translation_show: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **id** | **String**| ID | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+ **if_modified_since** | **String**| Last modified condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional) | [optional] 
+ **if_none_match** | **String**| ETag condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional) | [optional] 
+
+### Return type
+
+Response<([**PreTranslation**](PreTranslation.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## pre_translations_list
+
+> Array&lt;PreTranslation&gt; pre_translations_list(project_id, opts)
+
+List pre-translation jobs
+
+Returns all pre-translation jobs scoped to a project, ordered by creation date descending. 
+
+### 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::PreTranslationsApi.new
+project_id = 'project_id_example' # String | Project ID
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
+  if_modified_since: 'if_modified_since_example', # String | Last modified condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional)
+  if_none_match: 'if_none_match_example', # String | ETag condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (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
+}
+
+begin
+  #List pre-translation jobs
+  result = api_instance.pre_translations_list(project_id, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling PreTranslationsApi->pre_translations_list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+ **if_modified_since** | **String**| Last modified condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional) | [optional] 
+ **if_none_match** | **String**| ETag condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (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] 
+
+### Return type
+
+Response<([**Array&lt;PreTranslation&gt;**](PreTranslation.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ProjectCreateParameters.md

@@ -47,7 +47,7 @@ instance = Phrase::ProjectCreateParameters.new(name: My Android Project,
                                  main_format: yml,
                                  media: Python,
                                  shares_translation_memory: true,
-                                 project_image: [B@592bc6a7,
+                                 project_image: [B@2fb3113a,
                                  remove_project_image: null,
                                  account_id: abcd1234,
                                  point_of_contact: abcd1234,

data/docs/ProjectUpdateParameters.md

@@ -48,7 +48,7 @@ instance = Phrase::ProjectUpdateParameters.new(account_id: abcd1234,
                                  main_format: yml,
                                  media: Python,
                                  shares_translation_memory: true,
-                                 project_image: [B@519552ae,
+                                 project_image: [B@225ad262,
                                  remove_project_image: false,
                                  workflow: review,
                                  machine_translation_enabled: true,

data/docs/RepoSync.md

@@ -5,6 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **String** |  | [optional] 
+**name** | **String** | Optional custom display name for this repo sync. When null or blank, the sync is displayed using the associated project name.  | [optional] 
 **project** | [**ProjectShort**](ProjectShort.md) |  | [optional] 
 **provider** | **String** |  | [optional] 
 **enabled** | **Boolean** |  | [optional] 
@@ -21,6 +22,7 @@ Name | Type | Description | Notes
 require 'Phrase'
 
 instance = Phrase::RepoSync.new(id: null,
+                                 name: null,
                                  project: null,
                                  provider: null,
                                  enabled: null,

data/docs/RepoSyncCreateParameters.md

@@ -5,6 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **project_id** | **String** | ID of the project to connect the Repo Sync to. | 
+**name** | **String** | Optional custom display name for this repo sync. Defaults to null; when null the project name is used as the display name.  | [optional] 
 **git_provider** | **String** | The Git provider to use. | [optional] [default to 'github']
 **connection_type** | **String** | The authentication method used to connect to the Git provider. Defaults to `token` if not specified.  Valid values: - `token` — Personal access token stored on the Repo Sync. Supported by all providers. - `github_app` — Authenticate via the Phrase GitHub App installation on your account. GitHub only. The account must already have the GitHub App installed; if not, the response will include a `github_app_installation_url`. - `self_hosted` — Token-based auth for self-hosted Git instances. Requires `custom_api_endpoint`. | 
 **repo_name** | **String** | Full repository name including the owner, e.g. `my-org/my-repo`. | 
@@ -20,6 +21,7 @@ Name | Type | Description | Notes
 require 'Phrase'
 
 instance = Phrase::RepoSyncCreateParameters.new(project_id: abcd1234abcd1234abcd1234abcd1234,
+                                 name: null,
                                  git_provider: github,
                                  connection_type: github_app,
                                  repo_name: my-org/my-repo,

data/docs/ScreenshotUpdateParameters.md

@@ -17,7 +17,7 @@ require 'Phrase'
 instance = Phrase::ScreenshotUpdateParameters.new(branch: my-feature-branch,
                                  name: A screenshot name,
                                  description: A screenshot description,
-                                 filename: [B@5a2cb8e5)
+                                 filename: [B@1ddcb450)
 ```
 
 

data/docs/ScreenshotsApi.md

@@ -14,11 +14,11 @@ Method | HTTP request | Description
 
 ## screenshot_create
 
-> Screenshot screenshot_create(project_id, opts)
+> Screenshot screenshot_create(project_id, filename, opts)
 
 Create a screenshot
 
-Create a new screenshot.
+Creates a screenshot in a project to provide visual context for in-context translation. Attach translation keys to regions of the uploaded image so translators can see where each string appears in your UI.  This endpoint accepts a multipart/form-data request with a binary file upload, unlike most Phrase API endpoints that use JSON. Use a multipart form client or the -F flag in curl rather than a JSON body.  The screenshot name must be unique within the project (case-insensitive). When name is omitted, it is derived from the uploaded filename. The account must have the Screenshots feature enabled; requests to projects on accounts without it return 403. Creating a screenshot requires a token with the write scope and manage access to the project. 
 
 ### Example
 
@@ -38,17 +38,17 @@ end
 
 api_instance = Phrase::ScreenshotsApi.new
 project_id = 'project_id_example' # String | Project ID
+filename = File.new('/path/to/some/file') # File | Image file to upload. Accepted formats are JPEG (jpg/jpeg), GIF, and PNG. Maximum file size is 10 MB. Submitting an unsupported format or a file exceeding the size limit returns 422.
 opts = {
   x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
   branch: 'branch_example', # String | specify the branch to use
-  name: 'name_example', # String | Name of the screenshot
-  description: 'description_example', # String | Description of the screenshot
-  filename: File.new('/path/to/some/file') # File | Screenshot file
+  name: 'name_example', # String | Display name for the screenshot. Must be unique within the project (case-insensitive). When omitted, the name is derived from the uploaded filename.
+  description: 'description_example' # String | Optional free-text description of the screenshot.
 }
 
 begin
   #Create a screenshot
-  result = api_instance.screenshot_create(project_id, opts)
+  result = api_instance.screenshot_create(project_id, filename, opts)
   pp result
 rescue Phrase::ApiError => e
   puts "Exception when calling ScreenshotsApi->screenshot_create: #{e}"
@@ -61,11 +61,11 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **project_id** | **String**| Project ID | 
+ **filename** | **File**| Image file to upload. Accepted formats are JPEG (jpg/jpeg), GIF, and PNG. Maximum file size is 10 MB. Submitting an unsupported format or a file exceeding the size limit returns 422. | 
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
  **branch** | **String**| specify the branch to use | [optional] 
- **name** | **String**| Name of the screenshot | [optional] 
- **description** | **String**| Description of the screenshot | [optional] 
- **filename** | **File**| Screenshot file | [optional] 
+ **name** | **String**| Display name for the screenshot. Must be unique within the project (case-insensitive). When omitted, the name is derived from the uploaded filename. | [optional] 
+ **description** | **String**| Optional free-text description of the screenshot. | [optional] 
 
 ### Return type
 
@@ -87,7 +87,7 @@ Response<([**Screenshot**](Screenshot.md))>
 
 Delete a screenshot
 
-Delete an existing screenshot.
+Permanently removes a screenshot and all its associated markers from the project. Use this when you need to fully remove a screenshot that is no longer relevant — for example, after a UI redesign renders the captured screen obsolete. This is a hard delete: the screenshot record and every key-to-region marker linked to it are destroyed together and cannot be recovered. 
 
 ### Example
 
@@ -151,7 +151,7 @@ Response<(nil (empty response body))>
 
 Get a single screenshot
 
-Get details on a single screenshot for a given project.
+Returns a single screenshot belonging to the specified project. Use this to retrieve the screenshot's name, description, hosted image URL, and marker count after uploading, or before creating, updating, or inspecting its markers. The response is a synchronous, idempotent read — repeated calls return the same record without side effects.  The Attachable Screenshots feature must be enabled on the account. 
 
 ### Example
 

data/lib/phrase/api/automation_events_api.rb

@@ -0,0 +1,215 @@
+require 'cgi'
+
+module Phrase
+  class AutomationEventsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # 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). 
+    # @param account_id [String] Account ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+    # @option opts [Integer] :page Page number
+    # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
+    # @option opts [String] :automation_id Filter events to a single automation by its ID.
+    # @option opts [String] :state Filter events by outcome state. Unrecognized values are ignored.
+    # @option opts [String] :triggered_by Filter events by what triggered the automation run. Unrecognized values are ignored.
+    # @option opts [String] :project_id Filter events by project ID. Accepts a single ID or a comma-separated list of IDs.
+    # @option opts [Array<String>] :project_ids Filter events by one or more project IDs.
+    # @option opts [String] :created_after Return only events created after this ISO 8601 timestamp. Returns 400 if the value is not a valid date-time.
+    # @option opts [String] :created_before Return only events created before this ISO 8601 timestamp. Returns 400 if the value is not a valid date-time.
+    # @return [Array<AutomationEvent>]
+    def account_automation_events_list(account_id, opts = {})
+      data, _status_code, _headers = account_automation_events_list_with_http_info(account_id, opts)
+      data
+    end
+
+    # List automation events for an account
+    # Returns the run history across all automations in the account, newest-first.  Use &#x60;automation_id&#x60; to narrow results to a single automation. Use &#x60;project_id&#x60; or &#x60;project_ids&#x60; to narrow by project.  For feature availability, see [Jobs (Strings)](https://support.phrase.com/hc/en-us/articles/5784100517788-Jobs-Strings). 
+    # @param account_id [String] Account ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+    # @option opts [Integer] :page Page number
+    # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
+    # @option opts [String] :automation_id Filter events to a single automation by its ID.
+    # @option opts [String] :state Filter events by outcome state. Unrecognized values are ignored.
+    # @option opts [String] :triggered_by Filter events by what triggered the automation run. Unrecognized values are ignored.
+    # @option opts [String] :project_id Filter events by project ID. Accepts a single ID or a comma-separated list of IDs.
+    # @option opts [Array<String>] :project_ids Filter events by one or more project IDs.
+    # @option opts [String] :created_after Return only events created after this ISO 8601 timestamp. Returns 400 if the value is not a valid date-time.
+    # @option opts [String] :created_before Return only events created before this ISO 8601 timestamp. Returns 400 if the value is not a valid date-time.
+    # @return [Array<(Response<(Array<AutomationEvent>)>, Integer, Hash)>] Response<(Array<AutomationEvent>)> data, response status code and response headers
+    def account_automation_events_list_with_http_info(account_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AutomationEventsApi.account_automation_events_list ...'
+      end
+      # verify the required parameter 'account_id' is set
+      if @api_client.config.client_side_validation && account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'account_id' when calling AutomationEventsApi.account_automation_events_list"
+      end
+      allowable_values = ["success", "failure", "in_progress"]
+      if @api_client.config.client_side_validation && opts[:'state'] && !allowable_values.include?(opts[:'state'])
+        fail ArgumentError, "invalid value for \"state\", must be one of #{allowable_values}"
+      end
+      allowable_values = ["manual", "schedule", "upload", "upload_batch"]
+      if @api_client.config.client_side_validation && opts[:'triggered_by'] && !allowable_values.include?(opts[:'triggered_by'])
+        fail ArgumentError, "invalid value for \"triggered_by\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/accounts/{account_id}/automation_events'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+      query_params[:'automation_id'] = opts[:'automation_id'] if !opts[:'automation_id'].nil?
+      query_params[:'state'] = opts[:'state'] if !opts[:'state'].nil?
+      query_params[:'triggered_by'] = opts[:'triggered_by'] if !opts[:'triggered_by'].nil?
+      query_params[:'project_id'] = opts[:'project_id'] if !opts[:'project_id'].nil?
+      query_params[:'project_ids'] = @api_client.build_collection_param(opts[:'project_ids'], :multi) if !opts[:'project_ids'].nil?
+      query_params[:'created_after'] = opts[:'created_after'] if !opts[:'created_after'].nil?
+      query_params[:'created_before'] = opts[:'created_before'] if !opts[:'created_before'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'Array<AutomationEvent>' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AutomationEventsApi#account_automation_events_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      response = ::Phrase::Response.new(data, headers)
+      return response, status_code, headers
+    end
+
+    # 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). 
+    # @param account_id [String] Account ID
+    # @param id [String] ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+    # @option opts [Integer] :page Page number
+    # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
+    # @option opts [String] :state Filter events by outcome state. Unrecognized values are ignored.
+    # @option opts [String] :triggered_by Filter events by what triggered the automation run. Unrecognized values are ignored.
+    # @option opts [String] :project_id Filter events by project ID. Accepts a single ID or a comma-separated list of IDs.
+    # @option opts [Array<String>] :project_ids Filter events by one or more project IDs.
+    # @option opts [String] :created_after Return only events created after this ISO 8601 timestamp. Returns 400 if the value is not a valid date-time.
+    # @option opts [String] :created_before Return only events created before this ISO 8601 timestamp. Returns 400 if the value is not a valid date-time.
+    # @return [Array<AutomationEvent>]
+    def automation_events_list(account_id, id, opts = {})
+      data, _status_code, _headers = automation_events_list_with_http_info(account_id, id, opts)
+      data
+    end
+
+    # 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). 
+    # @param account_id [String] Account ID
+    # @param id [String] ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+    # @option opts [Integer] :page Page number
+    # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
+    # @option opts [String] :state Filter events by outcome state. Unrecognized values are ignored.
+    # @option opts [String] :triggered_by Filter events by what triggered the automation run. Unrecognized values are ignored.
+    # @option opts [String] :project_id Filter events by project ID. Accepts a single ID or a comma-separated list of IDs.
+    # @option opts [Array<String>] :project_ids Filter events by one or more project IDs.
+    # @option opts [String] :created_after Return only events created after this ISO 8601 timestamp. Returns 400 if the value is not a valid date-time.
+    # @option opts [String] :created_before Return only events created before this ISO 8601 timestamp. Returns 400 if the value is not a valid date-time.
+    # @return [Array<(Response<(Array<AutomationEvent>)>, Integer, Hash)>] Response<(Array<AutomationEvent>)> data, response status code and response headers
+    def automation_events_list_with_http_info(account_id, id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AutomationEventsApi.automation_events_list ...'
+      end
+      # verify the required parameter 'account_id' is set
+      if @api_client.config.client_side_validation && account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'account_id' when calling AutomationEventsApi.automation_events_list"
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling AutomationEventsApi.automation_events_list"
+      end
+      allowable_values = ["success", "failure", "in_progress"]
+      if @api_client.config.client_side_validation && opts[:'state'] && !allowable_values.include?(opts[:'state'])
+        fail ArgumentError, "invalid value for \"state\", must be one of #{allowable_values}"
+      end
+      allowable_values = ["manual", "schedule", "upload", "upload_batch"]
+      if @api_client.config.client_side_validation && opts[:'triggered_by'] && !allowable_values.include?(opts[:'triggered_by'])
+        fail ArgumentError, "invalid value for \"triggered_by\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/accounts/{account_id}/automations/{automation_id}/events'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+      query_params[:'state'] = opts[:'state'] if !opts[:'state'].nil?
+      query_params[:'triggered_by'] = opts[:'triggered_by'] if !opts[:'triggered_by'].nil?
+      query_params[:'project_id'] = opts[:'project_id'] if !opts[:'project_id'].nil?
+      query_params[:'project_ids'] = @api_client.build_collection_param(opts[:'project_ids'], :multi) if !opts[:'project_ids'].nil?
+      query_params[:'created_after'] = opts[:'created_after'] if !opts[:'created_after'].nil?
+      query_params[:'created_before'] = opts[:'created_before'] if !opts[:'created_before'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'Array<AutomationEvent>' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AutomationEventsApi#automation_events_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      response = ::Phrase::Response.new(data, headers)
+      return response, status_code, headers
+    end
+  end
+end

data/lib/phrase/api/branches_api.rb

@@ -13,7 +13,7 @@ module Phrase
     # @param name [String] name
     # @param [Hash] opts the optional parameters
     # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
-    # @return [nil]
+    # @return [BranchComparison]
     def branch_compare(project_id, name, opts = {})
       data, _status_code, _headers = branch_compare_with_http_info(project_id, name, opts)
       data
@@ -25,7 +25,7 @@ module Phrase
     # @param name [String] name
     # @param [Hash] opts the optional parameters
     # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
-    # @return [Array<(Response, Integer, Hash)>] Response<(nil, response status code and response headers
+    # @return [Array<(Response<(BranchComparison)>, Integer, Hash)>] Response<(BranchComparison)> data, response status code and response headers
     def branch_compare_with_http_info(project_id, name, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: BranchesApi.branch_compare ...'
@@ -46,6 +46,8 @@ module Phrase
 
       # header parameters
       header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
       header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
 
       # form parameters
@@ -55,7 +57,7 @@ module Phrase
       post_body = opts[:body] 
 
       # return_type
-      return_type = opts[:return_type] 
+      return_type = opts[:return_type] || 'BranchComparison' 
 
       # auth_names
       auth_names = opts[:auth_names] || ['Basic', 'Token']

data/lib/phrase/api/documents_api.rb

@@ -8,7 +8,7 @@ module Phrase
       @api_client = api_client
     end
     # 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. 
     # @param project_id [String] Project ID
     # @param id [String] ID
     # @param [Hash] opts the optional parameters
@@ -20,7 +20,7 @@ module Phrase
     end
 
     # 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. 
     # @param project_id [String] Project ID
     # @param id [String] ID
     # @param [Hash] opts the optional parameters
@@ -80,13 +80,13 @@ module Phrase
     end
 
     # 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. 
     # @param project_id [String] Project ID
     # @param [Hash] opts the optional parameters
     # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
     # @option opts [Integer] :page Page number
     # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
-    # @option opts [String] :q Search query. Filters documents by name (case-insensitive substring match).
+    # @option opts [String] :q Filter documents by name prefix. Returns documents whose name starts with the given value (case-insensitive).
     # @return [Array<Document>]
     def documents_list(project_id, opts = {})
       data, _status_code, _headers = documents_list_with_http_info(project_id, opts)
@@ -94,13 +94,13 @@ module Phrase
     end
 
     # 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&#x3D;invoice returns documents whose names begin with \&quot;invoice\&quot; but not documents containing \&quot;invoice\&quot; elsewhere in the name. 
     # @param project_id [String] Project ID
     # @param [Hash] opts the optional parameters
     # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
     # @option opts [Integer] :page Page number
     # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
-    # @option opts [String] :q Search query. Filters documents by name (case-insensitive substring match).
+    # @option opts [String] :q Filter documents by name prefix. Returns documents whose name starts with the given value (case-insensitive).
     # @return [Array<(Response<(Array<Document>)>, Integer, Hash)>] Response<(Array<Document>)> data, response status code and response headers
     def documents_list_with_http_info(project_id, opts = {})
       if @api_client.config.debugging