Deploying from phrase/openapi@4b4f1acf

phrase · Feb 1, 2024 · 63e62d1 · 63e62d1
1 parent 696e223
commit 63e62d1
Show file tree

Hide file tree

Showing 8 changed files with 29 additions and 29 deletions.
diff --git a/README.md b/README.md
@@ -305,7 +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::QualityPerformanceScoreApi* | [**projects_quality_performance_score**](docs/QualityPerformanceScoreApi.md#projects_quality_performance_score) | **POST** /projects/{project_id}/quality_performance_score | Get Translation Quality
 *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

diff --git a/docs/ProjectsQualityPerformanceScore200Response.md b/docs/ProjectsQualityPerformanceScore200Response.md
@@ -6,7 +6,7 @@ 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] 
+**errors** | [**Array&lt;ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner&gt;**](ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner.md) | Array of errors for any failing translation IDs | [optional] 
 
 ## Code Sample
 

diff --git a/docs/ProjectsQualityPerformanceScore200ResponseAnyOf.md b/docs/ProjectsQualityPerformanceScore200ResponseAnyOf.md
@@ -5,7 +5,7 @@
 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] 
+**errors** | [**Array&lt;ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner&gt;**](ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner.md) | Array of errors for any failing translation IDs | [optional] 
 
 ## Code Sample
 

diff --git a/docs/QualityPerformanceScoreApi.md b/docs/QualityPerformanceScoreApi.md
@@ -4,17 +4,17 @@ 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**](QualityPerformanceScoreApi.md#projects_quality_performance_score) | **POST** /projects/{project_id}/quality_performance_score | Get Translation Quality
 
 
 
 ## projects_quality_performance_score
 
-> ProjectsQualityPerformanceScore200Response projects_quality_performance_score(id, projects_quality_performance_score_request, opts)
+> ProjectsQualityPerformanceScore200Response projects_quality_performance_score(project_id, projects_quality_performance_score_request, opts)
 
-Get project's translations' quality performance scores
+Get Translation Quality
 
-Get project's translations' quality performance scores
+Retrieves the quality scores for your Strings translations. Returns a score, measured by Phrase QPS
 
 ### Example
 
@@ -33,15 +33,15 @@ Phrase.configure do |config|
 end
 
 api_instance = Phrase::QualityPerformanceScoreApi.new
-id = 'id_example' # String | ID
+project_id = 'project_id_example' # String | Project 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)
+  #Get Translation Quality
+  result = api_instance.projects_quality_performance_score(project_id, projects_quality_performance_score_request, opts)
   pp result
 rescue Phrase::ApiError => e
   puts "Exception when calling QualityPerformanceScoreApi->projects_quality_performance_score: #{e}"
@@ -53,7 +53,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **id** | **String**| ID | 
+ **project_id** | **String**| Project ID | 
  **projects_quality_performance_score_request** | [**ProjectsQualityPerformanceScoreRequest**](ProjectsQualityPerformanceScoreRequest.md)|  | 
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
 

diff --git a/lib/phrase/api/quality_performance_score_api.rb b/lib/phrase/api/quality_performance_score_api.rb
@@ -7,39 +7,39 @@ class QualityPerformanceScoreApi
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Get project's translations' quality performance scores
-    # Get project's translations' quality performance scores
-    # @param id [String] ID
+    # Get Translation Quality
+    # Retrieves the quality scores for your Strings translations. Returns a score, measured by Phrase QPS
+    # @param project_id [String] Project ID
     # @param projects_quality_performance_score_request [ProjectsQualityPerformanceScoreRequest] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
     # @return [ProjectsQualityPerformanceScore200Response]
-    def projects_quality_performance_score(id, projects_quality_performance_score_request, opts = {})
-      data, _status_code, _headers = projects_quality_performance_score_with_http_info(id, projects_quality_performance_score_request, opts)
+    def projects_quality_performance_score(project_id, projects_quality_performance_score_request, opts = {})
+      data, _status_code, _headers = projects_quality_performance_score_with_http_info(project_id, projects_quality_performance_score_request, opts)
       data
     end
 
-    # Get project&#39;s translations&#39; quality performance scores
-    # Get project&#39;s translations&#39; quality performance scores
-    # @param id [String] ID
+    # Get Translation Quality
+    # Retrieves the quality scores for your Strings translations. Returns a score, measured by Phrase QPS
+    # @param project_id [String] Project ID
     # @param projects_quality_performance_score_request [ProjectsQualityPerformanceScoreRequest] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
     # @return [Array<(Response<(ProjectsQualityPerformanceScore200Response)>, Integer, Hash)>] Response<(ProjectsQualityPerformanceScore200Response)> data, response status code and response headers
-    def projects_quality_performance_score_with_http_info(id, projects_quality_performance_score_request, opts = {})
+    def projects_quality_performance_score_with_http_info(project_id, projects_quality_performance_score_request, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: QualityPerformanceScoreApi.projects_quality_performance_score ...'
       end
-      # verify the required parameter 'id' is set
-      if @api_client.config.client_side_validation && id.nil?
-        fail ArgumentError, "Missing the required parameter 'id' when calling QualityPerformanceScoreApi.projects_quality_performance_score"
+      # verify the required parameter 'project_id' is set
+      if @api_client.config.client_side_validation && project_id.nil?
+        fail ArgumentError, "Missing the required parameter 'project_id' when calling QualityPerformanceScoreApi.projects_quality_performance_score"
       end
       # verify the required parameter 'projects_quality_performance_score_request' is set
       if @api_client.config.client_side_validation && projects_quality_performance_score_request.nil?
         fail ArgumentError, "Missing the required parameter 'projects_quality_performance_score_request' when calling QualityPerformanceScoreApi.projects_quality_performance_score"
       end
       # resource path
-      local_var_path = '/projects/{id}/quality_performance_score'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+      local_var_path = '/projects/{project_id}/quality_performance_score'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}

diff --git a/lib/phrase/models/projects_quality_performance_score200_response.rb b/lib/phrase/models/projects_quality_performance_score200_response.rb
@@ -6,7 +6,7 @@ class ProjectsQualityPerformanceScore200Response
 
     attr_accessor :data
 
-    # Array of errors for any failing translation ids
+    # Array of errors for any failing translation IDs
     attr_accessor :errors
 
     # Attribute mapping from ruby-style variable name to JSON key.

diff --git a/lib/phrase/models/projects_quality_performance_score200_response_any_of.rb b/lib/phrase/models/projects_quality_performance_score200_response_any_of.rb
@@ -4,7 +4,7 @@ module Phrase
   class ProjectsQualityPerformanceScore200ResponseAnyOf
     attr_accessor :data
 
-    # Array of errors for any failing translation ids
+    # Array of errors for any failing translation IDs
     attr_accessor :errors
 
     # Attribute mapping from ruby-style variable name to JSON key.

diff --git a/spec/api/quality_performance_score_api_spec.rb b/spec/api/quality_performance_score_api_spec.rb
@@ -21,9 +21,9 @@
   end
 
   # unit tests for projects_quality_performance_score
-  # Get project&#39;s translations&#39; quality performance scores
-  # Get project&#39;s translations&#39; quality performance scores
-  # @param id ID
+  # Get Translation Quality
+  # Retrieves the quality scores for your Strings translations. Returns a score, measured by Phrase QPS
+  # @param project_id Project ID
   # @param projects_quality_performance_score_request 
   # @param [Hash] opts the optional parameters
   # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)