phrase 2.19.0 → 2.21.0

data/docs/LocaleReport.md

@@ -0,0 +1,43 @@
+# Phrase::LocaleReport
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**keys_count** | **Integer** |  | [optional] 
+**translated_translations_percentage** | **Integer** |  | [optional] 
+**unverified_translations_percentage** | **Integer** |  | [optional] 
+**reviewed_translations_percentage** | **Integer** |  | [optional] 
+**untranslated_keys_percentage** | **Integer** |  | [optional] 
+**completed_translations_count** | **Integer** |  | [optional] 
+**untranslated_keys_count** | **Integer** |  | [optional] 
+**unverified_translations_count** | **Integer** |  | [optional] 
+**reviewed_translations_count** | **Integer** |  | [optional] 
+**source_word_count** | **Integer** |  | [optional] 
+**word_count** | **Integer** |  | [optional] 
+**word_count_unverified** | **Integer** |  | [optional] 
+**word_count_missing** | **Integer** |  | [optional] 
+**locale** | [**LocalePreview**](LocalePreview.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::LocaleReport.new(keys_count: null,
+                                 translated_translations_percentage: null,
+                                 unverified_translations_percentage: null,
+                                 reviewed_translations_percentage: null,
+                                 untranslated_keys_percentage: null,
+                                 completed_translations_count: null,
+                                 untranslated_keys_count: null,
+                                 unverified_translations_count: null,
+                                 reviewed_translations_count: null,
+                                 source_word_count: null,
+                                 word_count: null,
+                                 word_count_unverified: null,
+                                 word_count_missing: null,
+                                 locale: null)
+```
+
+

data/docs/LocalesApi.md

@@ -246,13 +246,14 @@ opts = {
   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.
-  format_options: { ... }, # Object | Additional formatting and render options. See the <a href=\"https://support.phrase.com/hc/en-us/sections/6111343326364\">format guide</a> for a list of options available for each format. Specify format options like this: <code>...&format_options[foo]=bar</code>
+  format_options: { key: 3.56}, # Object | Additional formatting and render options. See the <a href=\"https://support.phrase.com/hc/en-us/sections/6111343326364\">format guide</a> for a list of options available for each format. Specify format options like this: <code>...&format_options[foo]=bar</code>
   encoding: 'encoding_example', # String | Enforces a specific encoding on the file contents. Valid options are \"UTF-8\", \"UTF-16\" and \"ISO-8859-1\".
   skip_unverified_translations: true, # Boolean | Indicates whether the locale file should skip all unverified translations. This parameter is deprecated and should be replaced with <code>include_unverified_translations</code>.
   include_unverified_translations: true, # Boolean | if set to false unverified translations are excluded
   use_last_reviewed_version: true, # Boolean | If set to true the last reviewed version of a translation is used. This is only available if the review workflow is enabled for the project.
   fallback_locale_id: 'fallback_locale_id_example', # String | If a key has no translation in the locale being downloaded the translation in the fallback locale will be used. Provide the public ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to <code>true</code>.
-  source_locale_id: 'source_locale_id_example' # String | Provides the source language of a corresponding job as the source language of the generated locale file. This parameter will be ignored unless used in combination with a <code>tag</code> parameter indicating a specific job.
+  source_locale_id: 'source_locale_id_example', # String | Provides the source language of a corresponding job as the source language of the generated locale file. This parameter will be ignored unless used in combination with a <code>tag</code> parameter indicating a specific job.
+  custom_metadata_filters: { key: 3.56} # Object | Custom metadata filters. Provide the name of the metadata field and the value to filter by. Only keys with matching metadata will be included in the download. 
 }
 
 begin
@@ -290,6 +291,7 @@ Name | Type | Description  | Notes
  **use_last_reviewed_version** | **Boolean**| If set to true the last reviewed version of a translation is used. This is only available if the review workflow is enabled for the project. | [optional] 
  **fallback_locale_id** | **String**| If a key has no translation in the locale being downloaded the translation in the fallback locale will be used. Provide the public ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to &lt;code&gt;true&lt;/code&gt;. | [optional] 
  **source_locale_id** | **String**| Provides the source language of a corresponding job as the source language of the generated locale file. This parameter will be ignored unless used in combination with a &lt;code&gt;tag&lt;/code&gt; parameter indicating a specific job. | [optional] 
+ **custom_metadata_filters** | [**Object**](.md)| Custom metadata filters. Provide the name of the metadata field and the value to filter by. Only keys with matching metadata will be included in the download.  | [optional] 
 
 ### Return type
 

data/docs/ProjectCreateParameters.md

@@ -40,7 +40,7 @@ instance = Phrase::ProjectCreateParameters.new(name: My Android Project,
                                  main_format: yml,
                                  media: Python,
                                  shares_translation_memory: true,
-                                 project_image: [B@7b48b933,
+                                 project_image: [B@5c96d290,
                                  remove_project_image: null,
                                  account_id: abcd1234,
                                  point_of_contact: abcd1234,

data/docs/ProjectReport.md

@@ -0,0 +1,31 @@
+# Phrase::ProjectReport
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**locales_count** | **Integer** |  | [optional] 
+**keys_count** | **Integer** |  | [optional] 
+**translations_count** | **Integer** |  | [optional] 
+**untranslated_keys_count** | **Integer** |  | [optional] 
+**unverified_translations_count** | **Integer** |  | [optional] 
+**reviewed_translations_count** | **Integer** |  | [optional] 
+**managed_words_count** | **Integer** |  | [optional] 
+**project** | [**ProjectShort**](ProjectShort.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::ProjectReport.new(locales_count: null,
+                                 keys_count: null,
+                                 translations_count: null,
+                                 untranslated_keys_count: null,
+                                 unverified_translations_count: null,
+                                 reviewed_translations_count: null,
+                                 managed_words_count: null,
+                                 project: null)
+```
+
+

data/docs/ProjectUpdateParameters.md

@@ -41,7 +41,7 @@ instance = Phrase::ProjectUpdateParameters.new(account_id: abcd1234,
                                  main_format: yml,
                                  media: Python,
                                  shares_translation_memory: true,
-                                 project_image: [B@35929bc7,
+                                 project_image: [B@3e908a0b,
                                  remove_project_image: false,
                                  workflow: review,
                                  machine_translation_enabled: true,

data/docs/ReportsApi.md

@@ -0,0 +1,144 @@
+# Phrase::ReportsApi
+
+All URIs are relative to *https://api.phrase.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**report_locales_list**](ReportsApi.md#report_locales_list) | **GET** /projects/{project_id}/report/locales | List Locale Reports
+[**report_show**](ReportsApi.md#report_show) | **GET** /projects/{project_id}/report | Get Project Report
+
+
+
+## report_locales_list
+
+> Array<LocaleReport> report_locales_list(project_id, opts)
+
+List Locale Reports
+
+List all locale reports for the given project
+
+### 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::ReportsApi.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)
+  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
+  locale_codes: 'locale_codes_example', # String | Locale Code
+  tag: 'tag_example', # String | tag
+  branch: 'my-feature-branch' # String | specify the branch to use
+}
+
+begin
+  #List Locale Reports
+  result = api_instance.report_locales_list(project_id, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling ReportsApi->report_locales_list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+ **page** | **Integer**| Page number | [optional] 
+ **per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional] 
+ **locale_codes** | **String**| Locale Code | [optional] 
+ **tag** | **String**| tag | [optional] 
+ **branch** | **String**| specify the branch to use | [optional] 
+
+### Return type
+
+Response<([**Array&lt;LocaleReport&gt;**](LocaleReport.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## report_show
+
+> ProjectReport report_show(project_id, opts)
+
+Get Project Report
+
+Get report of a single project.
+
+### 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::ReportsApi.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)
+  branch: 'my-feature-branch' # String | specify the branch to use
+}
+
+begin
+  #Get Project Report
+  result = api_instance.report_show(project_id, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling ReportsApi->report_show: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+ **branch** | **String**| specify the branch to use | [optional] 
+
+### Return type
+
+Response<([**ProjectReport**](ProjectReport.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

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@705a793a)
+                                 filename: [B@4aee166d)
 ```
 
 

data/docs/TranslationKeyDetails.md

@@ -22,6 +22,7 @@ Name | Type | Description | Notes
 **original_file** | **String** |  | [optional] 
 **format_value_type** | **String** |  | [optional] 
 **creator** | [**UserPreview**](UserPreview.md) |  | [optional] 
+**custom_metadata** | **Hash<String, String>** |  | [optional] 
 
 ## Code Sample
 
@@ -45,7 +46,8 @@ instance = Phrase::TranslationKeyDetails.new(id: null,
                                  xml_space_preserve: null,
                                  original_file: null,
                                  format_value_type: null,
-                                 creator: null)
+                                 creator: null,
+                                 custom_metadata: null)
 ```
 
 

data/docs/Upload.md

@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **format** | **String** |  | [optional] 
 **state** | **String** |  | [optional] 
 **tag** | **String** |  | [optional] 
+**url** | **String** | The URL to the upload in Phrase Strings app.  | [optional] 
 **summary** | [**UploadSummary**](UploadSummary.md) |  | [optional] 
 **created_at** | **Time** |  | [optional] 
 **updated_at** | **Time** |  | [optional] 
@@ -23,6 +24,7 @@ instance = Phrase::Upload.new(id: null,
                                  format: null,
                                  state: null,
                                  tag: null,
+                                 url: null,
                                  summary: null,
                                  created_at: null,
                                  updated_at: null)