From 4fcaf7efbbbf590de4a800b71136a2901c574253 Mon Sep 17 00:00:00 2001 From: Phrase Date: Thu, 1 Feb 2024 08:16:27 +0000 Subject: [PATCH] Deploying from phrase/openapi@4b4f1acf --- README.md | 2 +- docs/Api/QualityPerformanceScoreApi.md | 14 +++--- ...jectsQualityPerformanceScore200Response.md | 2 +- ...QualityPerformanceScore200ResponseAnyOf.md | 2 +- lib/Api/QualityPerformanceScoreApi.php | 50 +++++++++---------- ...ectsQualityPerformanceScore200Response.php | 2 +- ...ualityPerformanceScore200ResponseAnyOf.php | 2 +- test/Api/QualityPerformanceScoreApiTest.php | 2 +- 8 files changed, 38 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index bb62b77..1f3f928 100644 --- a/README.md +++ b/README.md @@ -322,7 +322,7 @@ Class | Method | HTTP request | Description *ProjectsApi* | [**projectShow**](docs/Api/ProjectsApi.md#projectshow) | **GET** /projects/{id} | Get a single project *ProjectsApi* | [**projectUpdate**](docs/Api/ProjectsApi.md#projectupdate) | **PATCH** /projects/{id} | Update a project *ProjectsApi* | [**projectsList**](docs/Api/ProjectsApi.md#projectslist) | **GET** /projects | List projects -*QualityPerformanceScoreApi* | [**projectsQualityPerformanceScore**](docs/Api/QualityPerformanceScoreApi.md#projectsqualityperformancescore) | **POST** /projects/{id}/quality_performance_score | Get project's translations' quality performance scores +*QualityPerformanceScoreApi* | [**projectsQualityPerformanceScore**](docs/Api/QualityPerformanceScoreApi.md#projectsqualityperformancescore) | **POST** /projects/{project_id}/quality_performance_score | Get Translation Quality *ReleasesApi* | [**releaseCreate**](docs/Api/ReleasesApi.md#releasecreate) | **POST** /accounts/{account_id}/distributions/{distribution_id}/releases | Create a release *ReleasesApi* | [**releaseDelete**](docs/Api/ReleasesApi.md#releasedelete) | **DELETE** /accounts/{account_id}/distributions/{distribution_id}/releases/{id} | Delete a release *ReleasesApi* | [**releasePublish**](docs/Api/ReleasesApi.md#releasepublish) | **POST** /accounts/{account_id}/distributions/{distribution_id}/releases/{id}/publish | Publish a release diff --git a/docs/Api/QualityPerformanceScoreApi.md b/docs/Api/QualityPerformanceScoreApi.md index 285591e..df2e740 100644 --- a/docs/Api/QualityPerformanceScoreApi.md +++ b/docs/Api/QualityPerformanceScoreApi.md @@ -4,17 +4,17 @@ All URIs are relative to *https://api.phrase.com/v2* Method | HTTP request | Description ------------- | ------------- | ------------- -[**projectsQualityPerformanceScore**](QualityPerformanceScoreApi.md#projectsQualityPerformanceScore) | **POST** /projects/{id}/quality_performance_score | Get project's translations' quality performance scores +[**projectsQualityPerformanceScore**](QualityPerformanceScoreApi.md#projectsQualityPerformanceScore) | **POST** /projects/{project_id}/quality_performance_score | Get Translation Quality ## projectsQualityPerformanceScore -> \Phrase\Model\ProjectsQualityPerformanceScore200Response projectsQualityPerformanceScore($id, $projects_quality_performance_score_request, $x_phrase_app_otp) +> \Phrase\Model\ProjectsQualityPerformanceScore200Response projectsQualityPerformanceScore($project_id, $projects_quality_performance_score_request, $x_phrase_app_otp) -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 @@ -31,12 +31,12 @@ $apiInstance = new Phrase\Api\QualityPerformanceScoreApi( new GuzzleHttp\Client(), $config ); -$id = 'id_example'; // string | ID +$project_id = 'project_id_example'; // string | Project ID $projects_quality_performance_score_request = new \Phrase\Model\ProjectsQualityPerformanceScoreRequest(); // \Phrase\Model\ProjectsQualityPerformanceScoreRequest | $x_phrase_app_otp = 'x_phrase_app_otp_example'; // string | Two-Factor-Authentication token (optional) try { - $result = $apiInstance->projectsQualityPerformanceScore($id, $projects_quality_performance_score_request, $x_phrase_app_otp); + $result = $apiInstance->projectsQualityPerformanceScore($project_id, $projects_quality_performance_score_request, $x_phrase_app_otp); print_r($result); } catch (Exception $e) { echo 'Exception when calling QualityPerformanceScoreApi->projectsQualityPerformanceScore: ', $e->getMessage(), PHP_EOL; @@ -49,7 +49,7 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **string**| ID | + **project_id** | **string**| Project ID | **projects_quality_performance_score_request** | [**\Phrase\Model\ProjectsQualityPerformanceScoreRequest**](../Model/ProjectsQualityPerformanceScoreRequest.md)| | **x_phrase_app_otp** | **string**| Two-Factor-Authentication token (optional) | [optional] diff --git a/docs/Model/ProjectsQualityPerformanceScore200Response.md b/docs/Model/ProjectsQualityPerformanceScore200Response.md index 1522368..7b62ce6 100644 --- a/docs/Model/ProjectsQualityPerformanceScore200Response.md +++ b/docs/Model/ProjectsQualityPerformanceScore200Response.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **error** | [**\Phrase\Model\ErrorError**](ErrorError.md) | | [optional] **data** | [**\Phrase\Model\ProjectsQualityPerformanceScore200ResponseAnyOfData**](ProjectsQualityPerformanceScore200ResponseAnyOfData.md) | | [optional] -**errors** | [**\Phrase\Model\ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner[]**](ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner.md) | Array of errors for any failing translation ids | [optional] +**errors** | [**\Phrase\Model\ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner[]**](ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner.md) | Array of errors for any failing translation IDs | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) diff --git a/docs/Model/ProjectsQualityPerformanceScore200ResponseAnyOf.md b/docs/Model/ProjectsQualityPerformanceScore200ResponseAnyOf.md index e4821e0..b1dc52b 100644 --- a/docs/Model/ProjectsQualityPerformanceScore200ResponseAnyOf.md +++ b/docs/Model/ProjectsQualityPerformanceScore200ResponseAnyOf.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**\Phrase\Model\ProjectsQualityPerformanceScore200ResponseAnyOfData**](ProjectsQualityPerformanceScore200ResponseAnyOfData.md) | | [optional] -**errors** | [**\Phrase\Model\ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner[]**](ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner.md) | Array of errors for any failing translation ids | [optional] +**errors** | [**\Phrase\Model\ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner[]**](ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner.md) | Array of errors for any failing translation IDs | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) diff --git a/lib/Api/QualityPerformanceScoreApi.php b/lib/Api/QualityPerformanceScoreApi.php index 300bea8..497d659 100644 --- a/lib/Api/QualityPerformanceScoreApi.php +++ b/lib/Api/QualityPerformanceScoreApi.php @@ -116,9 +116,9 @@ public function getConfig() /** * Operation projectsQualityPerformanceScore * - * Get project's translations' quality performance scores + * Get Translation Quality * - * @param string $id ID (required) + * @param string $project_id Project ID (required) * @param \Phrase\Model\ProjectsQualityPerformanceScoreRequest $projects_quality_performance_score_request projects_quality_performance_score_request (required) * @param string $x_phrase_app_otp Two-Factor-Authentication token (optional) (optional) * @@ -126,18 +126,18 @@ public function getConfig() * @throws \InvalidArgumentException * @return \Phrase\Model\ProjectsQualityPerformanceScore200Response|\Phrase\Model\CustomMetadataPropertyCreate422Response */ - public function projectsQualityPerformanceScore($id, $projects_quality_performance_score_request, $x_phrase_app_otp = null) + public function projectsQualityPerformanceScore($project_id, $projects_quality_performance_score_request, $x_phrase_app_otp = null) { - list($response) = $this->projectsQualityPerformanceScoreWithHttpInfo($id, $projects_quality_performance_score_request, $x_phrase_app_otp); + list($response) = $this->projectsQualityPerformanceScoreWithHttpInfo($project_id, $projects_quality_performance_score_request, $x_phrase_app_otp); return $response; } /** * Operation projectsQualityPerformanceScoreWithHttpInfo * - * Get project's translations' quality performance scores + * Get Translation Quality * - * @param string $id ID (required) + * @param string $project_id Project ID (required) * @param \Phrase\Model\ProjectsQualityPerformanceScoreRequest $projects_quality_performance_score_request (required) * @param string $x_phrase_app_otp Two-Factor-Authentication token (optional) (optional) * @@ -145,9 +145,9 @@ public function projectsQualityPerformanceScore($id, $projects_quality_performan * @throws \InvalidArgumentException * @return array of \Phrase\Model\ProjectsQualityPerformanceScore200Response|\Phrase\Model\CustomMetadataPropertyCreate422Response, HTTP status code, HTTP response headers (array of strings) */ - public function projectsQualityPerformanceScoreWithHttpInfo($id, $projects_quality_performance_score_request, $x_phrase_app_otp = null) + public function projectsQualityPerformanceScoreWithHttpInfo($project_id, $projects_quality_performance_score_request, $x_phrase_app_otp = null) { - $request = $this->projectsQualityPerformanceScoreRequest($id, $projects_quality_performance_score_request, $x_phrase_app_otp); + $request = $this->projectsQualityPerformanceScoreRequest($project_id, $projects_quality_performance_score_request, $x_phrase_app_otp); try { $options = $this->createHttpClientOption(); @@ -245,18 +245,18 @@ public function projectsQualityPerformanceScoreWithHttpInfo($id, $projects_quali /** * Operation projectsQualityPerformanceScoreAsync * - * Get project's translations' quality performance scores + * Get Translation Quality * - * @param string $id ID (required) + * @param string $project_id Project ID (required) * @param \Phrase\Model\ProjectsQualityPerformanceScoreRequest $projects_quality_performance_score_request (required) * @param string $x_phrase_app_otp Two-Factor-Authentication token (optional) (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ - public function projectsQualityPerformanceScoreAsync($id, $projects_quality_performance_score_request, $x_phrase_app_otp = null) + public function projectsQualityPerformanceScoreAsync($project_id, $projects_quality_performance_score_request, $x_phrase_app_otp = null) { - return $this->projectsQualityPerformanceScoreAsyncWithHttpInfo($id, $projects_quality_performance_score_request, $x_phrase_app_otp) + return $this->projectsQualityPerformanceScoreAsyncWithHttpInfo($project_id, $projects_quality_performance_score_request, $x_phrase_app_otp) ->then( function ($response) { return $response[0]; @@ -267,19 +267,19 @@ function ($response) { /** * Operation projectsQualityPerformanceScoreAsyncWithHttpInfo * - * Get project's translations' quality performance scores + * Get Translation Quality * - * @param string $id ID (required) + * @param string $project_id Project ID (required) * @param \Phrase\Model\ProjectsQualityPerformanceScoreRequest $projects_quality_performance_score_request (required) * @param string $x_phrase_app_otp Two-Factor-Authentication token (optional) (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ - public function projectsQualityPerformanceScoreAsyncWithHttpInfo($id, $projects_quality_performance_score_request, $x_phrase_app_otp = null) + public function projectsQualityPerformanceScoreAsyncWithHttpInfo($project_id, $projects_quality_performance_score_request, $x_phrase_app_otp = null) { $returnType = '\Phrase\Model\ProjectsQualityPerformanceScore200Response'; - $request = $this->projectsQualityPerformanceScoreRequest($id, $projects_quality_performance_score_request, $x_phrase_app_otp); + $request = $this->projectsQualityPerformanceScoreRequest($project_id, $projects_quality_performance_score_request, $x_phrase_app_otp); return $this->client ->sendAsync($request, $this->createHttpClientOption()) @@ -318,19 +318,19 @@ function ($exception) { /** * Create request for operation 'projectsQualityPerformanceScore' * - * @param string $id ID (required) + * @param string $project_id Project ID (required) * @param \Phrase\Model\ProjectsQualityPerformanceScoreRequest $projects_quality_performance_score_request (required) * @param string $x_phrase_app_otp Two-Factor-Authentication token (optional) (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ - protected function projectsQualityPerformanceScoreRequest($id, $projects_quality_performance_score_request, $x_phrase_app_otp = null) + protected function projectsQualityPerformanceScoreRequest($project_id, $projects_quality_performance_score_request, $x_phrase_app_otp = null) { - // verify the required parameter 'id' is set - if ($id === null || (is_array($id) && count($id) === 0)) { + // verify the required parameter 'project_id' is set + if ($project_id === null || (is_array($project_id) && count($project_id) === 0)) { throw new \InvalidArgumentException( - 'Missing the required parameter $id when calling projectsQualityPerformanceScore' + 'Missing the required parameter $project_id when calling projectsQualityPerformanceScore' ); } // verify the required parameter 'projects_quality_performance_score_request' is set @@ -340,7 +340,7 @@ protected function projectsQualityPerformanceScoreRequest($id, $projects_quality ); } - $resourcePath = '/projects/{id}/quality_performance_score'; + $resourcePath = '/projects/{project_id}/quality_performance_score'; $formParams = []; $queryParams = []; $headerParams = []; @@ -354,10 +354,10 @@ protected function projectsQualityPerformanceScoreRequest($id, $projects_quality } // path params - if ($id !== null) { + if ($project_id !== null) { $resourcePath = str_replace( - '{' . 'id' . '}', - ObjectSerializer::toPathValue($id), + '{' . 'project_id' . '}', + ObjectSerializer::toPathValue($project_id), $resourcePath ); } diff --git a/lib/Model/ProjectsQualityPerformanceScore200Response.php b/lib/Model/ProjectsQualityPerformanceScore200Response.php index a2c8e90..b7a7320 100644 --- a/lib/Model/ProjectsQualityPerformanceScore200Response.php +++ b/lib/Model/ProjectsQualityPerformanceScore200Response.php @@ -275,7 +275,7 @@ public function getErrors() /** * Sets errors * - * @param \Phrase\Model\ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner[]|null $errors Array of errors for any failing translation ids + * @param \Phrase\Model\ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner[]|null $errors Array of errors for any failing translation IDs * * @return $this */ diff --git a/lib/Model/ProjectsQualityPerformanceScore200ResponseAnyOf.php b/lib/Model/ProjectsQualityPerformanceScore200ResponseAnyOf.php index 2b5c9c2..1a2ed33 100644 --- a/lib/Model/ProjectsQualityPerformanceScore200ResponseAnyOf.php +++ b/lib/Model/ProjectsQualityPerformanceScore200ResponseAnyOf.php @@ -245,7 +245,7 @@ public function getErrors() /** * Sets errors * - * @param \Phrase\Model\ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner[]|null $errors Array of errors for any failing translation ids + * @param \Phrase\Model\ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner[]|null $errors Array of errors for any failing translation IDs * * @return $this */ diff --git a/test/Api/QualityPerformanceScoreApiTest.php b/test/Api/QualityPerformanceScoreApiTest.php index c4553bb..7f8bdd4 100644 --- a/test/Api/QualityPerformanceScoreApiTest.php +++ b/test/Api/QualityPerformanceScoreApiTest.php @@ -73,7 +73,7 @@ public static function tearDownAfterClass() /** * Test case for projectsQualityPerformanceScore * - * Get project's translations' quality performance scores. + * Get Translation Quality. * */ public function testProjectsQualityPerformanceScore()