Deploying from phrase/openapi@d22c558a

phrase · Jan 17, 2024 · aaee4a1 · aaee4a1
1 parent 3498464
commit aaee4a1
Show file tree

Hide file tree

Showing 35 changed files with 2,351 additions and 5 deletions.
diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES
@@ -57,6 +57,8 @@ docs/DistributionUpdateParameters.md
 docs/DistributionsApi.md
 docs/Document.md
 docs/DocumentsApi.md
+docs/Error.md
+docs/ErrorError.md
 docs/FigmaAttachment.md
 docs/FigmaAttachmentCreateParameters.md
 docs/FigmaAttachmentUpdateParameters.md
@@ -176,6 +178,13 @@ docs/ProjectReport.md
 docs/ProjectShort.md
 docs/ProjectUpdateParameters.md
 docs/ProjectsApi.md
+docs/ProjectsQualityPerformanceScore200Response.md
+docs/ProjectsQualityPerformanceScore200ResponseAnyOf.md
+docs/ProjectsQualityPerformanceScore200ResponseAnyOfData.md
+docs/ProjectsQualityPerformanceScore200ResponseAnyOfDataTranslationsInner.md
+docs/ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner.md
+docs/ProjectsQualityPerformanceScoreRequest.md
+docs/QualityPerformanceScoreApi.md
 docs/Release.md
 docs/ReleaseCreateParameters.md
 docs/ReleasePreview.md
@@ -295,6 +304,7 @@ lib/phrase/api/orders_api.rb
 lib/phrase/api/organization_job_template_locales_api.rb
 lib/phrase/api/organization_job_templates_api.rb
 lib/phrase/api/projects_api.rb
+lib/phrase/api/quality_performance_score_api.rb
 lib/phrase/api/releases_api.rb
 lib/phrase/api/reports_api.rb
 lib/phrase/api/screenshot_markers_api.rb
@@ -353,6 +363,8 @@ lib/phrase/models/distribution_create_parameters.rb
 lib/phrase/models/distribution_preview.rb
 lib/phrase/models/distribution_update_parameters.rb
 lib/phrase/models/document.rb
+lib/phrase/models/error.rb
+lib/phrase/models/error_error.rb
 lib/phrase/models/figma_attachment.rb
 lib/phrase/models/figma_attachment_create_parameters.rb
 lib/phrase/models/figma_attachment_update_parameters.rb
@@ -448,6 +460,12 @@ lib/phrase/models/project_locales.rb
 lib/phrase/models/project_report.rb
 lib/phrase/models/project_short.rb
 lib/phrase/models/project_update_parameters.rb
+lib/phrase/models/projects_quality_performance_score200_response.rb
+lib/phrase/models/projects_quality_performance_score200_response_any_of.rb
+lib/phrase/models/projects_quality_performance_score200_response_any_of_data.rb
+lib/phrase/models/projects_quality_performance_score200_response_any_of_data_translations_inner.rb
+lib/phrase/models/projects_quality_performance_score200_response_any_of_errors_inner.rb
+lib/phrase/models/projects_quality_performance_score_request.rb
 lib/phrase/models/release.rb
 lib/phrase/models/release_create_parameters.rb
 lib/phrase/models/release_preview.rb
@@ -550,6 +568,7 @@ spec/api/orders_api_spec.rb
 spec/api/organization_job_template_locales_api_spec.rb
 spec/api/organization_job_templates_api_spec.rb
 spec/api/projects_api_spec.rb
+spec/api/quality_performance_score_api_spec.rb
 spec/api/releases_api_spec.rb
 spec/api/reports_api_spec.rb
 spec/api/screenshot_markers_api_spec.rb
@@ -606,6 +625,8 @@ spec/models/distribution_preview_spec.rb
 spec/models/distribution_spec.rb
 spec/models/distribution_update_parameters_spec.rb
 spec/models/document_spec.rb
+spec/models/error_error_spec.rb
+spec/models/error_spec.rb
 spec/models/figma_attachment_create_parameters_spec.rb
 spec/models/figma_attachment_spec.rb
 spec/models/figma_attachment_update_parameters_spec.rb
@@ -701,6 +722,12 @@ spec/models/project_report_spec.rb
 spec/models/project_short_spec.rb
 spec/models/project_spec.rb
 spec/models/project_update_parameters_spec.rb
+spec/models/projects_quality_performance_score200_response_any_of_data_spec.rb
+spec/models/projects_quality_performance_score200_response_any_of_data_translations_inner_spec.rb
+spec/models/projects_quality_performance_score200_response_any_of_errors_inner_spec.rb
+spec/models/projects_quality_performance_score200_response_any_of_spec.rb
+spec/models/projects_quality_performance_score200_response_spec.rb
+spec/models/projects_quality_performance_score_request_spec.rb
 spec/models/release_create_parameters_spec.rb
 spec/models/release_preview_spec.rb
 spec/models/release_spec.rb

diff --git a/README.md b/README.md
@@ -305,6 +305,7 @@ Class | Method | HTTP request | Description
 *Phrase::ProjectsApi* | [**project_show**](docs/ProjectsApi.md#project_show) | **GET** /projects/{id} | Get a single project
 *Phrase::ProjectsApi* | [**project_update**](docs/ProjectsApi.md#project_update) | **PATCH** /projects/{id} | Update a project
 *Phrase::ProjectsApi* | [**projects_list**](docs/ProjectsApi.md#projects_list) | **GET** /projects | List projects
+*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
 *Phrase::ReleasesApi* | [**release_create**](docs/ReleasesApi.md#release_create) | **POST** /accounts/{account_id}/distributions/{distribution_id}/releases | Create a release
 *Phrase::ReleasesApi* | [**release_delete**](docs/ReleasesApi.md#release_delete) | **DELETE** /accounts/{account_id}/distributions/{distribution_id}/releases/{id} | Delete a release
 *Phrase::ReleasesApi* | [**release_publish**](docs/ReleasesApi.md#release_publish) | **POST** /accounts/{account_id}/distributions/{distribution_id}/releases/{id}/publish | Publish a release
@@ -432,6 +433,8 @@ Class | Method | HTTP request | Description
  - [Phrase::DistributionPreview](docs/DistributionPreview.md)
  - [Phrase::DistributionUpdateParameters](docs/DistributionUpdateParameters.md)
  - [Phrase::Document](docs/Document.md)
+ - [Phrase::Error](docs/Error.md)
+ - [Phrase::ErrorError](docs/ErrorError.md)
  - [Phrase::FigmaAttachment](docs/FigmaAttachment.md)
  - [Phrase::FigmaAttachmentCreateParameters](docs/FigmaAttachmentCreateParameters.md)
  - [Phrase::FigmaAttachmentUpdateParameters](docs/FigmaAttachmentUpdateParameters.md)
@@ -527,6 +530,12 @@ Class | Method | HTTP request | Description
  - [Phrase::ProjectReport](docs/ProjectReport.md)
  - [Phrase::ProjectShort](docs/ProjectShort.md)
  - [Phrase::ProjectUpdateParameters](docs/ProjectUpdateParameters.md)
+ - [Phrase::ProjectsQualityPerformanceScore200Response](docs/ProjectsQualityPerformanceScore200Response.md)
+ - [Phrase::ProjectsQualityPerformanceScore200ResponseAnyOf](docs/ProjectsQualityPerformanceScore200ResponseAnyOf.md)
+ - [Phrase::ProjectsQualityPerformanceScore200ResponseAnyOfData](docs/ProjectsQualityPerformanceScore200ResponseAnyOfData.md)
+ - [Phrase::ProjectsQualityPerformanceScore200ResponseAnyOfDataTranslationsInner](docs/ProjectsQualityPerformanceScore200ResponseAnyOfDataTranslationsInner.md)
+ - [Phrase::ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner](docs/ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner.md)
+ - [Phrase::ProjectsQualityPerformanceScoreRequest](docs/ProjectsQualityPerformanceScoreRequest.md)
  - [Phrase::Release](docs/Release.md)
  - [Phrase::ReleaseCreateParameters](docs/ReleaseCreateParameters.md)
  - [Phrase::ReleasePreview](docs/ReleasePreview.md)

diff --git a/docs/Error.md b/docs/Error.md
@@ -0,0 +1,17 @@
+# Phrase::Error
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | [**ErrorError**](ErrorError.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::Error.new(error: null)
+```
+
+
diff --git a/docs/ErrorError.md b/docs/ErrorError.md
@@ -0,0 +1,19 @@
+# Phrase::ErrorError
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **String** |  | [optional] 
+**code** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::ErrorError.new(message: null,
+                                 code: null)
+```
+
+
diff --git a/docs/KeyCreateParameters.md b/docs/KeyCreateParameters.md
@@ -35,7 +35,7 @@ instance = Phrase::KeyCreateParameters.new(branch: my-feature-branch,
                                  data_type: number,
                                  tags: awesome-feature,needs-proofreading,
                                  max_characters_allowed: 140,
-                                 screenshot: [B@73dbb666,
+                                 screenshot: [B@5bbda7e2,
                                  remove_screenshot: null,
                                  unformatted: null,
                                  default_translation_content: Default translation content,

diff --git a/docs/KeyUpdateParameters.md b/docs/KeyUpdateParameters.md
@@ -34,7 +34,7 @@ instance = Phrase::KeyUpdateParameters.new(branch: my-feature-branch,
                                  data_type: number,
                                  tags: awesome-feature,needs-proofreading,
                                  max_characters_allowed: 140,
-                                 screenshot: [B@1bf5745,
+                                 screenshot: [B@37500808,
                                  remove_screenshot: null,
                                  unformatted: null,
                                  xml_space_preserve: null,

diff --git a/docs/ProjectCreateParameters.md b/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@2cf065e9,
+                                 project_image: [B@47b8e2,
                                  remove_project_image: null,
                                  account_id: abcd1234,
                                  point_of_contact: abcd1234,

diff --git a/docs/ProjectUpdateParameters.md b/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@d9fe131,
+                                 project_image: [B@2ba8f528,
                                  remove_project_image: false,
                                  workflow: review,
                                  machine_translation_enabled: true,

diff --git a/docs/ProjectsQualityPerformanceScore200Response.md b/docs/ProjectsQualityPerformanceScore200Response.md
@@ -0,0 +1,21 @@
+# Phrase::ProjectsQualityPerformanceScore200Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | [**ErrorError**](ErrorError.md) |  | [optional] 
+**data** | [**ProjectsQualityPerformanceScore200ResponseAnyOfData**](ProjectsQualityPerformanceScore200ResponseAnyOfData.md) |  | [optional] 
+**errors** | [**Array&lt;ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner&gt;**](ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner.md) | Array of errors for any failing translation ids | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::ProjectsQualityPerformanceScore200Response.new(error: null,
+                                 data: null,
+                                 errors: null)
+```
+
+
diff --git a/docs/ProjectsQualityPerformanceScore200ResponseAnyOf.md b/docs/ProjectsQualityPerformanceScore200ResponseAnyOf.md
@@ -0,0 +1,19 @@
+# Phrase::ProjectsQualityPerformanceScore200ResponseAnyOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**ProjectsQualityPerformanceScore200ResponseAnyOfData**](ProjectsQualityPerformanceScore200ResponseAnyOfData.md) |  | [optional] 
+**errors** | [**Array&lt;ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner&gt;**](ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner.md) | Array of errors for any failing translation ids | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::ProjectsQualityPerformanceScore200ResponseAnyOf.new(data: null,
+                                 errors: null)
+```
+
+
diff --git a/docs/ProjectsQualityPerformanceScore200ResponseAnyOfData.md b/docs/ProjectsQualityPerformanceScore200ResponseAnyOfData.md
@@ -0,0 +1,17 @@
+# Phrase::ProjectsQualityPerformanceScore200ResponseAnyOfData
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**translations** | [**Array&lt;ProjectsQualityPerformanceScore200ResponseAnyOfDataTranslationsInner&gt;**](ProjectsQualityPerformanceScore200ResponseAnyOfDataTranslationsInner.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::ProjectsQualityPerformanceScore200ResponseAnyOfData.new(translations: null)
+```
+
+
diff --git a/docs/ProjectsQualityPerformanceScore200ResponseAnyOfDataTranslationsInner.md b/docs/ProjectsQualityPerformanceScore200ResponseAnyOfDataTranslationsInner.md
@@ -0,0 +1,21 @@
+# Phrase::ProjectsQualityPerformanceScore200ResponseAnyOfDataTranslationsInner
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**engine** | **String** | Engine used for the translation scoring | [optional] 
+**score** | **Float** | Quality score for the translation | [optional] 
+**id** | **String** | One of the translation ids passed in arguments | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::ProjectsQualityPerformanceScore200ResponseAnyOfDataTranslationsInner.new(engine: null,
+                                 score: null,
+                                 id: null)
+```
+
+
diff --git a/docs/ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner.md b/docs/ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner.md
@@ -0,0 +1,21 @@
+# Phrase::ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **String** |  | [optional] 
+**code** | **String** |  | [optional] 
+**id** | **String** | One of the translation ids passed in arguments | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner.new(message: null,
+                                 code: null,
+                                 id: null)
+```
+
+
diff --git a/docs/ProjectsQualityPerformanceScoreRequest.md b/docs/ProjectsQualityPerformanceScoreRequest.md
@@ -0,0 +1,17 @@
+# Phrase::ProjectsQualityPerformanceScoreRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**translation_ids** | **Array&lt;String&gt;** | Translation ids you want to get the quality performance score for | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::ProjectsQualityPerformanceScoreRequest.new(translation_ids: null)
+```
+
+
diff --git a/docs/QualityPerformanceScoreApi.md b/docs/QualityPerformanceScoreApi.md
@@ -0,0 +1,72 @@
+# Phrase::QualityPerformanceScoreApi
+
+All URIs are relative to *https://api.phrase.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**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
+
+
+
+## projects_quality_performance_score
+
+> ProjectsQualityPerformanceScore200Response projects_quality_performance_score(id, projects_quality_performance_score_request, opts)
+
+Get project's translations' quality performance scores
+
+Get project's translations' quality performance scores
+
+### 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::QualityPerformanceScoreApi.new
+id = 'id_example' # String | ID
+projects_quality_performance_score_request = Phrase::ProjectsQualityPerformanceScoreRequest.new # ProjectsQualityPerformanceScoreRequest | 
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Get project's translations' quality performance scores
+  result = api_instance.projects_quality_performance_score(id, projects_quality_performance_score_request, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling QualityPerformanceScoreApi->projects_quality_performance_score: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| ID | 
+ **projects_quality_performance_score_request** | [**ProjectsQualityPerformanceScoreRequest**](ProjectsQualityPerformanceScoreRequest.md)|  | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+
+### Return type
+
+Response<([**ProjectsQualityPerformanceScore200Response**](ProjectsQualityPerformanceScore200Response.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
diff --git a/docs/ScreenshotUpdateParameters.md b/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@5c2b5f27)
+                                 filename: [B@66009368)
 ```