phrase 2.21.0 → 2.22.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (47) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +12 -0
  3. data/README.md +14 -3
  4. data/docs/CustomMetadataApi.md +12 -26
  5. data/docs/CustomMetadataPropertiesCreateParameters.md +25 -0
  6. data/docs/CustomMetadataPropertiesUpdateParameters.md +23 -0
  7. data/docs/Error.md +17 -0
  8. data/docs/ErrorError.md +19 -0
  9. data/docs/KeyCreateParameters.md +1 -1
  10. data/docs/KeyUpdateParameters.md +1 -1
  11. data/docs/ProjectCreateParameters.md +1 -1
  12. data/docs/ProjectUpdateParameters.md +1 -1
  13. data/docs/ProjectsQualityPerformanceScore200Response.md +21 -0
  14. data/docs/ProjectsQualityPerformanceScore200ResponseAnyOf.md +19 -0
  15. data/docs/ProjectsQualityPerformanceScore200ResponseAnyOfData.md +17 -0
  16. data/docs/ProjectsQualityPerformanceScore200ResponseAnyOfDataTranslationsInner.md +21 -0
  17. data/docs/ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner.md +21 -0
  18. data/docs/ProjectsQualityPerformanceScoreRequest.md +17 -0
  19. data/docs/QualityPerformanceScoreApi.md +72 -0
  20. data/docs/ScreenshotUpdateParameters.md +1 -1
  21. data/lib/phrase/api/custom_metadata_api.rb +23 -42
  22. data/lib/phrase/api/quality_performance_score_api.rb +84 -0
  23. data/lib/phrase/models/custom_metadata_properties_create_parameters.rb +272 -0
  24. data/lib/phrase/models/custom_metadata_properties_update_parameters.rb +231 -0
  25. data/lib/phrase/models/error.rb +197 -0
  26. data/lib/phrase/models/error_error.rb +205 -0
  27. data/lib/phrase/models/projects_quality_performance_score200_response.rb +237 -0
  28. data/lib/phrase/models/projects_quality_performance_score200_response_any_of.rb +208 -0
  29. data/lib/phrase/models/projects_quality_performance_score200_response_any_of_data.rb +198 -0
  30. data/lib/phrase/models/projects_quality_performance_score200_response_any_of_data_translations_inner.rb +217 -0
  31. data/lib/phrase/models/projects_quality_performance_score200_response_any_of_errors_inner.rb +215 -0
  32. data/lib/phrase/models/projects_quality_performance_score_request.rb +199 -0
  33. data/lib/phrase/version.rb +1 -1
  34. data/lib/phrase.rb +11 -0
  35. data/spec/api/custom_metadata_api_spec.rb +2 -9
  36. data/spec/api/quality_performance_score_api_spec.rb +37 -0
  37. data/spec/models/custom_metadata_properties_create_parameters_spec.rb +53 -0
  38. data/spec/models/custom_metadata_properties_update_parameters_spec.rb +47 -0
  39. data/spec/models/error_error_spec.rb +35 -0
  40. data/spec/models/error_spec.rb +29 -0
  41. data/spec/models/projects_quality_performance_score200_response_any_of_data_spec.rb +29 -0
  42. data/spec/models/projects_quality_performance_score200_response_any_of_data_translations_inner_spec.rb +41 -0
  43. data/spec/models/projects_quality_performance_score200_response_any_of_errors_inner_spec.rb +41 -0
  44. data/spec/models/projects_quality_performance_score200_response_any_of_spec.rb +35 -0
  45. data/spec/models/projects_quality_performance_score200_response_spec.rb +41 -0
  46. data/spec/models/projects_quality_performance_score_request_spec.rb +29 -0
  47. metadata +259 -215
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 3c9e6602de1415c1ef4c28f729079cfa70e3f7992c3ced10ddeb96dd0ec10bf0
4
- data.tar.gz: 0b006707561ed1522bff7b484579578810f96104a29cdb30e4578a70b7f7ee31
3
+ metadata.gz: d9a84cd82f9a8d6fd584b5a80e84f6bd3ea5985d5f20bfb478c087d173b366d4
4
+ data.tar.gz: '09389e6cec783b90b06441c89f0fdace5b5bd57d9d41613c0c944387e7accab1'
5
5
  SHA512:
6
- metadata.gz: 171702d0e6a75af786cbcbec72029688b9904c67aff83acdd156c8b1e5b9f8620bcfb6f36c6299cfb2733db8ebd38dd1ab4a58feafbfa112ab6008796ad3fc24
7
- data.tar.gz: 868b4c03c4e83a9feeaa217996125fd76c17ce4a5982c6afcb23740cd5a83f0ed8a81e56105f6950c0cca62df06e5b0d5a0727d0d279f8b6edbc6a1b6fb56e75
6
+ metadata.gz: 8af8b703cf40ed059efd4fe0b9b647071aa37f224c1c4b9dafc062202be70e28faa1db794830d9d69ec0782c653bddad658f118d8154ad809f9b0883410a4da1
7
+ data.tar.gz: bc1cafa20a7f9d9196d96a8e13c092531f6f511b25788982012b10176b285e9c00d126e3a21a9309585078e8a7ebe7ef0cf4231a005825cdf8a8b85450b20dc9
data/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # Changelog
2
2
 
3
+ ## [2.22.0](https://github.com/phrase/openapi/compare/ruby-v2.21.0...ruby-v2.22.0) (2024-01-17)
4
+
5
+
6
+ ### Features
7
+
8
+ * **api:** Add QPS endpoint and documentation ([#521](https://github.com/phrase/openapi/issues/521)) ([d22c558](https://github.com/phrase/openapi/commit/d22c558adfbb7fcd13759e388c038744914e42fa))
9
+
10
+
11
+ ### Bug Fixes
12
+
13
+ * **API:** Create Custom Metadata endpoint fix [TSI-2222] ([#499](https://github.com/phrase/openapi/issues/499)) ([ce2ed94](https://github.com/phrase/openapi/commit/ce2ed9488e111fb5d9bc3810a78c47d23553c8b7))
14
+
3
15
  ## [2.21.0](https://github.com/phrase/openapi/compare/ruby-v2.20.0...ruby-v2.21.0) (2023-12-13)
4
16
 
5
17
 
data/README.md CHANGED
@@ -7,7 +7,7 @@ Phrase Strings is a translation management platform for software projects. You c
7
7
  ## This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
8
 
9
9
  - API version: 2.0.0
10
- - Package version: 2.21.0
10
+ - Package version: 2.22.0
11
11
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
12
12
  For more information, please visit [https://developers.phrase.com/api/](https://developers.phrase.com/api/)
13
13
 
@@ -56,10 +56,10 @@ gem build phrase.gemspec
56
56
  Then install the gem locally:
57
57
 
58
58
  ```shell
59
- gem install ./phrase-2.21.0.gem
59
+ gem install ./phrase-2.22.0.gem
60
60
  ```
61
61
 
62
- (for development, run `gem install --dev ./phrase-2.21.0.gem` to install the development dependencies)
62
+ (for development, run `gem install --dev ./phrase-2.22.0.gem` to install the development dependencies)
63
63
 
64
64
  ## Getting Started
65
65
 
@@ -305,6 +305,7 @@ Class | Method | HTTP request | Description
305
305
  *Phrase::ProjectsApi* | [**project_show**](docs/ProjectsApi.md#project_show) | **GET** /projects/{id} | Get a single project
306
306
  *Phrase::ProjectsApi* | [**project_update**](docs/ProjectsApi.md#project_update) | **PATCH** /projects/{id} | Update a project
307
307
  *Phrase::ProjectsApi* | [**projects_list**](docs/ProjectsApi.md#projects_list) | **GET** /projects | List projects
308
+ *Phrase::QualityPerformanceScoreApi* | [**projects_quality_performance_score**](docs/QualityPerformanceScoreApi.md#projects_quality_performance_score) | **POST** /projects/{id}/quality_performance_score | Get project's translations' quality performance scores
308
309
  *Phrase::ReleasesApi* | [**release_create**](docs/ReleasesApi.md#release_create) | **POST** /accounts/{account_id}/distributions/{distribution_id}/releases | Create a release
309
310
  *Phrase::ReleasesApi* | [**release_delete**](docs/ReleasesApi.md#release_delete) | **DELETE** /accounts/{account_id}/distributions/{distribution_id}/releases/{id} | Delete a release
310
311
  *Phrase::ReleasesApi* | [**release_publish**](docs/ReleasesApi.md#release_publish) | **POST** /accounts/{account_id}/distributions/{distribution_id}/releases/{id}/publish | Publish a release
@@ -422,6 +423,8 @@ Class | Method | HTTP request | Description
422
423
  - [Phrase::CommentsListParameters](docs/CommentsListParameters.md)
423
424
  - [Phrase::CurrentUser](docs/CurrentUser.md)
424
425
  - [Phrase::CustomMetadataDataType](docs/CustomMetadataDataType.md)
426
+ - [Phrase::CustomMetadataPropertiesCreateParameters](docs/CustomMetadataPropertiesCreateParameters.md)
427
+ - [Phrase::CustomMetadataPropertiesUpdateParameters](docs/CustomMetadataPropertiesUpdateParameters.md)
425
428
  - [Phrase::CustomMetadataProperty](docs/CustomMetadataProperty.md)
426
429
  - [Phrase::CustomMetadataPropertyCreate422Response](docs/CustomMetadataPropertyCreate422Response.md)
427
430
  - [Phrase::CustomMetadataPropertyCreate422ResponseErrorsInner](docs/CustomMetadataPropertyCreate422ResponseErrorsInner.md)
@@ -430,6 +433,8 @@ Class | Method | HTTP request | Description
430
433
  - [Phrase::DistributionPreview](docs/DistributionPreview.md)
431
434
  - [Phrase::DistributionUpdateParameters](docs/DistributionUpdateParameters.md)
432
435
  - [Phrase::Document](docs/Document.md)
436
+ - [Phrase::Error](docs/Error.md)
437
+ - [Phrase::ErrorError](docs/ErrorError.md)
433
438
  - [Phrase::FigmaAttachment](docs/FigmaAttachment.md)
434
439
  - [Phrase::FigmaAttachmentCreateParameters](docs/FigmaAttachmentCreateParameters.md)
435
440
  - [Phrase::FigmaAttachmentUpdateParameters](docs/FigmaAttachmentUpdateParameters.md)
@@ -525,6 +530,12 @@ Class | Method | HTTP request | Description
525
530
  - [Phrase::ProjectReport](docs/ProjectReport.md)
526
531
  - [Phrase::ProjectShort](docs/ProjectShort.md)
527
532
  - [Phrase::ProjectUpdateParameters](docs/ProjectUpdateParameters.md)
533
+ - [Phrase::ProjectsQualityPerformanceScore200Response](docs/ProjectsQualityPerformanceScore200Response.md)
534
+ - [Phrase::ProjectsQualityPerformanceScore200ResponseAnyOf](docs/ProjectsQualityPerformanceScore200ResponseAnyOf.md)
535
+ - [Phrase::ProjectsQualityPerformanceScore200ResponseAnyOfData](docs/ProjectsQualityPerformanceScore200ResponseAnyOfData.md)
536
+ - [Phrase::ProjectsQualityPerformanceScore200ResponseAnyOfDataTranslationsInner](docs/ProjectsQualityPerformanceScore200ResponseAnyOfDataTranslationsInner.md)
537
+ - [Phrase::ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner](docs/ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner.md)
538
+ - [Phrase::ProjectsQualityPerformanceScoreRequest](docs/ProjectsQualityPerformanceScoreRequest.md)
528
539
  - [Phrase::Release](docs/Release.md)
529
540
  - [Phrase::ReleaseCreateParameters](docs/ReleaseCreateParameters.md)
530
541
  - [Phrase::ReleasePreview](docs/ReleasePreview.md)
@@ -149,7 +149,7 @@ Response<([**Array&lt;CustomMetadataProperty&gt;**](CustomMetadataProperty.md))>
149
149
 
150
150
  ## custom_metadata_property_create
151
151
 
152
- > CustomMetadataProperty custom_metadata_property_create(account_id, name, data_type, opts)
152
+ > CustomMetadataProperty custom_metadata_property_create(account_id, custom_metadata_properties_create_parameters, opts)
153
153
 
154
154
  Create a property
155
155
 
@@ -173,18 +173,14 @@ end
173
173
 
174
174
  api_instance = Phrase::CustomMetadataApi.new
175
175
  account_id = 'account_id_example' # String | Account ID
176
- name = '["Fruit"]' # String | name of the property
177
- data_type = Phrase::CustomMetadataDataType::BOOLEAN # CustomMetadataDataType | Data Type of Custom Metadata Property
176
+ custom_metadata_properties_create_parameters = Phrase::CustomMetadataPropertiesCreateParameters.new({name: 'Fruit', data_type: Phrase::CustomMetadataDataType::BOOLEAN}) # CustomMetadataPropertiesCreateParameters |
178
177
  opts = {
179
- x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
180
- description: '["A healthy snack for all ages"]', # String | description of property
181
- project_ids: ['inner_example'], # Array<String> | ids of projects that the property belongs to
182
- value_options: ['inner_example'] # Array<String> | value options of property (only applies to single or multi select properties)
178
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
183
179
  }
184
180
 
185
181
  begin
186
182
  #Create a property
187
- result = api_instance.custom_metadata_property_create(account_id, name, data_type, opts)
183
+ result = api_instance.custom_metadata_property_create(account_id, custom_metadata_properties_create_parameters, opts)
188
184
  pp result
189
185
  rescue Phrase::ApiError => e
190
186
  puts "Exception when calling CustomMetadataApi->custom_metadata_property_create: #{e}"
@@ -197,12 +193,8 @@ end
197
193
  Name | Type | Description | Notes
198
194
  ------------- | ------------- | ------------- | -------------
199
195
  **account_id** | **String**| Account ID |
200
- **name** | **String**| name of the property |
201
- **data_type** | [**CustomMetadataDataType**](.md)| Data Type of Custom Metadata Property |
196
+ **custom_metadata_properties_create_parameters** | [**CustomMetadataPropertiesCreateParameters**](CustomMetadataPropertiesCreateParameters.md)| |
202
197
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
203
- **description** | **String**| description of property | [optional]
204
- **project_ids** | [**Array&lt;String&gt;**](String.md)| ids of projects that the property belongs to | [optional]
205
- **value_options** | [**Array&lt;String&gt;**](String.md)| value options of property (only applies to single or multi select properties) | [optional]
206
198
 
207
199
  ### Return type
208
200
 
@@ -214,7 +206,7 @@ Response<([**CustomMetadataProperty**](CustomMetadataProperty.md))>
214
206
 
215
207
  ### HTTP request headers
216
208
 
217
- - **Content-Type**: Not defined
209
+ - **Content-Type**: application/json
218
210
  - **Accept**: application/json
219
211
 
220
212
 
@@ -283,7 +275,7 @@ Response<([**CustomMetadataProperty**](CustomMetadataProperty.md))>
283
275
 
284
276
  ## custom_metadata_property_update
285
277
 
286
- > CustomMetadataProperty custom_metadata_property_update(account_id, id, opts)
278
+ > CustomMetadataProperty custom_metadata_property_update(account_id, id, custom_metadata_properties_update_parameters, opts)
287
279
 
288
280
  Update a property
289
281
 
@@ -308,17 +300,14 @@ end
308
300
  api_instance = Phrase::CustomMetadataApi.new
309
301
  account_id = 'account_id_example' # String | Account ID
310
302
  id = 'id_example' # String | ID
303
+ custom_metadata_properties_update_parameters = Phrase::CustomMetadataPropertiesUpdateParameters.new # CustomMetadataPropertiesUpdateParameters |
311
304
  opts = {
312
- x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
313
- name: '["Fruit"]', # String | name of the property
314
- description: '["A healthy snack for all ages"]', # String | description of property
315
- project_ids: ['inner_example'], # Array<String> | ids of projects that the property belongs to
316
- value_options: ['inner_example'] # Array<String> | value options of property (only applies to single or multi select properties)
305
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
317
306
  }
318
307
 
319
308
  begin
320
309
  #Update a property
321
- result = api_instance.custom_metadata_property_update(account_id, id, opts)
310
+ result = api_instance.custom_metadata_property_update(account_id, id, custom_metadata_properties_update_parameters, opts)
322
311
  pp result
323
312
  rescue Phrase::ApiError => e
324
313
  puts "Exception when calling CustomMetadataApi->custom_metadata_property_update: #{e}"
@@ -332,11 +321,8 @@ Name | Type | Description | Notes
332
321
  ------------- | ------------- | ------------- | -------------
333
322
  **account_id** | **String**| Account ID |
334
323
  **id** | **String**| ID |
324
+ **custom_metadata_properties_update_parameters** | [**CustomMetadataPropertiesUpdateParameters**](CustomMetadataPropertiesUpdateParameters.md)| |
335
325
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
336
- **name** | **String**| name of the property | [optional]
337
- **description** | **String**| description of property | [optional]
338
- **project_ids** | [**Array&lt;String&gt;**](String.md)| ids of projects that the property belongs to | [optional]
339
- **value_options** | [**Array&lt;String&gt;**](String.md)| value options of property (only applies to single or multi select properties) | [optional]
340
326
 
341
327
  ### Return type
342
328
 
@@ -348,6 +334,6 @@ Response<([**CustomMetadataProperty**](CustomMetadataProperty.md))>
348
334
 
349
335
  ### HTTP request headers
350
336
 
351
- - **Content-Type**: Not defined
337
+ - **Content-Type**: application/json
352
338
  - **Accept**: application/json
353
339
 
@@ -0,0 +1,25 @@
1
+ # Phrase::CustomMetadataPropertiesCreateParameters
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **name** | **String** | name of the property |
8
+ **data_type** | [**CustomMetadataDataType**](CustomMetadataDataType.md) | |
9
+ **project_ids** | **Array&lt;String&gt;** | ids of projects that the property belongs to | [optional]
10
+ **description** | **String** | description of property | [optional]
11
+ **value_options** | **Array&lt;String&gt;** | value options of property (only applies to single or multi select properties) | [optional]
12
+
13
+ ## Code Sample
14
+
15
+ ```ruby
16
+ require 'Phrase'
17
+
18
+ instance = Phrase::CustomMetadataPropertiesCreateParameters.new(name: Fruit,
19
+ data_type: null,
20
+ project_ids: [&quot;abcd1234cdef1234abcd1234cdef1234&quot;,&quot;abcd1234cdef1234abcd1234cdef4321&quot;],
21
+ description: A healthy snack for all ages,
22
+ value_options: [&quot;Apple&quot;,&quot;Banana&quot;,&quot;Coconut&quot;])
23
+ ```
24
+
25
+
@@ -0,0 +1,23 @@
1
+ # Phrase::CustomMetadataPropertiesUpdateParameters
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **name** | **String** | name of the property | [optional]
8
+ **project_ids** | **Array&lt;String&gt;** | ids of projects that the property belongs to | [optional]
9
+ **description** | **String** | description of property | [optional]
10
+ **value_options** | **Array&lt;String&gt;** | value options of property (only applies to single or multi select properties) | [optional]
11
+
12
+ ## Code Sample
13
+
14
+ ```ruby
15
+ require 'Phrase'
16
+
17
+ instance = Phrase::CustomMetadataPropertiesUpdateParameters.new(name: Fruit,
18
+ project_ids: [&quot;abcd1234cdef1234abcd1234cdef1234&quot;,&quot;abcd1234cdef1234abcd1234cdef4321&quot;],
19
+ description: A healthy snack for all ages,
20
+ value_options: [&quot;Apple&quot;,&quot;Banana&quot;,&quot;Coconut&quot;])
21
+ ```
22
+
23
+
data/docs/Error.md ADDED
@@ -0,0 +1,17 @@
1
+ # Phrase::Error
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **error** | [**ErrorError**](ErrorError.md) | | [optional]
8
+
9
+ ## Code Sample
10
+
11
+ ```ruby
12
+ require 'Phrase'
13
+
14
+ instance = Phrase::Error.new(error: null)
15
+ ```
16
+
17
+
@@ -0,0 +1,19 @@
1
+ # Phrase::ErrorError
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **message** | **String** | | [optional]
8
+ **code** | **String** | | [optional]
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'Phrase'
14
+
15
+ instance = Phrase::ErrorError.new(message: null,
16
+ code: null)
17
+ ```
18
+
19
+
@@ -35,7 +35,7 @@ instance = Phrase::KeyCreateParameters.new(branch: my-feature-branch,
35
35
  data_type: number,
36
36
  tags: awesome-feature,needs-proofreading,
37
37
  max_characters_allowed: 140,
38
- screenshot: [B@20865ff2,
38
+ screenshot: [B@5bbda7e2,
39
39
  remove_screenshot: null,
40
40
  unformatted: null,
41
41
  default_translation_content: Default translation content,
@@ -34,7 +34,7 @@ instance = Phrase::KeyUpdateParameters.new(branch: my-feature-branch,
34
34
  data_type: number,
35
35
  tags: awesome-feature,needs-proofreading,
36
36
  max_characters_allowed: 140,
37
- screenshot: [B@1a7c593b,
37
+ screenshot: [B@37500808,
38
38
  remove_screenshot: null,
39
39
  unformatted: null,
40
40
  xml_space_preserve: null,
@@ -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@5c96d290,
43
+ project_image: [B@47b8e2,
44
44
  remove_project_image: null,
45
45
  account_id: abcd1234,
46
46
  point_of_contact: abcd1234,
@@ -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@3e908a0b,
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
+
@@ -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@4aee166d)
20
+ filename: [B@66009368)
21
21
  ```
22
22
 
23
23