phrase 1.0.7 → 2.0.0

data/docs/LocalesApi.md

@@ -142,7 +142,7 @@ Response<(nil (empty response body))>
 
 ## locale_download
 
-> locale_download(project_id, id, opts)
+> File locale_download(project_id, id, opts)
 
 Download a locale
 
@@ -174,6 +174,7 @@ opts = {
   tags: 'feature1,feature2', # String | Limit results to keys tagged with a list of comma separated tag names.
   tag: 'feature', # String | Limit download to tagged keys. This parameter is deprecated. Please use the \"tags\" parameter instead
   include_empty_translations: true, # Boolean | Indicates whether keys without translations should be included in the output as well.
+  exclude_empty_zero_forms: true, # Boolean | Indicates whether zero forms should be included when empty in pluralized keys.
   include_translated_keys: true, # Boolean | Include translated keys in the locale file. Use in combination with include_empty_translations to obtain only untranslated keys.
   keep_notranslate_tags: true, # Boolean | Indicates whether [NOTRANSLATE] tags should be kept.
   convert_emoji: true, # Boolean | This option is obsolete. Projects that were created on or after Nov 29th 2019 or that did not contain emoji by then will not require this flag any longer since emoji are now supported natively.
@@ -187,7 +188,8 @@ opts = {
 
 begin
   #Download a locale
-  api_instance.locale_download(project_id, id, opts)
+  result = api_instance.locale_download(project_id, id, opts)
+  pp result
 rescue Phrase::ApiError => e
   puts "Exception when calling LocalesApi->locale_download: #{e}"
 end
@@ -206,6 +208,7 @@ Name | Type | Description  | Notes
  **tags** | **String**| Limit results to keys tagged with a list of comma separated tag names. | [optional] 
  **tag** | **String**| Limit download to tagged keys. This parameter is deprecated. Please use the \&quot;tags\&quot; parameter instead | [optional] 
  **include_empty_translations** | **Boolean**| Indicates whether keys without translations should be included in the output as well. | [optional] 
+ **exclude_empty_zero_forms** | **Boolean**| Indicates whether zero forms should be included when empty in pluralized keys. | [optional] 
  **include_translated_keys** | **Boolean**| Include translated keys in the locale file. Use in combination with include_empty_translations to obtain only untranslated keys. | [optional] 
  **keep_notranslate_tags** | **Boolean**| Indicates whether [NOTRANSLATE] tags should be kept. | [optional] 
  **convert_emoji** | **Boolean**| This option is obsolete. Projects that were created on or after Nov 29th 2019 or that did not contain emoji by then will not require this flag any longer since emoji are now supported natively. | [optional] 
@@ -218,7 +221,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-Response<(nil (empty response body))>
+Response<(**File**)>
 
 ### Authorization
 
@@ -227,7 +230,7 @@ Response<(nil (empty response body))>
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: Not defined
+- **Accept**: *
 
 
 ## locale_show

data/docs/Member.md

@@ -9,6 +9,9 @@ Name | Type | Description | Notes
 **username** | **String** |  | [optional] 
 **role** | **String** |  | [optional] 
 **projects** | [**Array<ProjectLocales>**](ProjectLocales.md) |  | [optional] 
+**permissions** | [**Object**](.md) |  | [optional] 
+**default_locale_codes** | **Array<String>** |  | [optional] 
+**spaces** | [**Array<MemberSpaces>**](MemberSpaces.md) |  | [optional] 
 
 ## Code Sample
 
@@ -19,7 +22,10 @@ instance = Phrase::Member.new(id: null,
                                  email: null,
                                  username: null,
                                  role: null,
-                                 projects: null)
+                                 projects: null,
+                                 permissions: null,
+                                 default_locale_codes: null,
+                                 spaces: null)
 ```
 
 

data/docs/MemberProjectDetail.md

@@ -0,0 +1,35 @@
+# Phrase::MemberProjectDetail
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**email** | **String** |  | [optional] 
+**username** | **String** |  | [optional] 
+**role** | **String** |  | [optional] 
+**projects** | [**Array<ProjectLocales>**](ProjectLocales.md) |  | [optional] 
+**permissions** | [**Object**](.md) |  | [optional] 
+**locale_ids** | **Array<String>** |  | [optional] 
+**default_locale_codes** | **Array<String>** |  | [optional] 
+**spaces** | [**Array<MemberSpaces>**](MemberSpaces.md) |  | [optional] 
+**project_roles** | [**Array<MemberProjectDetailProjectRoles>**](MemberProjectDetailProjectRoles.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::MemberProjectDetail.new(id: null,
+                                 email: null,
+                                 username: null,
+                                 role: null,
+                                 projects: null,
+                                 permissions: null,
+                                 locale_ids: null,
+                                 default_locale_codes: null,
+                                 spaces: null,
+                                 project_roles: null)
+```
+
+

data/docs/MemberProjectDetailProjectRoles.md

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

data/docs/MemberSpaces.md

@@ -0,0 +1,25 @@
+# Phrase::MemberSpaces
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**created_at** | [**AnyType**](.md) |  | [optional] 
+**updated_at** | [**AnyType**](.md) |  | [optional] 
+**projects_count** | **Integer** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::MemberSpaces.new(id: null,
+                                 name: null,
+                                 created_at: null,
+                                 updated_at: null,
+                                 projects_count: null)
+```
+
+

data/docs/MemberUpdateParameters.md

@@ -7,6 +7,8 @@ Name | Type | Description | Notes
 **role** | **String** | Member role, can be any of of Manager, Developer, Translator | [optional] 
 **project_ids** | **String** | List of project ids the user has access to.  | [optional] 
 **locale_ids** | **String** | List of locale ids the user has access to. | [optional] 
+**default_locale_codes** | **Array<String>** | List of default locales for the user. | [optional] 
+**space_ids** | **Array<String>** | List of spaces the user is assigned to. | [optional] 
 **permissions** | **Hash<String, String>** | Additional permissions depending on member role. Available permissions are <code>create_upload</code> and <code>review_translations</code> | [optional] 
 
 ## Code Sample
@@ -17,6 +19,8 @@ require 'Phrase'
 instance = Phrase::MemberUpdateParameters.new(role: Developer,
                                  project_ids: abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235,
                                  locale_ids: abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235,
+                                 default_locale_codes: ["en","fi"],
+                                 space_ids: ["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"],
                                  permissions: {"create_upload":true,"review_translations":true})
 ```
 

data/docs/MemberUpdateSettingsParameters.md

@@ -0,0 +1,19 @@
+# Phrase::MemberUpdateSettingsParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**project_role** | **String** | Member role, can be any of of Manager, Developer, Translator | [optional] 
+**locale_ids** | **Array<String>** | List of locale ids the user has access to. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::MemberUpdateSettingsParameters.new(project_role: Developer,
+                                 locale_ids: ["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"])
+```
+
+

data/docs/MembersApi.md

@@ -7,6 +7,7 @@ Method | HTTP request | Description
 [**member_delete**](MembersApi.md#member_delete) | **DELETE** /accounts/{account_id}/members/{id} | Remove a user from the account
 [**member_show**](MembersApi.md#member_show) | **GET** /accounts/{account_id}/members/{id} | Get single member
 [**member_update**](MembersApi.md#member_update) | **PATCH** /accounts/{account_id}/members/{id} | Update a member
+[**member_update_settings**](MembersApi.md#member_update_settings) | **PATCH** /projects/{project_id}/members/{id} | Update a member's project settings
 [**members_list**](MembersApi.md#members_list) | **GET** /accounts/{account_id}/members | List members
 
 
@@ -201,6 +202,71 @@ Response<([**Member**](Member.md))>
 - **Accept**: application/json
 
 
+## member_update_settings
+
+> MemberProjectDetail member_update_settings(project_id, id, member_update_settings_parameters, opts)
+
+Update a member's project settings
+
+Update user settings in the project. Access token scope must include <code>team.manage</code>.
+
+### 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::MembersApi.new
+project_id = 'project_id_example' # String | Project ID
+id = 'id_example' # String | ID
+member_update_settings_parameters = Phrase::MemberUpdateSettingsParameters.new # MemberUpdateSettingsParameters | 
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Update a member's project settings
+  result = api_instance.member_update_settings(project_id, id, member_update_settings_parameters, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling MembersApi->member_update_settings: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **id** | **String**| ID | 
+ **member_update_settings_parameters** | [**MemberUpdateSettingsParameters**](MemberUpdateSettingsParameters.md)|  | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+
+### Return type
+
+Response<([**MemberProjectDetail**](MemberProjectDetail.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## members_list
 
 > Array&lt;Member&gt; members_list(account_id, opts)

data/docs/ProjectUpdateParameters.md

@@ -4,24 +4,58 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **String** | Name of the project | [optional] 
-**main_format** | **String** | Main file format specified by its API Extension name. Used for locale downloads if no format is specified. For API Extension names of available file formats see <a href=\"https://help.phrase.com/help/supported-platforms-and-formats\">Format Guide</a> or our <a href=\"#formats\">Formats API Endpoint</a>. | [optional] 
-**shares_translation_memory** | **Boolean** | Indicates whether the project should share the account's translation memory | [optional] 
-**project_image** | **File** | Image to identify the project | [optional] 
-**remove_project_image** | **Boolean** | Indicates whether the project image should be deleted. | [optional] 
-**account_id** | **String** | Account ID to specify the actual account the project should be created in. Required if the requesting user is a member of multiple accounts. | [optional] 
+**account_id** | **String** | Required if the requesting user is a member of multiple accounts. Account ID to specify the actual account the project should be created in. | [optional] 
+**name** | **String** | (Optional) Name of the project | [optional] 
+**main_format** | **String** | (Optional) Main file format specified by its API Extension name. Used for locale downloads if no format is specified. For API Extension names of available file formats see <a href=\"https://help.phrase.com/help/supported-platforms-and-formats\">Format Guide</a> or our <a href=\"#formats\">Formats API Endpoint</a>. | [optional] 
+**shares_translation_memory** | **Boolean** | (Optional) Indicates whether the project should share the account's translation memory | [optional] 
+**project_image** | **File** | (Optional) Image to identify the project | [optional] 
+**remove_project_image** | **Boolean** | (Optional) Indicates whether the project image should be deleted. | [optional] 
+**workflow** | **String** | (Optional) Review Workflow. \"simple\" / \"review\". <a href=\"https://help.phrase.com/help/advanced-review-workflow\">Read more</a> | [optional] 
+**machine_translation_enabled** | **Boolean** | (Optional) Enable machine translation support in the project. Required for Autopilot and Smart Suggest | [optional] 
+**enable_branching** | **Boolean** | (Optional) Enable branching in the project | [optional] 
+**protect_master_branch** | **Boolean** | (Optional) Protect the master branch in project where branching is enabled | [optional] 
+**enable_all_data_type_translation_keys_for_translators** | **Boolean** | (Optional) Otherwise, translators are not allowed to edit translations other than strings | [optional] 
+**enable_icu_message_format** | **Boolean** | (Optional) We can validate and highlight your ICU messages. <a href=\"https://help.phrase.com/help/icu-message-format\">Read more</a> | [optional] 
+**zero_plural_form_enabled** | **Boolean** | (Optional) Displays the input fields for the 'ZERO' plural form for every key as well although only some languages require the 'ZERO' explicitly. | [optional] 
+**autotranslate_enabled** | **Boolean** | (Optional) Autopilot, requires machine_translation_enabled. <a href=\"https://help.phrase.com/help/autopilot\">Read more</a> | [optional] 
+**autotranslate_check_new_translation_keys** | **Boolean** | (Optional) Requires autotranslate_enabled to be true | [optional] 
+**autotranslate_check_new_uploads** | **Boolean** | (Optional) Requires autotranslate_enabled to be true | [optional] 
+**autotranslate_check_new_locales** | **Boolean** | (Optional) Requires autotranslate_enabled to be true | [optional] 
+**autotranslate_mark_as_unverified** | **Boolean** | (Optional) Requires autotranslate_enabled to be true | [optional] 
+**autotranslate_use_machine_translation** | **Boolean** | (Optional) Requires autotranslate_enabled to be true | [optional] 
+**autotranslate_use_translation_memory** | **Boolean** | (Optional) Requires autotranslate_enabled to be true | [optional] 
+**smart_suggest_enabled** | **Boolean** | (Optional) Smart Suggest, requires machine_translation_enabled | [optional] 
+**smart_suggest_use_glossary** | **Boolean** | (Optional) Requires smart_suggest_enabled to be true | [optional] 
+**smart_suggest_use_machine_translation** | **Boolean** | (Optional) Requires smart_suggest_enabled to be true | [optional] 
 
 ## Code Sample
 
 ```ruby
 require 'Phrase'
 
-instance = Phrase::ProjectUpdateParameters.new(name: My Android Project,
+instance = Phrase::ProjectUpdateParameters.new(account_id: abcd1234,
+                                 name: My Android Project,
                                  main_format: yml,
                                  shares_translation_memory: true,
                                  project_image: null,
-                                 remove_project_image: null,
-                                 account_id: abcd1234)
+                                 remove_project_image: false,
+                                 workflow: review,
+                                 machine_translation_enabled: true,
+                                 enable_branching: true,
+                                 protect_master_branch: true,
+                                 enable_all_data_type_translation_keys_for_translators: true,
+                                 enable_icu_message_format: true,
+                                 zero_plural_form_enabled: true,
+                                 autotranslate_enabled: true,
+                                 autotranslate_check_new_translation_keys: true,
+                                 autotranslate_check_new_uploads: true,
+                                 autotranslate_check_new_locales: true,
+                                 autotranslate_mark_as_unverified: true,
+                                 autotranslate_use_machine_translation: true,
+                                 autotranslate_use_translation_memory: true,
+                                 smart_suggest_enabled: true,
+                                 smart_suggest_use_glossary: true,
+                                 smart_suggest_use_machine_translation: true)
 ```
 
 

data/docs/ScreenshotCreateParameters.md

@@ -4,6 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**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] 
@@ -13,7 +14,8 @@ Name | Type | Description | Notes
 ```ruby
 require 'Phrase'
 
-instance = Phrase::ScreenshotCreateParameters.new(name: A screenshot name,
+instance = Phrase::ScreenshotCreateParameters.new(branch: my-feature-branch,
+                                 name: A screenshot name,
                                  description: A screenshot description,
                                  filename: null)
 ```

data/docs/ScreenshotMarkerCreateParameters.md

@@ -4,6 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional] 
 **key_id** | **String** | Specify the Key ID which should be highlighted on the specified screenshot. The Key must belong to the project. | [optional] 
 **presentation** | **String** | Presentation details of the screenshot marker in JSON format.<br/><br/>Each Screenshot Marker is represented as a rectangular shaped highlight box with the name of the specified Key attached. You can specify the marker position on the screenshot (<code>x</code>-axis and <code>y</code>-axis in pixels) from the top left corner of the screenshot and the dimensions of the marker itself (<code>w</code> and <code>h</code> in pixels). | [optional] 
 
@@ -12,7 +13,8 @@ Name | Type | Description | Notes
 ```ruby
 require 'Phrase'
 
-instance = Phrase::ScreenshotMarkerCreateParameters.new(key_id: abcd1234abcd1234abcd1234abcd1234,
+instance = Phrase::ScreenshotMarkerCreateParameters.new(branch: my-feature-branch,
+                                 key_id: abcd1234abcd1234abcd1234abcd1234,
                                  presentation: { "x": 100, "y": 100, "w": 100, "h": 100 })
 ```
 

data/docs/ScreenshotMarkerUpdateParameters.md

@@ -4,6 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional] 
 **key_id** | **String** | Specify the Key ID which should be highlighted on the specified screenshot. The Key must belong to the project. | [optional] 
 **presentation** | **String** | Presentation details of the screenshot marker in JSON format.<br/><br/>Each Screenshot Marker is represented as a rectangular shaped highlight box with the name of the specified Key attached. You can specify the marker position on the screenshot (<code>x</code>-axis and <code>y</code>-axis in pixels) from the top left corner of the screenshot and the dimensions of the marker itself (<code>w</code> and <code>h</code> in pixels). | [optional] 
 
@@ -12,7 +13,8 @@ Name | Type | Description | Notes
 ```ruby
 require 'Phrase'
 
-instance = Phrase::ScreenshotMarkerUpdateParameters.new(key_id: abcd1234abcd1234abcd1234abcd1234,
+instance = Phrase::ScreenshotMarkerUpdateParameters.new(branch: my-feature-branch,
+                                 key_id: abcd1234abcd1234abcd1234abcd1234,
                                  presentation: { "x": 100, "y": 100, "w": 100, "h": 100 })
 ```
 

data/docs/ScreenshotMarkersApi.md

@@ -105,7 +105,8 @@ api_instance = Phrase::ScreenshotMarkersApi.new
 project_id = 'project_id_example' # String | Project ID
 screenshot_id = 'screenshot_id_example' # String | Screenshot ID
 opts = {
-  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
+  branch: 'my-feature-branch' # String | specify the branch to use
 }
 
 begin
@@ -124,6 +125,7 @@ Name | Type | Description  | Notes
  **project_id** | **String**| Project ID | 
  **screenshot_id** | **String**| Screenshot ID | 
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+ **branch** | **String**| specify the branch to use | [optional] 
 
 ### Return type
 
@@ -168,7 +170,8 @@ project_id = 'project_id_example' # String | Project ID
 screenshot_id = 'screenshot_id_example' # String | Screenshot ID
 id = 'id_example' # String | ID
 opts = {
-  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
+  branch: 'my-feature-branch' # String | specify the branch to use
 }
 
 begin
@@ -189,6 +192,7 @@ Name | Type | Description  | Notes
  **screenshot_id** | **String**| Screenshot ID | 
  **id** | **String**| ID | 
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+ **branch** | **String**| specify the branch to use | [optional] 
 
 ### Return type
 
@@ -299,7 +303,8 @@ 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 | allows you to specify a page size up to 100 items, 25 by default
+  per_page: 25, # Integer | allows you to specify a page size up to 100 items, 25 by default
+  branch: 'my-feature-branch' # String | specify the branch to use
 }
 
 begin
@@ -321,6 +326,7 @@ Name | Type | Description  | Notes
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
  **page** | **Integer**| Page number | [optional] 
  **per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional] 
+ **branch** | **String**| specify the branch to use | [optional] 
 
 ### Return type