phrase 4.9.0 → 4.11.0

data/docs/BranchesApi.md

@@ -9,6 +9,7 @@ Method | HTTP request | Description
 [**branch_delete**](BranchesApi.md#branch_delete) | **DELETE** /projects/{project_id}/branches/{name} | Delete a branch
 [**branch_merge**](BranchesApi.md#branch_merge) | **PATCH** /projects/{project_id}/branches/{name}/merge | Merge a branch
 [**branch_show**](BranchesApi.md#branch_show) | **GET** /projects/{project_id}/branches/{name} | Get a single branch
+[**branch_sync**](BranchesApi.md#branch_sync) | **PATCH** /projects/{project_id}/branches/{name}/sync | Sync a branch
 [**branch_update**](BranchesApi.md#branch_update) | **PATCH** /projects/{project_id}/branches/{name} | Update a branch
 [**branches_list**](BranchesApi.md#branches_list) | **GET** /projects/{project_id}/branches | List branches
 
@@ -207,7 +208,7 @@ Response<(nil (empty response body))>
 
 Merge a branch
 
-Merge an existing branch.   *Note: Merging a branch may take several minutes depending on diff size.* 
+Merge an existing branch.  *Note: Merging a branch may take several minutes depending on diff size.* 
 
 ### Example
 
@@ -328,6 +329,70 @@ Response<([**Branch**](Branch.md))>
 - **Accept**: application/json
 
 
+## branch_sync
+
+> branch_sync(project_id, name, branch_sync_parameters, opts)
+
+Sync a branch
+
+Sync an existing branch.  *Note: Only available for branches created with new branching. New branching is currently in private beta* 
+
+### 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::BranchesApi.new
+project_id = 'project_id_example' # String | Project ID
+name = 'name_example' # String | name
+branch_sync_parameters = Phrase::BranchSyncParameters.new # BranchSyncParameters | 
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Sync a branch
+  api_instance.branch_sync(project_id, name, branch_sync_parameters, opts)
+rescue Phrase::ApiError => e
+  puts "Exception when calling BranchesApi->branch_sync: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **name** | **String**| name | 
+ **branch_sync_parameters** | [**BranchSyncParameters**](BranchSyncParameters.md)|  | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+
+### Return type
+
+Response<(nil (empty response body))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: Not defined
+
+
 ## branch_update
 
 > Branch branch_update(project_id, name, branch_update_parameters, opts)

data/docs/KeyCreateParameters.md

@@ -38,7 +38,7 @@ instance = Phrase::KeyCreateParameters.new(branch: my-feature-branch,
                                  data_type: number,
                                  tags: awesome-feature,needs-proofreading,
                                  max_characters_allowed: 140,
-                                 screenshot: [B@307b954,
+                                 screenshot: [B@13421eb0,
                                  remove_screenshot: null,
                                  unformatted: null,
                                  default_translation_content: Default translation content,

data/docs/KeyUpdateParameters.md

@@ -36,7 +36,7 @@ instance = Phrase::KeyUpdateParameters.new(branch: my-feature-branch,
                                  data_type: number,
                                  tags: awesome-feature,needs-proofreading,
                                  max_characters_allowed: 140,
-                                 screenshot: [B@52fd6b76,
+                                 screenshot: [B@bf68379,
                                  remove_screenshot: null,
                                  unformatted: null,
                                  xml_space_preserve: null,

data/docs/ProjectCreateParameters.md

@@ -37,7 +37,7 @@ instance = Phrase::ProjectCreateParameters.new(name: My Android Project,
                                  main_format: yml,
                                  media: Python,
                                  shares_translation_memory: true,
-                                 project_image: [B@3feafba2,
+                                 project_image: [B@c34e260,
                                  remove_project_image: null,
                                  account_id: abcd1234,
                                  point_of_contact: abcd1234,

data/docs/ProjectUpdateParameters.md

@@ -39,7 +39,7 @@ instance = Phrase::ProjectUpdateParameters.new(account_id: abcd1234,
                                  main_format: yml,
                                  media: Python,
                                  shares_translation_memory: true,
-                                 project_image: [B@602621bb,
+                                 project_image: [B@39342312,
                                  remove_project_image: false,
                                  workflow: review,
                                  machine_translation_enabled: true,

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@6bd87866)
+                                 filename: [B@384edc3b)
 ```
 
 

data/docs/TranslationUpdateParameters.md

@@ -10,6 +10,7 @@ Name | Type | Description | Notes
 **unverified** | **Boolean** | Indicates whether translation is unverified. Part of the [Advanced Workflows](https://support.phrase.com/hc/en-us/articles/5784094755484) feature. | [optional] 
 **excluded** | **Boolean** | Indicates whether translation is excluded. | [optional] 
 **autotranslate** | **Boolean** | Indicates whether the translation should be auto-translated. Responses with status 422 if provided for translation within a non-default locale or the project does not have the Autopilot feature enabled. | [optional] 
+**reviewed** | **Boolean** | When set to `true`, the translation will be marked as reviewed. | [optional] 
 
 ## Code Sample
 
@@ -21,7 +22,8 @@ instance = Phrase::TranslationUpdateParameters.new(branch: my-feature-branch,
                                  plural_suffix: null,
                                  unverified: null,
                                  excluded: null,
-                                 autotranslate: null)
+                                 autotranslate: null,
+                                 reviewed: true)
 ```
 
 

data/docs/UploadsApi.md

@@ -44,7 +44,7 @@ opts = {
   branch: 'branch_example', # String | specify the branch to use
   tags: 'tags_example', # String | List of tags separated by comma to be associated with the new keys contained in the upload.
   update_translations: true, # Boolean | Indicates whether existing translations should be updated with the file content.
-  update_custom_metadata: true, # Boolean | Indicates whether existing custom metadata properties should be updated with the file content
+  update_custom_metadata: true, # Boolean | Determines whether to update custom metadata values when uploading a file. If set to true, existing metadata can be changed or removed. Passing an empty value deletes the corresponding metadata property.
   update_translation_keys: true, # Boolean | Pass `false` here to prevent new keys from being created and existing keys updated.
   update_translations_on_source_match: true, # Boolean | Update target translations only if the source translations of the uploaded multilingual file match the stored translations.
   update_descriptions: true, # Boolean | Existing key descriptions will be updated with the file content. Empty descriptions overwrite existing descriptions.
@@ -83,7 +83,7 @@ Name | Type | Description  | Notes
  **branch** | **String**| specify the branch to use | [optional] 
  **tags** | **String**| List of tags separated by comma to be associated with the new keys contained in the upload. | [optional] 
  **update_translations** | **Boolean**| Indicates whether existing translations should be updated with the file content. | [optional] 
- **update_custom_metadata** | **Boolean**| Indicates whether existing custom metadata properties should be updated with the file content | [optional] [default to true]
+ **update_custom_metadata** | **Boolean**| Determines whether to update custom metadata values when uploading a file. If set to true, existing metadata can be changed or removed. Passing an empty value deletes the corresponding metadata property. | [optional] [default to true]
  **update_translation_keys** | **Boolean**| Pass `false` here to prevent new keys from being created and existing keys updated. | [optional] [default to true]
  **update_translations_on_source_match** | **Boolean**| Update target translations only if the source translations of the uploaded multilingual file match the stored translations. | [optional] [default to false]
  **update_descriptions** | **Boolean**| Existing key descriptions will be updated with the file content. Empty descriptions overwrite existing descriptions. | [optional]