Skip to content

Commit 63e62d1

Browse files
author
Phrase
committed
1 parent 696e223 commit 63e62d1

8 files changed

+29
-29
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -305,7 +305,7 @@ Class | Method | HTTP request | Description
305305
*Phrase::ProjectsApi* | [**project_show**](docs/ProjectsApi.md#project_show) | **GET** /projects/{id} | Get a single project
306306
*Phrase::ProjectsApi* | [**project_update**](docs/ProjectsApi.md#project_update) | **PATCH** /projects/{id} | Update a project
307307
*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+
*Phrase::QualityPerformanceScoreApi* | [**projects_quality_performance_score**](docs/QualityPerformanceScoreApi.md#projects_quality_performance_score) | **POST** /projects/{project_id}/quality_performance_score | Get Translation Quality
309309
*Phrase::ReleasesApi* | [**release_create**](docs/ReleasesApi.md#release_create) | **POST** /accounts/{account_id}/distributions/{distribution_id}/releases | Create a release
310310
*Phrase::ReleasesApi* | [**release_delete**](docs/ReleasesApi.md#release_delete) | **DELETE** /accounts/{account_id}/distributions/{distribution_id}/releases/{id} | Delete a release
311311
*Phrase::ReleasesApi* | [**release_publish**](docs/ReleasesApi.md#release_publish) | **POST** /accounts/{account_id}/distributions/{distribution_id}/releases/{id}/publish | Publish a release

docs/ProjectsQualityPerformanceScore200Response.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**error** | [**ErrorError**](ErrorError.md) | | [optional]
88
**data** | [**ProjectsQualityPerformanceScore200ResponseAnyOfData**](ProjectsQualityPerformanceScore200ResponseAnyOfData.md) | | [optional]
9-
**errors** | [**Array<ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner>**](ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner.md) | Array of errors for any failing translation ids | [optional]
9+
**errors** | [**Array<ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner>**](ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner.md) | Array of errors for any failing translation IDs | [optional]
1010

1111
## Code Sample
1212

docs/ProjectsQualityPerformanceScore200ResponseAnyOf.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**data** | [**ProjectsQualityPerformanceScore200ResponseAnyOfData**](ProjectsQualityPerformanceScore200ResponseAnyOfData.md) | | [optional]
8-
**errors** | [**Array<ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner>**](ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner.md) | Array of errors for any failing translation ids | [optional]
8+
**errors** | [**Array<ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner>**](ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner.md) | Array of errors for any failing translation IDs | [optional]
99

1010
## Code Sample
1111

docs/QualityPerformanceScoreApi.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@ All URIs are relative to *https://api.phrase.com/v2*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**projects_quality_performance_score**](QualityPerformanceScoreApi.md#projects_quality_performance_score) | **POST** /projects/{id}/quality_performance_score | Get project's translations' quality performance scores
7+
[**projects_quality_performance_score**](QualityPerformanceScoreApi.md#projects_quality_performance_score) | **POST** /projects/{project_id}/quality_performance_score | Get Translation Quality
88

99

1010

1111
## projects_quality_performance_score
1212

13-
> ProjectsQualityPerformanceScore200Response projects_quality_performance_score(id, projects_quality_performance_score_request, opts)
13+
> ProjectsQualityPerformanceScore200Response projects_quality_performance_score(project_id, projects_quality_performance_score_request, opts)
1414
15-
Get project's translations' quality performance scores
15+
Get Translation Quality
1616

17-
Get project's translations' quality performance scores
17+
Retrieves the quality scores for your Strings translations. Returns a score, measured by Phrase QPS
1818

1919
### Example
2020

@@ -33,15 +33,15 @@ Phrase.configure do |config|
3333
end
3434

3535
api_instance = Phrase::QualityPerformanceScoreApi.new
36-
id = 'id_example' # String | ID
36+
project_id = 'project_id_example' # String | Project ID
3737
projects_quality_performance_score_request = Phrase::ProjectsQualityPerformanceScoreRequest.new # ProjectsQualityPerformanceScoreRequest |
3838
opts = {
3939
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
4040
}
4141

4242
begin
43-
#Get project's translations' quality performance scores
44-
result = api_instance.projects_quality_performance_score(id, projects_quality_performance_score_request, opts)
43+
#Get Translation Quality
44+
result = api_instance.projects_quality_performance_score(project_id, projects_quality_performance_score_request, opts)
4545
pp result
4646
rescue Phrase::ApiError => e
4747
puts "Exception when calling QualityPerformanceScoreApi->projects_quality_performance_score: #{e}"
@@ -53,7 +53,7 @@ end
5353

5454
Name | Type | Description | Notes
5555
------------- | ------------- | ------------- | -------------
56-
**id** | **String**| ID |
56+
**project_id** | **String**| Project ID |
5757
**projects_quality_performance_score_request** | [**ProjectsQualityPerformanceScoreRequest**](ProjectsQualityPerformanceScoreRequest.md)| |
5858
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
5959

lib/phrase/api/quality_performance_score_api.rb

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,39 +7,39 @@ class QualityPerformanceScoreApi
77
def initialize(api_client = ApiClient.default)
88
@api_client = api_client
99
end
10-
# Get project's translations' quality performance scores
11-
# Get project's translations' quality performance scores
12-
# @param id [String] ID
10+
# Get Translation Quality
11+
# Retrieves the quality scores for your Strings translations. Returns a score, measured by Phrase QPS
12+
# @param project_id [String] Project ID
1313
# @param projects_quality_performance_score_request [ProjectsQualityPerformanceScoreRequest]
1414
# @param [Hash] opts the optional parameters
1515
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
1616
# @return [ProjectsQualityPerformanceScore200Response]
17-
def projects_quality_performance_score(id, projects_quality_performance_score_request, opts = {})
18-
data, _status_code, _headers = projects_quality_performance_score_with_http_info(id, projects_quality_performance_score_request, opts)
17+
def projects_quality_performance_score(project_id, projects_quality_performance_score_request, opts = {})
18+
data, _status_code, _headers = projects_quality_performance_score_with_http_info(project_id, projects_quality_performance_score_request, opts)
1919
data
2020
end
2121

22-
# Get project's translations' quality performance scores
23-
# Get project's translations' quality performance scores
24-
# @param id [String] ID
22+
# Get Translation Quality
23+
# Retrieves the quality scores for your Strings translations. Returns a score, measured by Phrase QPS
24+
# @param project_id [String] Project ID
2525
# @param projects_quality_performance_score_request [ProjectsQualityPerformanceScoreRequest]
2626
# @param [Hash] opts the optional parameters
2727
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
2828
# @return [Array<(Response<(ProjectsQualityPerformanceScore200Response)>, Integer, Hash)>] Response<(ProjectsQualityPerformanceScore200Response)> data, response status code and response headers
29-
def projects_quality_performance_score_with_http_info(id, projects_quality_performance_score_request, opts = {})
29+
def projects_quality_performance_score_with_http_info(project_id, projects_quality_performance_score_request, opts = {})
3030
if @api_client.config.debugging
3131
@api_client.config.logger.debug 'Calling API: QualityPerformanceScoreApi.projects_quality_performance_score ...'
3232
end
33-
# verify the required parameter 'id' is set
34-
if @api_client.config.client_side_validation && id.nil?
35-
fail ArgumentError, "Missing the required parameter 'id' when calling QualityPerformanceScoreApi.projects_quality_performance_score"
33+
# verify the required parameter 'project_id' is set
34+
if @api_client.config.client_side_validation && project_id.nil?
35+
fail ArgumentError, "Missing the required parameter 'project_id' when calling QualityPerformanceScoreApi.projects_quality_performance_score"
3636
end
3737
# verify the required parameter 'projects_quality_performance_score_request' is set
3838
if @api_client.config.client_side_validation && projects_quality_performance_score_request.nil?
3939
fail ArgumentError, "Missing the required parameter 'projects_quality_performance_score_request' when calling QualityPerformanceScoreApi.projects_quality_performance_score"
4040
end
4141
# resource path
42-
local_var_path = '/projects/{id}/quality_performance_score'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
42+
local_var_path = '/projects/{project_id}/quality_performance_score'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
4343

4444
# query parameters
4545
query_params = opts[:query_params] || {}

lib/phrase/models/projects_quality_performance_score200_response.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ class ProjectsQualityPerformanceScore200Response
66

77
attr_accessor :data
88

9-
# Array of errors for any failing translation ids
9+
# Array of errors for any failing translation IDs
1010
attr_accessor :errors
1111

1212
# Attribute mapping from ruby-style variable name to JSON key.

lib/phrase/models/projects_quality_performance_score200_response_any_of.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ module Phrase
44
class ProjectsQualityPerformanceScore200ResponseAnyOf
55
attr_accessor :data
66

7-
# Array of errors for any failing translation ids
7+
# Array of errors for any failing translation IDs
88
attr_accessor :errors
99

1010
# Attribute mapping from ruby-style variable name to JSON key.

spec/api/quality_performance_score_api_spec.rb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@
2121
end
2222

2323
# unit tests for projects_quality_performance_score
24-
# Get project&#39;s translations&#39; quality performance scores
25-
# Get project&#39;s translations&#39; quality performance scores
26-
# @param id ID
24+
# Get Translation Quality
25+
# Retrieves the quality scores for your Strings translations. Returns a score, measured by Phrase QPS
26+
# @param project_id Project ID
2727
# @param projects_quality_performance_score_request
2828
# @param [Hash] opts the optional parameters
2929
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)

0 commit comments

Comments
 (0)