phrase 2.20.0 → 2.22.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (86) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +22 -0
  3. data/README.md +27 -5
  4. data/docs/CustomMetadataApi.md +339 -0
  5. data/docs/CustomMetadataDataType.md +16 -0
  6. data/docs/CustomMetadataPropertiesCreateParameters.md +25 -0
  7. data/docs/CustomMetadataPropertiesUpdateParameters.md +23 -0
  8. data/docs/CustomMetadataProperty.md +33 -0
  9. data/docs/CustomMetadataPropertyCreate422Response.md +19 -0
  10. data/docs/{InvitationCreate422ResponseErrorsInner.md → CustomMetadataPropertyCreate422ResponseErrorsInner.md} +2 -2
  11. data/docs/Error.md +17 -0
  12. data/docs/ErrorError.md +19 -0
  13. data/docs/KeyCreateParameters.md +4 -2
  14. data/docs/KeyUpdateParameters.md +4 -2
  15. data/docs/KeysApi.md +2 -2
  16. data/docs/KeysSearchParameters.md +1 -1
  17. data/docs/LocaleReport.md +43 -0
  18. data/docs/LocalesApi.md +3 -1
  19. data/docs/ProjectCreateParameters.md +1 -1
  20. data/docs/ProjectReport.md +31 -0
  21. data/docs/ProjectUpdateParameters.md +1 -1
  22. data/docs/ProjectsQualityPerformanceScore200Response.md +21 -0
  23. data/docs/ProjectsQualityPerformanceScore200ResponseAnyOf.md +19 -0
  24. data/docs/ProjectsQualityPerformanceScore200ResponseAnyOfData.md +17 -0
  25. data/docs/ProjectsQualityPerformanceScore200ResponseAnyOfDataTranslationsInner.md +21 -0
  26. data/docs/ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner.md +21 -0
  27. data/docs/ProjectsQualityPerformanceScoreRequest.md +17 -0
  28. data/docs/QualityPerformanceScoreApi.md +72 -0
  29. data/docs/ReportsApi.md +144 -0
  30. data/docs/ScreenshotUpdateParameters.md +1 -1
  31. data/docs/TranslationKeyDetails.md +3 -1
  32. data/docs/Upload.md +2 -0
  33. data/lib/phrase/api/custom_metadata_api.rb +390 -0
  34. data/lib/phrase/api/keys_api.rb +2 -2
  35. data/lib/phrase/api/locales_api.rb +3 -0
  36. data/lib/phrase/api/quality_performance_score_api.rb +84 -0
  37. data/lib/phrase/api/reports_api.rb +160 -0
  38. data/lib/phrase/models/custom_metadata_data_type.rb +30 -0
  39. data/lib/phrase/models/custom_metadata_properties_create_parameters.rb +272 -0
  40. data/lib/phrase/models/custom_metadata_properties_update_parameters.rb +231 -0
  41. data/lib/phrase/models/custom_metadata_property.rb +294 -0
  42. data/lib/phrase/models/{invitation_create422_response.rb → custom_metadata_property_create422_response.rb} +4 -4
  43. data/lib/phrase/models/{invitation_create422_response_errors_inner.rb → custom_metadata_property_create422_response_errors_inner.rb} +3 -3
  44. data/lib/phrase/models/error.rb +197 -0
  45. data/lib/phrase/models/error_error.rb +205 -0
  46. data/lib/phrase/models/key_create_parameters.rb +14 -4
  47. data/lib/phrase/models/key_update_parameters.rb +14 -4
  48. data/lib/phrase/models/keys_search_parameters.rb +1 -1
  49. data/lib/phrase/models/locale_report.rb +313 -0
  50. data/lib/phrase/models/project_report.rb +259 -0
  51. data/lib/phrase/models/projects_quality_performance_score200_response.rb +237 -0
  52. data/lib/phrase/models/projects_quality_performance_score200_response_any_of.rb +208 -0
  53. data/lib/phrase/models/projects_quality_performance_score200_response_any_of_data.rb +198 -0
  54. data/lib/phrase/models/projects_quality_performance_score200_response_any_of_data_translations_inner.rb +217 -0
  55. data/lib/phrase/models/projects_quality_performance_score200_response_any_of_errors_inner.rb +215 -0
  56. data/lib/phrase/models/projects_quality_performance_score_request.rb +199 -0
  57. data/lib/phrase/models/translation_key_details.rb +15 -4
  58. data/lib/phrase/models/upload.rb +11 -1
  59. data/lib/phrase/version.rb +1 -1
  60. data/lib/phrase.rb +19 -2
  61. data/spec/api/custom_metadata_api_spec.rb +99 -0
  62. data/spec/api/keys_api_spec.rb +1 -1
  63. data/spec/api/quality_performance_score_api_spec.rb +37 -0
  64. data/spec/api/reports_api_spec.rb +55 -0
  65. data/spec/models/custom_metadata_data_type_spec.rb +23 -0
  66. data/spec/models/custom_metadata_properties_create_parameters_spec.rb +53 -0
  67. data/spec/models/custom_metadata_properties_update_parameters_spec.rb +47 -0
  68. data/spec/models/{invitation_create422_response_errors_inner_spec.rb → custom_metadata_property_create422_response_errors_inner_spec.rb} +6 -6
  69. data/spec/models/custom_metadata_property_create422_response_spec.rb +35 -0
  70. data/spec/models/custom_metadata_property_spec.rb +77 -0
  71. data/spec/models/{invitation_create422_response_spec.rb → error_error_spec.rb} +7 -7
  72. data/spec/models/error_spec.rb +29 -0
  73. data/spec/models/key_create_parameters_spec.rb +6 -0
  74. data/spec/models/key_update_parameters_spec.rb +6 -0
  75. data/spec/models/locale_report_spec.rb +107 -0
  76. data/spec/models/project_report_spec.rb +71 -0
  77. data/spec/models/projects_quality_performance_score200_response_any_of_data_spec.rb +29 -0
  78. data/spec/models/projects_quality_performance_score200_response_any_of_data_translations_inner_spec.rb +41 -0
  79. data/spec/models/projects_quality_performance_score200_response_any_of_errors_inner_spec.rb +41 -0
  80. data/spec/models/projects_quality_performance_score200_response_any_of_spec.rb +35 -0
  81. data/spec/models/projects_quality_performance_score200_response_spec.rb +41 -0
  82. data/spec/models/projects_quality_performance_score_request_spec.rb +29 -0
  83. data/spec/models/translation_key_details_spec.rb +6 -0
  84. data/spec/models/upload_spec.rb +6 -0
  85. metadata +285 -217
  86. data/docs/InvitationCreate422Response.md +0 -19
@@ -20,6 +20,7 @@ Name | Type | Description | Notes
20
20
  **original_file** | **String** | Original file attribute. Used in some formats, e.g. XLIFF. | [optional]
21
21
  **localized_format_string** | **String** | NSStringLocalizedFormatKey attribute. Used in .stringsdict format. | [optional]
22
22
  **localized_format_key** | **String** | NSStringLocalizedFormatKey attribute. Used in .stringsdict format. | [optional]
23
+ **custom_metadata** | **Object** | Custom metadata property name and value pairs to be associated with key. | [optional]
23
24
 
24
25
  ## Code Sample
25
26
 
@@ -34,14 +35,15 @@ instance = Phrase::KeyCreateParameters.new(branch: my-feature-branch,
34
35
  data_type: number,
35
36
  tags: awesome-feature,needs-proofreading,
36
37
  max_characters_allowed: 140,
37
- screenshot: [B@1ef64e45,
38
+ screenshot: [B@5bbda7e2,
38
39
  remove_screenshot: null,
39
40
  unformatted: null,
40
41
  default_translation_content: Default translation content,
41
42
  xml_space_preserve: null,
42
43
  original_file: null,
43
44
  localized_format_string: null,
44
- localized_format_key: null)
45
+ localized_format_key: null,
46
+ custom_metadata: {"fruit":"Apple","vegetable":"Tomato"})
45
47
  ```
46
48
 
47
49
 
@@ -19,6 +19,7 @@ Name | Type | Description | Notes
19
19
  **original_file** | **String** | Original file attribute. Used in some formats, e.g. XLIFF. | [optional]
20
20
  **localized_format_string** | **String** | NSStringLocalizedFormatKey attribute. Used in .stringsdict format. | [optional]
21
21
  **localized_format_key** | **String** | NSStringLocalizedFormatKey attribute. Used in .stringsdict format. | [optional]
22
+ **custom_metadata** | **Object** | Updates/Creates custom metadata property name and value pairs to be associated with key. If you want to delete a custom metadata property, you can set its value to null. If you want to update a custom metadata property, you can set its value to the new value. | [optional]
22
23
 
23
24
  ## Code Sample
24
25
 
@@ -33,13 +34,14 @@ instance = Phrase::KeyUpdateParameters.new(branch: my-feature-branch,
33
34
  data_type: number,
34
35
  tags: awesome-feature,needs-proofreading,
35
36
  max_characters_allowed: 140,
36
- screenshot: [B@39e08d73,
37
+ screenshot: [B@37500808,
37
38
  remove_screenshot: null,
38
39
  unformatted: null,
39
40
  xml_space_preserve: null,
40
41
  original_file: null,
41
42
  localized_format_string: null,
42
- localized_format_key: null)
43
+ localized_format_key: null,
44
+ custom_metadata: {"fruit":"Apple","vegetable":"Tomato"})
43
45
  ```
44
46
 
45
47
 
data/docs/KeysApi.md CHANGED
@@ -501,7 +501,7 @@ opts = {
501
501
  branch: 'my-feature-branch', # String | specify the branch to use
502
502
  sort: 'updated_at', # String | Sort by field. Can be one of: name, created_at, updated_at.
503
503
  order: 'desc', # String | Order direction. Can be one of: asc, desc.
504
- q: 'mykey* translated:true', # String | Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes</li> <li><code>tags:tag_name</code> to filter for keys with certain tags</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
504
+ q: 'mykey* translated:true', # String | Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name,...</code> for text queries on a comma-seperated list of exact key names - spaces, commas, and colons need to be escaped with double backslashes</li> <li><code>tags:tag_name,...</code> to filter for keys with certain comma-seperated list of tags</li> <li><code>uploads:upload_id,...</code> to filter for keys with certain comma-seperated list of uploads</li> <li><code>job:{true|false}</code> to filter for keys mentioned in an active job</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at:{&gt;=|&lt;=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
505
505
  locale_id: 'abcd1234abcd1234abcd1234abcd1234' # String | Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
506
506
  }
507
507
 
@@ -526,7 +526,7 @@ Name | Type | Description | Notes
526
526
  **branch** | **String**| specify the branch to use | [optional]
527
527
  **sort** | **String**| Sort by field. Can be one of: name, created_at, updated_at. | [optional]
528
528
  **order** | **String**| Order direction. Can be one of: asc, desc. | [optional]
529
- **q** | **String**| Specify a query to do broad search for keys by name (including wildcards).&lt;br&gt;&lt;br&gt; The following qualifiers are also supported in the search term:&lt;br&gt; &lt;ul&gt; &lt;li&gt;&lt;code&gt;ids:key_id,...&lt;/code&gt; for queries on a comma-separated list of ids&lt;/li&gt; &lt;li&gt;&lt;code&gt;name:key_name&lt;/code&gt; for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes&lt;/li&gt; &lt;li&gt;&lt;code&gt;tags:tag_name&lt;/code&gt; to filter for keys with certain tags&lt;/li&gt; &lt;li&gt;&lt;code&gt;translated:{true|false}&lt;/code&gt; for translation status (also requires &lt;code&gt;locale_id&lt;/code&gt; to be specified)&lt;/li&gt; &lt;li&gt;&lt;code&gt;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&lt;/code&gt; for date range queries&lt;/li&gt; &lt;li&gt;&lt;code&gt;unmentioned_in_upload:upload_id&lt;/code&gt; to filter keys unmentioned within upload&lt;/li&gt; &lt;/ul&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;. | [optional]
529
+ **q** | **String**| Specify a query to do broad search for keys by name (including wildcards).&lt;br&gt;&lt;br&gt; The following qualifiers are also supported in the search term:&lt;br&gt; &lt;ul&gt; &lt;li&gt;&lt;code&gt;ids:key_id,...&lt;/code&gt; for queries on a comma-separated list of ids&lt;/li&gt; &lt;li&gt;&lt;code&gt;name:key_name,...&lt;/code&gt; for text queries on a comma-seperated list of exact key names - spaces, commas, and colons need to be escaped with double backslashes&lt;/li&gt; &lt;li&gt;&lt;code&gt;tags:tag_name,...&lt;/code&gt; to filter for keys with certain comma-seperated list of tags&lt;/li&gt; &lt;li&gt;&lt;code&gt;uploads:upload_id,...&lt;/code&gt; to filter for keys with certain comma-seperated list of uploads&lt;/li&gt; &lt;li&gt;&lt;code&gt;job:{true|false}&lt;/code&gt; to filter for keys mentioned in an active job&lt;/li&gt; &lt;li&gt;&lt;code&gt;translated:{true|false}&lt;/code&gt; for translation status (also requires &lt;code&gt;locale_id&lt;/code&gt; to be specified)&lt;/li&gt; &lt;li&gt;&lt;code&gt;updated_at:{&amp;gt;&#x3D;|&amp;lt;&#x3D;}2013-02-21T00:00:00Z&lt;/code&gt; for date range queries&lt;/li&gt; &lt;li&gt;&lt;code&gt;unmentioned_in_upload:upload_id&lt;/code&gt; to filter keys unmentioned within upload&lt;/li&gt; &lt;/ul&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;. | [optional]
530
530
  **locale_id** | **String**| Locale used to determine the translation state of a key when filtering for untranslated or translated keys. | [optional]
531
531
 
532
532
  ### Return type
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
7
7
  **branch** | **String** | specify the branch to use | [optional]
8
8
  **sort** | **String** | Sort by field. Can be one of: name, created_at, updated_at. | [optional]
9
9
  **order** | **String** | Order direction. Can be one of: asc, desc. | [optional]
10
- **q** | **String** | Specify a query to do broad search for keys by name (including wildcards).&lt;br&gt;&lt;br&gt; The following qualifiers are also supported in the search term:&lt;br&gt; &lt;ul&gt; &lt;li&gt;&lt;code&gt;ids:key_id,...&lt;/code&gt; for queries on a comma-separated list of ids&lt;/li&gt; &lt;li&gt;&lt;code&gt;name:key_name&lt;/code&gt; for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes&lt;/li&gt; &lt;li&gt;&lt;code&gt;tags:tag_name&lt;/code&gt; to filter for keys with certain tags&lt;/li&gt; &lt;li&gt;&lt;code&gt;translated:{true|false}&lt;/code&gt; for translation status (also requires &lt;code&gt;locale_id&lt;/code&gt; to be specified)&lt;/li&gt; &lt;li&gt;&lt;code&gt;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&lt;/code&gt; for date range queries&lt;/li&gt; &lt;li&gt;&lt;code&gt;unmentioned_in_upload:upload_id&lt;/code&gt; to filter keys unmentioned within upload&lt;/li&gt; &lt;/ul&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;. Please note: If &lt;code&gt;tags&lt;/code&gt; are added to filter the search, the search will be limited to a maximum of 65,536 tagged keys. | [optional]
10
+ **q** | **String** | Specify a query to do broad search for keys by name (including wildcards).&lt;br&gt;&lt;br&gt; The following qualifiers are also supported in the search term:&lt;br&gt; &lt;ul&gt; &lt;li&gt;&lt;code&gt;ids:key_id,...&lt;/code&gt; for queries on a comma-separated list of ids&lt;/li&gt; &lt;li&gt;&lt;code&gt;name:key_name,...&lt;/code&gt; for text queries on a comma-seperated list of exact key names - spaces, commas, and colons need to be escaped with double backslashes&lt;/li&gt; &lt;li&gt;&lt;code&gt;tags:tag_name,...&lt;/code&gt; to filter for keys with certain comma-seperated list of tags&lt;/li&gt; &lt;li&gt;&lt;code&gt;uploads:upload_id,...&lt;/code&gt; to filter for keys with certain comma-seperated list of uploads&lt;/li&gt; &lt;li&gt;&lt;code&gt;job:{true|false}&lt;/code&gt; to filter for keys mentioned in an active job&lt;/li&gt; &lt;li&gt;&lt;code&gt;translated:{true|false}&lt;/code&gt; for translation status (also requires &lt;code&gt;locale_id&lt;/code&gt; to be specified)&lt;/li&gt; &lt;li&gt;&lt;code&gt;updated_at:{&amp;gt;&#x3D;|&amp;lt;&#x3D;}2013-02-21T00:00:00Z&lt;/code&gt; for date range queries&lt;/li&gt; &lt;li&gt;&lt;code&gt;unmentioned_in_upload:upload_id&lt;/code&gt; to filter keys unmentioned within upload&lt;/li&gt; &lt;/ul&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;. Please note: If &lt;code&gt;tags&lt;/code&gt; are added to filter the search, the search will be limited to a maximum of 65,536 tagged keys. | [optional]
11
11
  **locale_id** | **String** | Locale used to determine the translation state of a key when filtering for untranslated or translated keys. | [optional]
12
12
 
13
13
  ## Code Sample
@@ -0,0 +1,43 @@
1
+ # Phrase::LocaleReport
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **keys_count** | **Integer** | | [optional]
8
+ **translated_translations_percentage** | **Integer** | | [optional]
9
+ **unverified_translations_percentage** | **Integer** | | [optional]
10
+ **reviewed_translations_percentage** | **Integer** | | [optional]
11
+ **untranslated_keys_percentage** | **Integer** | | [optional]
12
+ **completed_translations_count** | **Integer** | | [optional]
13
+ **untranslated_keys_count** | **Integer** | | [optional]
14
+ **unverified_translations_count** | **Integer** | | [optional]
15
+ **reviewed_translations_count** | **Integer** | | [optional]
16
+ **source_word_count** | **Integer** | | [optional]
17
+ **word_count** | **Integer** | | [optional]
18
+ **word_count_unverified** | **Integer** | | [optional]
19
+ **word_count_missing** | **Integer** | | [optional]
20
+ **locale** | [**LocalePreview**](LocalePreview.md) | | [optional]
21
+
22
+ ## Code Sample
23
+
24
+ ```ruby
25
+ require 'Phrase'
26
+
27
+ instance = Phrase::LocaleReport.new(keys_count: null,
28
+ translated_translations_percentage: null,
29
+ unverified_translations_percentage: null,
30
+ reviewed_translations_percentage: null,
31
+ untranslated_keys_percentage: null,
32
+ completed_translations_count: null,
33
+ untranslated_keys_count: null,
34
+ unverified_translations_count: null,
35
+ reviewed_translations_count: null,
36
+ source_word_count: null,
37
+ word_count: null,
38
+ word_count_unverified: null,
39
+ word_count_missing: null,
40
+ locale: null)
41
+ ```
42
+
43
+
data/docs/LocalesApi.md CHANGED
@@ -252,7 +252,8 @@ opts = {
252
252
  include_unverified_translations: true, # Boolean | if set to false unverified translations are excluded
253
253
  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.
254
254
  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>.
255
- 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.
255
+ 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.
256
+ 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.
256
257
  }
257
258
 
258
259
  begin
@@ -290,6 +291,7 @@ Name | Type | Description | Notes
290
291
  **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]
291
292
  **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]
292
293
  **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]
294
+ **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]
293
295
 
294
296
  ### Return type
295
297
 
@@ -40,7 +40,7 @@ instance = Phrase::ProjectCreateParameters.new(name: My Android Project,
40
40
  main_format: yml,
41
41
  media: Python,
42
42
  shares_translation_memory: true,
43
- project_image: [B@323b4e2a,
43
+ project_image: [B@47b8e2,
44
44
  remove_project_image: null,
45
45
  account_id: abcd1234,
46
46
  point_of_contact: abcd1234,
@@ -0,0 +1,31 @@
1
+ # Phrase::ProjectReport
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **locales_count** | **Integer** | | [optional]
8
+ **keys_count** | **Integer** | | [optional]
9
+ **translations_count** | **Integer** | | [optional]
10
+ **untranslated_keys_count** | **Integer** | | [optional]
11
+ **unverified_translations_count** | **Integer** | | [optional]
12
+ **reviewed_translations_count** | **Integer** | | [optional]
13
+ **managed_words_count** | **Integer** | | [optional]
14
+ **project** | [**ProjectShort**](ProjectShort.md) | | [optional]
15
+
16
+ ## Code Sample
17
+
18
+ ```ruby
19
+ require 'Phrase'
20
+
21
+ instance = Phrase::ProjectReport.new(locales_count: null,
22
+ keys_count: null,
23
+ translations_count: null,
24
+ untranslated_keys_count: null,
25
+ unverified_translations_count: null,
26
+ reviewed_translations_count: null,
27
+ managed_words_count: null,
28
+ project: null)
29
+ ```
30
+
31
+
@@ -41,7 +41,7 @@ instance = Phrase::ProjectUpdateParameters.new(account_id: abcd1234,
41
41
  main_format: yml,
42
42
  media: Python,
43
43
  shares_translation_memory: true,
44
- project_image: [B@6a79a909,
44
+ project_image: [B@2ba8f528,
45
45
  remove_project_image: false,
46
46
  workflow: review,
47
47
  machine_translation_enabled: true,
@@ -0,0 +1,21 @@
1
+ # Phrase::ProjectsQualityPerformanceScore200Response
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **error** | [**ErrorError**](ErrorError.md) | | [optional]
8
+ **data** | [**ProjectsQualityPerformanceScore200ResponseAnyOfData**](ProjectsQualityPerformanceScore200ResponseAnyOfData.md) | | [optional]
9
+ **errors** | [**Array&lt;ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner&gt;**](ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner.md) | Array of errors for any failing translation ids | [optional]
10
+
11
+ ## Code Sample
12
+
13
+ ```ruby
14
+ require 'Phrase'
15
+
16
+ instance = Phrase::ProjectsQualityPerformanceScore200Response.new(error: null,
17
+ data: null,
18
+ errors: null)
19
+ ```
20
+
21
+
@@ -0,0 +1,19 @@
1
+ # Phrase::ProjectsQualityPerformanceScore200ResponseAnyOf
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **data** | [**ProjectsQualityPerformanceScore200ResponseAnyOfData**](ProjectsQualityPerformanceScore200ResponseAnyOfData.md) | | [optional]
8
+ **errors** | [**Array&lt;ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner&gt;**](ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner.md) | Array of errors for any failing translation ids | [optional]
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'Phrase'
14
+
15
+ instance = Phrase::ProjectsQualityPerformanceScore200ResponseAnyOf.new(data: null,
16
+ errors: null)
17
+ ```
18
+
19
+
@@ -0,0 +1,17 @@
1
+ # Phrase::ProjectsQualityPerformanceScore200ResponseAnyOfData
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **translations** | [**Array&lt;ProjectsQualityPerformanceScore200ResponseAnyOfDataTranslationsInner&gt;**](ProjectsQualityPerformanceScore200ResponseAnyOfDataTranslationsInner.md) | | [optional]
8
+
9
+ ## Code Sample
10
+
11
+ ```ruby
12
+ require 'Phrase'
13
+
14
+ instance = Phrase::ProjectsQualityPerformanceScore200ResponseAnyOfData.new(translations: null)
15
+ ```
16
+
17
+
@@ -0,0 +1,21 @@
1
+ # Phrase::ProjectsQualityPerformanceScore200ResponseAnyOfDataTranslationsInner
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **engine** | **String** | Engine used for the translation scoring | [optional]
8
+ **score** | **Float** | Quality score for the translation | [optional]
9
+ **id** | **String** | One of the translation ids passed in arguments | [optional]
10
+
11
+ ## Code Sample
12
+
13
+ ```ruby
14
+ require 'Phrase'
15
+
16
+ instance = Phrase::ProjectsQualityPerformanceScore200ResponseAnyOfDataTranslationsInner.new(engine: null,
17
+ score: null,
18
+ id: null)
19
+ ```
20
+
21
+
@@ -0,0 +1,21 @@
1
+ # Phrase::ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **message** | **String** | | [optional]
8
+ **code** | **String** | | [optional]
9
+ **id** | **String** | One of the translation ids passed in arguments | [optional]
10
+
11
+ ## Code Sample
12
+
13
+ ```ruby
14
+ require 'Phrase'
15
+
16
+ instance = Phrase::ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner.new(message: null,
17
+ code: null,
18
+ id: null)
19
+ ```
20
+
21
+
@@ -0,0 +1,17 @@
1
+ # Phrase::ProjectsQualityPerformanceScoreRequest
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **translation_ids** | **Array&lt;String&gt;** | Translation ids you want to get the quality performance score for | [optional]
8
+
9
+ ## Code Sample
10
+
11
+ ```ruby
12
+ require 'Phrase'
13
+
14
+ instance = Phrase::ProjectsQualityPerformanceScoreRequest.new(translation_ids: null)
15
+ ```
16
+
17
+
@@ -0,0 +1,72 @@
1
+ # Phrase::QualityPerformanceScoreApi
2
+
3
+ All URIs are relative to *https://api.phrase.com/v2*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**projects_quality_performance_score**](QualityPerformanceScoreApi.md#projects_quality_performance_score) | **POST** /projects/{id}/quality_performance_score | Get project&#39;s translations&#39; quality performance scores
8
+
9
+
10
+
11
+ ## projects_quality_performance_score
12
+
13
+ > ProjectsQualityPerformanceScore200Response projects_quality_performance_score(id, projects_quality_performance_score_request, opts)
14
+
15
+ Get project's translations' quality performance scores
16
+
17
+ Get project's translations' quality performance scores
18
+
19
+ ### Example
20
+
21
+ ```ruby
22
+ # load the gem
23
+ require 'phrase'
24
+ # setup authorization
25
+ Phrase.configure do |config|
26
+ # Configure HTTP basic authorization: Basic
27
+ config.username = 'YOUR USERNAME'
28
+ config.password = 'YOUR PASSWORD'
29
+
30
+ # Configure API key authorization: Token
31
+ config.api_key['Authorization'] = 'YOUR API KEY'
32
+ config.api_key_prefix['Authorization'] = 'token'
33
+ end
34
+
35
+ api_instance = Phrase::QualityPerformanceScoreApi.new
36
+ id = 'id_example' # String | ID
37
+ projects_quality_performance_score_request = Phrase::ProjectsQualityPerformanceScoreRequest.new # ProjectsQualityPerformanceScoreRequest |
38
+ opts = {
39
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
40
+ }
41
+
42
+ begin
43
+ #Get project's translations' quality performance scores
44
+ result = api_instance.projects_quality_performance_score(id, projects_quality_performance_score_request, opts)
45
+ pp result
46
+ rescue Phrase::ApiError => e
47
+ puts "Exception when calling QualityPerformanceScoreApi->projects_quality_performance_score: #{e}"
48
+ end
49
+ ```
50
+
51
+ ### Parameters
52
+
53
+
54
+ Name | Type | Description | Notes
55
+ ------------- | ------------- | ------------- | -------------
56
+ **id** | **String**| ID |
57
+ **projects_quality_performance_score_request** | [**ProjectsQualityPerformanceScoreRequest**](ProjectsQualityPerformanceScoreRequest.md)| |
58
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
59
+
60
+ ### Return type
61
+
62
+ Response<([**ProjectsQualityPerformanceScore200Response**](ProjectsQualityPerformanceScore200Response.md))>
63
+
64
+ ### Authorization
65
+
66
+ [Basic](../README.md#Basic), [Token](../README.md#Token)
67
+
68
+ ### HTTP request headers
69
+
70
+ - **Content-Type**: application/json
71
+ - **Accept**: application/json
72
+
@@ -0,0 +1,144 @@
1
+ # Phrase::ReportsApi
2
+
3
+ All URIs are relative to *https://api.phrase.com/v2*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**report_locales_list**](ReportsApi.md#report_locales_list) | **GET** /projects/{project_id}/report/locales | List Locale Reports
8
+ [**report_show**](ReportsApi.md#report_show) | **GET** /projects/{project_id}/report | Get Project Report
9
+
10
+
11
+
12
+ ## report_locales_list
13
+
14
+ > Array&lt;LocaleReport&gt; report_locales_list(project_id, opts)
15
+
16
+ List Locale Reports
17
+
18
+ List all locale reports for the given project
19
+
20
+ ### Example
21
+
22
+ ```ruby
23
+ # load the gem
24
+ require 'phrase'
25
+ # setup authorization
26
+ Phrase.configure do |config|
27
+ # Configure HTTP basic authorization: Basic
28
+ config.username = 'YOUR USERNAME'
29
+ config.password = 'YOUR PASSWORD'
30
+
31
+ # Configure API key authorization: Token
32
+ config.api_key['Authorization'] = 'YOUR API KEY'
33
+ config.api_key_prefix['Authorization'] = 'token'
34
+ end
35
+
36
+ api_instance = Phrase::ReportsApi.new
37
+ project_id = 'project_id_example' # String | Project ID
38
+ opts = {
39
+ x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
40
+ page: 1, # Integer | Page number
41
+ per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
42
+ locale_codes: 'locale_codes_example', # String | Locale Code
43
+ tag: 'tag_example', # String | tag
44
+ branch: 'my-feature-branch' # String | specify the branch to use
45
+ }
46
+
47
+ begin
48
+ #List Locale Reports
49
+ result = api_instance.report_locales_list(project_id, opts)
50
+ pp result
51
+ rescue Phrase::ApiError => e
52
+ puts "Exception when calling ReportsApi->report_locales_list: #{e}"
53
+ end
54
+ ```
55
+
56
+ ### Parameters
57
+
58
+
59
+ Name | Type | Description | Notes
60
+ ------------- | ------------- | ------------- | -------------
61
+ **project_id** | **String**| Project ID |
62
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
63
+ **page** | **Integer**| Page number | [optional]
64
+ **per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
65
+ **locale_codes** | **String**| Locale Code | [optional]
66
+ **tag** | **String**| tag | [optional]
67
+ **branch** | **String**| specify the branch to use | [optional]
68
+
69
+ ### Return type
70
+
71
+ Response<([**Array&lt;LocaleReport&gt;**](LocaleReport.md))>
72
+
73
+ ### Authorization
74
+
75
+ [Basic](../README.md#Basic), [Token](../README.md#Token)
76
+
77
+ ### HTTP request headers
78
+
79
+ - **Content-Type**: Not defined
80
+ - **Accept**: application/json
81
+
82
+
83
+ ## report_show
84
+
85
+ > ProjectReport report_show(project_id, opts)
86
+
87
+ Get Project Report
88
+
89
+ Get report of a single project.
90
+
91
+ ### Example
92
+
93
+ ```ruby
94
+ # load the gem
95
+ require 'phrase'
96
+ # setup authorization
97
+ Phrase.configure do |config|
98
+ # Configure HTTP basic authorization: Basic
99
+ config.username = 'YOUR USERNAME'
100
+ config.password = 'YOUR PASSWORD'
101
+
102
+ # Configure API key authorization: Token
103
+ config.api_key['Authorization'] = 'YOUR API KEY'
104
+ config.api_key_prefix['Authorization'] = 'token'
105
+ end
106
+
107
+ api_instance = Phrase::ReportsApi.new
108
+ project_id = 'project_id_example' # String | Project ID
109
+ opts = {
110
+ x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
111
+ branch: 'my-feature-branch' # String | specify the branch to use
112
+ }
113
+
114
+ begin
115
+ #Get Project Report
116
+ result = api_instance.report_show(project_id, opts)
117
+ pp result
118
+ rescue Phrase::ApiError => e
119
+ puts "Exception when calling ReportsApi->report_show: #{e}"
120
+ end
121
+ ```
122
+
123
+ ### Parameters
124
+
125
+
126
+ Name | Type | Description | Notes
127
+ ------------- | ------------- | ------------- | -------------
128
+ **project_id** | **String**| Project ID |
129
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
130
+ **branch** | **String**| specify the branch to use | [optional]
131
+
132
+ ### Return type
133
+
134
+ Response<([**ProjectReport**](ProjectReport.md))>
135
+
136
+ ### Authorization
137
+
138
+ [Basic](../README.md#Basic), [Token](../README.md#Token)
139
+
140
+ ### HTTP request headers
141
+
142
+ - **Content-Type**: Not defined
143
+ - **Accept**: application/json
144
+
@@ -17,7 +17,7 @@ require 'Phrase'
17
17
  instance = Phrase::ScreenshotUpdateParameters.new(branch: my-feature-branch,
18
18
  name: A screenshot name,
19
19
  description: A screenshot description,
20
- filename: [B@76d404ab)
20
+ filename: [B@66009368)
21
21
  ```
22
22
 
23
23
 
@@ -22,6 +22,7 @@ Name | Type | Description | Notes
22
22
  **original_file** | **String** | | [optional]
23
23
  **format_value_type** | **String** | | [optional]
24
24
  **creator** | [**UserPreview**](UserPreview.md) | | [optional]
25
+ **custom_metadata** | **Hash&lt;String, String&gt;** | | [optional]
25
26
 
26
27
  ## Code Sample
27
28
 
@@ -45,7 +46,8 @@ instance = Phrase::TranslationKeyDetails.new(id: null,
45
46
  xml_space_preserve: null,
46
47
  original_file: null,
47
48
  format_value_type: null,
48
- creator: null)
49
+ creator: null,
50
+ custom_metadata: null)
49
51
  ```
50
52
 
51
53
 
data/docs/Upload.md CHANGED
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
9
9
  **format** | **String** | | [optional]
10
10
  **state** | **String** | | [optional]
11
11
  **tag** | **String** | | [optional]
12
+ **url** | **String** | The URL to the upload in Phrase Strings app. | [optional]
12
13
  **summary** | [**UploadSummary**](UploadSummary.md) | | [optional]
13
14
  **created_at** | **Time** | | [optional]
14
15
  **updated_at** | **Time** | | [optional]
@@ -23,6 +24,7 @@ instance = Phrase::Upload.new(id: null,
23
24
  format: null,
24
25
  state: null,
25
26
  tag: null,
27
+ url: null,
26
28
  summary: null,
27
29
  created_at: null,
28
30
  updated_at: null)