phrase 1.0.13 → 2.2.0

data/docs/NotificationsApi.md

@@ -0,0 +1,194 @@
+# Phrase::NotificationsApi
+
+All URIs are relative to *https://api.phrase.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**notifications_list**](NotificationsApi.md#notifications_list) | **GET** /notifications | List notifications
+[**notifications_mark_all_as_read**](NotificationsApi.md#notifications_mark_all_as_read) | **POST** /notifications/mark_all_as_read | Mark all notifications as read
+[**notifications_show**](NotificationsApi.md#notifications_show) | **GET** /notifications/{id} | Get a single notification
+
+
+
+## notifications_list
+
+> Array<Object> notifications_list(opts)
+
+List notifications
+
+List all notifications from the current user
+
+### 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::NotificationsApi.new
+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
+}
+
+begin
+  #List notifications
+  result = api_instance.notifications_list(opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling NotificationsApi->notifications_list: #{e}"
+end
+```
+
+### Parameters
+
+
+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] 
+
+### Return type
+
+Response<(**Array&lt;Object&gt;**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## notifications_mark_all_as_read
+
+> Array&lt;Object&gt; notifications_mark_all_as_read(opts)
+
+Mark all notifications as read
+
+Mark all notifications of the current user as read
+
+### 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::NotificationsApi.new
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Mark all notifications as read
+  result = api_instance.notifications_mark_all_as_read(opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling NotificationsApi->notifications_mark_all_as_read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+
+### Return type
+
+Response<(**Array&lt;Object&gt;**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## notifications_show
+
+> Notification notifications_show(id, opts)
+
+Get a single notification
+
+Get details on a single notification.
+
+### 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::NotificationsApi.new
+id = 'id_example' # String | ID
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Get a single notification
+  result = api_instance.notifications_show(id, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling NotificationsApi->notifications_show: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| ID | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+
+### Return type
+
+Response<([**Notification**](Notification.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/OrderCreateParameters.md

@@ -5,6 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **branch** | **String** | specify the branch to use | [optional] 
+**name** | **String** | the name of the order, default name is: Translation order from 'current datetime' | [optional] 
 **lsp** | **String** | Name of the LSP that should process this order. Can be one of gengo, textmaster. | [optional] 
 **source_locale_id** | **String** | Source locale for the order. Can be the name or public id of the source locale. Preferred is the public id. | [optional] 
 **target_locale_ids** | **Array<String>** | List of target locales you want the source content translate to. Can be the name or public id of the target locales. Preferred is the public id. | [optional] 
@@ -25,6 +26,7 @@ Name | Type | Description | Notes
 require 'Phrase'
 
 instance = Phrase::OrderCreateParameters.new(branch: my-feature-branch,
+                                 name: Welcome message translations,
                                  lsp: textmaster,
                                  source_locale_id: abcd1234abcd1234abcd1234abcd1234,
                                  target_locale_ids: ["1234abcd1234abcd1234abcd1234abcd","abcd1234abcd1234abcd1234abcd1234"],

data/docs/Project.md

@@ -10,6 +10,7 @@ Name | Type | Description | Notes
 **main_format** | **String** |  | [optional] 
 **project_image_url** | **String** |  | [optional] 
 **account** | [**Account**](Account.md) |  | [optional] 
+**space** | [**Space1**](Space1.md) |  | [optional] 
 **created_at** | **DateTime** |  | [optional] 
 **updated_at** | **DateTime** |  | [optional] 
 
@@ -24,6 +25,7 @@ instance = Phrase::Project.new(id: null,
                                  main_format: null,
                                  project_image_url: null,
                                  account: null,
+                                 space: null,
                                  created_at: null,
                                  updated_at: null)
 ```

data/docs/ProjectCreateParameters.md

@@ -11,6 +11,23 @@ Name | Type | Description | Notes
 **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] 
 **source_project_id** | **String** | When a source project ID is given, a clone of that project will be created, including all locales, keys and translations as well as the main project settings if they are not defined otherwise through the params. | [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
 
@@ -23,7 +40,24 @@ instance = Phrase::ProjectCreateParameters.new(name: My Android Project,
                                  project_image: null,
                                  remove_project_image: null,
                                  account_id: abcd1234,
-                                 source_project_id: abcd1234)
+                                 source_project_id: abcd1234,
+                                 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/ProjectDetails.md

@@ -10,6 +10,7 @@ Name | Type | Description | Notes
 **main_format** | **String** |  | [optional] 
 **project_image_url** | **String** |  | [optional] 
 **account** | [**Account**](Account.md) |  | [optional] 
+**space** | [**Space1**](Space1.md) |  | [optional] 
 **created_at** | **DateTime** |  | [optional] 
 **updated_at** | **DateTime** |  | [optional] 
 **shares_translation_memory** | **Boolean** |  | [optional] 
@@ -25,6 +26,7 @@ instance = Phrase::ProjectDetails.new(id: null,
                                  main_format: null,
                                  project_image_url: null,
                                  account: null,
+                                 space: null,
                                  created_at: null,
                                  updated_at: null,
                                  shares_translation_memory: null)

data/docs/ProjectsApi.md

@@ -285,7 +285,10 @@ api_instance = Phrase::ProjectsApi.new
 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
+  account_id: 'account_id_example', # String | Filter by Account ID
+  sort_by: 'sort_by_example', # String | Sort projects. Valid options are \"name_asc\", \"name_desc\", \"updated_at_asc\", \"updated_at_desc\", \"space_asc\" and \"space_desc\".
+  filters: ['favorites'] # Array<String> | Filter projects. Valid options are [\"favorites\"].
 }
 
 begin
@@ -305,6 +308,9 @@ 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] 
+ **account_id** | **String**| Filter by Account ID | [optional] 
+ **sort_by** | **String**| Sort projects. Valid options are \&quot;name_asc\&quot;, \&quot;name_desc\&quot;, \&quot;updated_at_asc\&quot;, \&quot;updated_at_desc\&quot;, \&quot;space_asc\&quot; and \&quot;space_desc\&quot;. | [optional] 
+ **filters** | [**Array&lt;String&gt;**](String.md)| Filter projects. Valid options are [\&quot;favorites\&quot;]. | [optional] 
 
 ### Return type
 

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
 

data/docs/ScreenshotUpdateParameters.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::ScreenshotUpdateParameters.new(name: A screenshot name,
+instance = Phrase::ScreenshotUpdateParameters.new(branch: my-feature-branch,
+                                 name: A screenshot name,
                                  description: A screenshot description,
                                  filename: null)
 ```

data/docs/ScreenshotsApi.md

@@ -103,7 +103,8 @@ api_instance = Phrase::ScreenshotsApi.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)
+  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
@@ -122,6 +123,7 @@ Name | Type | Description  | Notes
  **project_id** | **String**| Project 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
 
@@ -165,7 +167,8 @@ api_instance = Phrase::ScreenshotsApi.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)
+  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
@@ -185,6 +188,7 @@ Name | Type | Description  | Notes
  **project_id** | **String**| Project 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
 
@@ -295,6 +299,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 | allows you to specify a page size up to 100 items, 25 by default
+  branch: 'my-feature-branch', # String | specify the branch to use
   key_id: 'abcd1234cdef1234abcd1234cdef1234' # String | filter by key
 }
 
@@ -316,6 +321,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] 
  **key_id** | **String**| filter by key | [optional] 
 
 ### Return type