Deploying from phrase/openapi@4b4f1acf

phrase · Feb 1, 2024 · 318a479 · 318a479
1 parent 1b261a3
commit 318a479
Show file tree

Hide file tree

Showing 221 changed files with 263 additions and 262 deletions.
diff --git a/README.md b/README.md
@@ -286,7 +286,7 @@ Class | Method | HTTP request | Description
 *ProjectsApi* | [**projectShow**](docs/ProjectsApi.md#projectShow) | **GET** /projects/{id} | Get a single project
 *ProjectsApi* | [**projectUpdate**](docs/ProjectsApi.md#projectUpdate) | **PATCH** /projects/{id} | Update a project
 *ProjectsApi* | [**projectsList**](docs/ProjectsApi.md#projectsList) | **GET** /projects | List projects
-*QualityPerformanceScoreApi* | [**projectsQualityPerformanceScore**](docs/QualityPerformanceScoreApi.md#projectsQualityPerformanceScore) | **POST** /projects/{id}/quality_performance_score | Get project&#39;s translations&#39; quality performance scores
+*QualityPerformanceScoreApi* | [**projectsQualityPerformanceScore**](docs/QualityPerformanceScoreApi.md#projectsQualityPerformanceScore) | **POST** /projects/{project_id}/quality_performance_score | Get Translation Quality
 *ReleasesApi* | [**releaseCreate**](docs/ReleasesApi.md#releaseCreate) | **POST** /accounts/{account_id}/distributions/{distribution_id}/releases | Create a release
 *ReleasesApi* | [**releaseDelete**](docs/ReleasesApi.md#releaseDelete) | **DELETE** /accounts/{account_id}/distributions/{distribution_id}/releases/{id} | Delete a release
 *ReleasesApi* | [**releasePublish**](docs/ReleasesApi.md#releasePublish) | **POST** /accounts/{account_id}/distributions/{distribution_id}/releases/{id}/publish | Publish a release

diff --git a/api/openapi.yaml b/api/openapi.yaml
@@ -21625,9 +21625,10 @@ paths:
       x-cli-version: "2.5"
       x-content-type: application/json
       x-accepts: application/json
-  /projects/{id}/quality_performance_score:
+  /projects/{project_id}/quality_performance_score:
     post:
-      description: Get project's translations' quality performance scores
+      description: "Retrieves the quality scores for your Strings translations. Returns\
+        \ a score, measured by Phrase QPS"
       operationId: projects/quality_performance_score
       parameters:
       - description: Two-Factor-Authentication token (optional)
@@ -21638,10 +21639,10 @@ paths:
         schema:
           type: string
         style: simple
-      - description: ID
+      - description: Project ID
         explode: false
         in: path
-        name: id
+        name: project_id
         required: true
         schema:
           type: string
@@ -21710,21 +21711,21 @@ paths:
               $ref: '#/components/headers/X-Rate-Limit-Reset'
         "504":
           description: Gateway timeout
-      summary: Get project's translations' quality performance scores
+      summary: Get Translation Quality
       tags:
       - Quality performance score
       x-code-samples:
       - lang: Curl
         source: |-
-          curl "https://api.phrase.com/v2/projects/:id/quality_performance_score" \
+          curl "https://api.phrase.com/v2/projects/:project_id/quality_performance_score" \
             -X POST \
             -u USERNAME_OR_ACCESS_TOKEN \
             -d '{"translation_ids":["translation_id_1", "translation_id_2"]}' \
             -H 'Content-Type: application/json'
       - lang: CLI v2
         source: |-
           phrase projects quality_performance_score \
-          --id <id> \
+          --project_id <project_id> \
           --data '{"translation_ids":["translation_id_1", "translation_id_2"]}' \
           --access_token <token>
       x-cli-version: "2.20"
@@ -33205,7 +33206,7 @@ components:
         data:
           $ref: '#/components/schemas/projects_quality_performance_score_200_response_anyOf_data'
         errors:
-          description: Array of errors for any failing translation ids
+          description: Array of errors for any failing translation IDs
           items:
             $ref: '#/components/schemas/projects_quality_performance_score_200_response_anyOf_errors_inner'
           type: array

diff --git a/docs/ProjectsQualityPerformanceScore200Response.md b/docs/ProjectsQualityPerformanceScore200Response.md
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **error** | [**ErrorError**](ErrorError.md) |  |  [optional]
 **data** | [**ProjectsQualityPerformanceScore200ResponseAnyOfData**](ProjectsQualityPerformanceScore200ResponseAnyOfData.md) |  |  [optional]
-**errors** | [**List&lt;ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner&gt;**](ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner.md) | Array of errors for any failing translation ids |  [optional]
+**errors** | [**List&lt;ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner&gt;**](ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner.md) | Array of errors for any failing translation IDs |  [optional]
 
 
 
diff --git a/docs/ProjectsQualityPerformanceScore200ResponseAnyOf.md b/docs/ProjectsQualityPerformanceScore200ResponseAnyOf.md
@@ -7,7 +7,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **data** | [**ProjectsQualityPerformanceScore200ResponseAnyOfData**](ProjectsQualityPerformanceScore200ResponseAnyOfData.md) |  |  [optional]
-**errors** | [**List&lt;ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner&gt;**](ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner.md) | Array of errors for any failing translation ids |  [optional]
+**errors** | [**List&lt;ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner&gt;**](ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner.md) | Array of errors for any failing translation IDs |  [optional]
 
 
 
diff --git a/docs/QualityPerformanceScoreApi.md b/docs/QualityPerformanceScoreApi.md
@@ -4,16 +4,16 @@ 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&#39;s translations&#39; quality performance scores
+[**projectsQualityPerformanceScore**](QualityPerformanceScoreApi.md#projectsQualityPerformanceScore) | **POST** /projects/{project_id}/quality_performance_score | Get Translation Quality
 
 
 <a name="projectsQualityPerformanceScore"></a>
 # **projectsQualityPerformanceScore**
-> ProjectsQualityPerformanceScore200Response projectsQualityPerformanceScore(id, projectsQualityPerformanceScoreRequest, xPhraseAppOTP)
+> ProjectsQualityPerformanceScore200Response projectsQualityPerformanceScore(projectId, projectsQualityPerformanceScoreRequest, xPhraseAppOTP)
 
-Get project&#39;s translations&#39; quality performance scores
+Get Translation Quality
 
-Get project&#39;s translations&#39; quality performance scores
+Retrieves the quality scores for your Strings translations. Returns a score, measured by Phrase QPS
 
 ### Example
 ```java
@@ -41,11 +41,11 @@ public class Example {
     Token.setApiKeyPrefix("token");
 
     QualityPerformanceScoreApi apiInstance = new QualityPerformanceScoreApi(defaultClient);
-    String id = "id_example"; // String | ID
+    String projectId = "projectId_example"; // String | Project ID
     ProjectsQualityPerformanceScoreRequest projectsQualityPerformanceScoreRequest = new ProjectsQualityPerformanceScoreRequest(); // ProjectsQualityPerformanceScoreRequest | 
     String xPhraseAppOTP = "xPhraseAppOTP_example"; // String | Two-Factor-Authentication token (optional)
     try {
-      ProjectsQualityPerformanceScore200Response result = apiInstance.projectsQualityPerformanceScore(id, projectsQualityPerformanceScoreRequest, xPhraseAppOTP);
+      ProjectsQualityPerformanceScore200Response result = apiInstance.projectsQualityPerformanceScore(projectId, projectsQualityPerformanceScoreRequest, xPhraseAppOTP);
       System.out.println(result);
     } catch (ApiException e) {
       System.err.println("Exception when calling QualityPerformanceScoreApi#projectsQualityPerformanceScore");
@@ -62,7 +62,7 @@ public class Example {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **id** | **String**| ID |
+ **projectId** | **String**| Project ID |
  **projectsQualityPerformanceScoreRequest** | [**ProjectsQualityPerformanceScoreRequest**](ProjectsQualityPerformanceScoreRequest.md)|  |
  **xPhraseAppOTP** | **String**| Two-Factor-Authentication token (optional) | [optional]
 

diff --git a/src/main/java/com/phrase/client/ApiException.java b/src/main/java/com/phrase/client/ApiException.java
@@ -15,7 +15,7 @@
 import java.util.Map;
 import java.util.List;
 
-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-02-01T07:50:45.781353Z[Etc/UTC]")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-02-01T08:16:17.427160Z[Etc/UTC]")
 public class ApiException extends Exception {
     private int code = 0;
     private Map<String, List<String>> responseHeaders = null;

diff --git a/src/main/java/com/phrase/client/Configuration.java b/src/main/java/com/phrase/client/Configuration.java
@@ -12,7 +12,7 @@
 
 package com.phrase.client;
 
-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-02-01T07:50:45.781353Z[Etc/UTC]")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-02-01T08:16:17.427160Z[Etc/UTC]")
 public class Configuration {
     private static ApiClient defaultApiClient = new ApiClient();
 

diff --git a/src/main/java/com/phrase/client/Pair.java b/src/main/java/com/phrase/client/Pair.java
@@ -12,7 +12,7 @@
 
 package com.phrase.client;
 
-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-02-01T07:50:45.781353Z[Etc/UTC]")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-02-01T08:16:17.427160Z[Etc/UTC]")
 public class Pair {
     private String name = "";
     private String value = "";

diff --git a/src/main/java/com/phrase/client/StringUtil.java b/src/main/java/com/phrase/client/StringUtil.java
@@ -12,7 +12,7 @@
 
 package com.phrase.client;
 
-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-02-01T07:50:45.781353Z[Etc/UTC]")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-02-01T08:16:17.427160Z[Etc/UTC]")
 public class StringUtil {
   /**
    * Check if the given array contains the given value (with case-insensitive comparison).

diff --git a/src/main/java/com/phrase/client/api/QualityPerformanceScoreApi.java b/src/main/java/com/phrase/client/api/QualityPerformanceScoreApi.java
@@ -57,7 +57,7 @@ public void setApiClient(ApiClient apiClient) {
 
     /**
      * Build call for projectsQualityPerformanceScore
-     * @param id ID (required)
+     * @param projectId Project ID (required)
      * @param projectsQualityPerformanceScoreRequest  (required)
      * @param xPhraseAppOTP Two-Factor-Authentication token (optional) (optional)
      * @param _callback Callback for upload/download progress
@@ -75,12 +75,12 @@ public void setApiClient(ApiClient apiClient) {
         <tr><td> 504 </td><td> Gateway timeout </td><td>  -  </td></tr>
      </table>
      */
-    public okhttp3.Call projectsQualityPerformanceScoreCall(String id, ProjectsQualityPerformanceScoreRequest projectsQualityPerformanceScoreRequest, String xPhraseAppOTP, final ApiCallback _callback) throws ApiException {
+    public okhttp3.Call projectsQualityPerformanceScoreCall(String projectId, ProjectsQualityPerformanceScoreRequest projectsQualityPerformanceScoreRequest, String xPhraseAppOTP, final ApiCallback _callback) throws ApiException {
         Object localVarPostBody = projectsQualityPerformanceScoreRequest;
 
         // create path and map variables
-        String localVarPath = "/projects/{id}/quality_performance_score"
-            .replaceAll("\\{" + "id" + "\\}", localVarApiClient.escapeString(id.toString()));
+        String localVarPath = "/projects/{project_id}/quality_performance_score"
+            .replaceAll("\\{" + "project_id" + "\\}", localVarApiClient.escapeString(projectId.toString()));
 
         List<Pair> localVarQueryParams = new ArrayList<Pair>();
         List<Pair> localVarCollectionQueryParams = new ArrayList<Pair>();
@@ -110,11 +110,11 @@ public okhttp3.Call projectsQualityPerformanceScoreCall(String id, ProjectsQuali
     }
 
     @SuppressWarnings("rawtypes")
-    private okhttp3.Call projectsQualityPerformanceScoreValidateBeforeCall(String id, ProjectsQualityPerformanceScoreRequest projectsQualityPerformanceScoreRequest, String xPhraseAppOTP, final ApiCallback _callback) throws ApiException {
+    private okhttp3.Call projectsQualityPerformanceScoreValidateBeforeCall(String projectId, ProjectsQualityPerformanceScoreRequest projectsQualityPerformanceScoreRequest, String xPhraseAppOTP, final ApiCallback _callback) throws ApiException {
 
-        // verify the required parameter 'id' is set
-        if (id == null) {
-            throw new ApiException("Missing the required parameter 'id' when calling projectsQualityPerformanceScore(Async)");
+        // verify the required parameter 'projectId' is set
+        if (projectId == null) {
+            throw new ApiException("Missing the required parameter 'projectId' when calling projectsQualityPerformanceScore(Async)");
         }
 
         // verify the required parameter 'projectsQualityPerformanceScoreRequest' is set
@@ -123,15 +123,15 @@ private okhttp3.Call projectsQualityPerformanceScoreValidateBeforeCall(String id
         }
 
 
-        okhttp3.Call localVarCall = projectsQualityPerformanceScoreCall(id, projectsQualityPerformanceScoreRequest, xPhraseAppOTP, _callback);
+        okhttp3.Call localVarCall = projectsQualityPerformanceScoreCall(projectId, projectsQualityPerformanceScoreRequest, xPhraseAppOTP, _callback);
         return localVarCall;
 
     }
 
     /**
-     * Get project&#39;s translations&#39; quality performance scores
-     * Get project&#39;s translations&#39; quality performance scores
-     * @param id ID (required)
+     * Get Translation Quality
+     * Retrieves the quality scores for your Strings translations. Returns a score, measured by Phrase QPS
+     * @param projectId Project ID (required)
      * @param projectsQualityPerformanceScoreRequest  (required)
      * @param xPhraseAppOTP Two-Factor-Authentication token (optional) (optional)
      * @return ProjectsQualityPerformanceScore200Response
@@ -148,15 +148,15 @@ private okhttp3.Call projectsQualityPerformanceScoreValidateBeforeCall(String id
         <tr><td> 504 </td><td> Gateway timeout </td><td>  -  </td></tr>
      </table>
      */
-    public ProjectsQualityPerformanceScore200Response projectsQualityPerformanceScore(String id, ProjectsQualityPerformanceScoreRequest projectsQualityPerformanceScoreRequest, String xPhraseAppOTP) throws ApiException {
-        ApiResponse<ProjectsQualityPerformanceScore200Response> localVarResp = projectsQualityPerformanceScoreWithHttpInfo(id, projectsQualityPerformanceScoreRequest, xPhraseAppOTP);
+    public ProjectsQualityPerformanceScore200Response projectsQualityPerformanceScore(String projectId, ProjectsQualityPerformanceScoreRequest projectsQualityPerformanceScoreRequest, String xPhraseAppOTP) throws ApiException {
+        ApiResponse<ProjectsQualityPerformanceScore200Response> localVarResp = projectsQualityPerformanceScoreWithHttpInfo(projectId, projectsQualityPerformanceScoreRequest, xPhraseAppOTP);
         return localVarResp.getData();
     }
 
     /**
-     * Get project&#39;s translations&#39; quality performance scores
-     * Get project&#39;s translations&#39; quality performance scores
-     * @param id ID (required)
+     * Get Translation Quality
+     * Retrieves the quality scores for your Strings translations. Returns a score, measured by Phrase QPS
+     * @param projectId Project ID (required)
      * @param projectsQualityPerformanceScoreRequest  (required)
      * @param xPhraseAppOTP Two-Factor-Authentication token (optional) (optional)
      * @return ApiResponse&lt;ProjectsQualityPerformanceScore200Response&gt;
@@ -173,16 +173,16 @@ public ProjectsQualityPerformanceScore200Response projectsQualityPerformanceScor
         <tr><td> 504 </td><td> Gateway timeout </td><td>  -  </td></tr>
      </table>
      */
-    public ApiResponse<ProjectsQualityPerformanceScore200Response> projectsQualityPerformanceScoreWithHttpInfo(String id, ProjectsQualityPerformanceScoreRequest projectsQualityPerformanceScoreRequest, String xPhraseAppOTP) throws ApiException {
-        okhttp3.Call localVarCall = projectsQualityPerformanceScoreValidateBeforeCall(id, projectsQualityPerformanceScoreRequest, xPhraseAppOTP, null);
+    public ApiResponse<ProjectsQualityPerformanceScore200Response> projectsQualityPerformanceScoreWithHttpInfo(String projectId, ProjectsQualityPerformanceScoreRequest projectsQualityPerformanceScoreRequest, String xPhraseAppOTP) throws ApiException {
+        okhttp3.Call localVarCall = projectsQualityPerformanceScoreValidateBeforeCall(projectId, projectsQualityPerformanceScoreRequest, xPhraseAppOTP, null);
         Type localVarReturnType = new TypeToken<ProjectsQualityPerformanceScore200Response>(){}.getType();
         return localVarApiClient.execute(localVarCall, localVarReturnType);
     }
 
     /**
-     * Get project&#39;s translations&#39; quality performance scores (asynchronously)
-     * Get project&#39;s translations&#39; quality performance scores
-     * @param id ID (required)
+     * Get Translation Quality (asynchronously)
+     * Retrieves the quality scores for your Strings translations. Returns a score, measured by Phrase QPS
+     * @param projectId Project ID (required)
      * @param projectsQualityPerformanceScoreRequest  (required)
      * @param xPhraseAppOTP Two-Factor-Authentication token (optional) (optional)
      * @param _callback The callback to be executed when the API call finishes
@@ -200,9 +200,9 @@ public ApiResponse<ProjectsQualityPerformanceScore200Response> projectsQualityPe
         <tr><td> 504 </td><td> Gateway timeout </td><td>  -  </td></tr>
      </table>
      */
-    public okhttp3.Call projectsQualityPerformanceScoreAsync(String id, ProjectsQualityPerformanceScoreRequest projectsQualityPerformanceScoreRequest, String xPhraseAppOTP, final ApiCallback<ProjectsQualityPerformanceScore200Response> _callback) throws ApiException {
+    public okhttp3.Call projectsQualityPerformanceScoreAsync(String projectId, ProjectsQualityPerformanceScoreRequest projectsQualityPerformanceScoreRequest, String xPhraseAppOTP, final ApiCallback<ProjectsQualityPerformanceScore200Response> _callback) throws ApiException {
 
-        okhttp3.Call localVarCall = projectsQualityPerformanceScoreValidateBeforeCall(id, projectsQualityPerformanceScoreRequest, xPhraseAppOTP, _callback);
+        okhttp3.Call localVarCall = projectsQualityPerformanceScoreValidateBeforeCall(projectId, projectsQualityPerformanceScoreRequest, xPhraseAppOTP, _callback);
         Type localVarReturnType = new TypeToken<ProjectsQualityPerformanceScore200Response>(){}.getType();
         localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
         return localVarCall;

diff --git a/src/main/java/com/phrase/client/auth/ApiKeyAuth.java b/src/main/java/com/phrase/client/auth/ApiKeyAuth.java
@@ -17,7 +17,7 @@
 import java.util.Map;
 import java.util.List;
 
-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-02-01T07:50:45.781353Z[Etc/UTC]")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-02-01T08:16:17.427160Z[Etc/UTC]")
 public class ApiKeyAuth implements Authentication {
   private final String location;
   private final String paramName;

diff --git a/src/main/java/com/phrase/client/auth/HttpBearerAuth.java b/src/main/java/com/phrase/client/auth/HttpBearerAuth.java
@@ -17,7 +17,7 @@
 import java.util.Map;
 import java.util.List;
 
-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-02-01T07:50:45.781353Z[Etc/UTC]")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-02-01T08:16:17.427160Z[Etc/UTC]")
 public class HttpBearerAuth implements Authentication {
   private final String scheme;
   private String bearerToken;

diff --git a/src/main/java/com/phrase/client/model/AbstractOpenApiSchema.java b/src/main/java/com/phrase/client/model/AbstractOpenApiSchema.java
@@ -22,7 +22,7 @@
 /**
  * Abstract class for oneOf,anyOf schemas defined in OpenAPI spec
  */
-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-02-01T07:50:45.781353Z[Etc/UTC]")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-02-01T08:16:17.427160Z[Etc/UTC]")
 public abstract class AbstractOpenApiSchema {
 
     // store the actual instance of the schema/object

diff --git a/src/main/java/com/phrase/client/model/Account.java b/src/main/java/com/phrase/client/model/Account.java
@@ -27,7 +27,7 @@
 /**
  * Account
  */
-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-02-01T07:50:45.781353Z[Etc/UTC]")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-02-01T08:16:17.427160Z[Etc/UTC]")
 public class Account {
   public static final String SERIALIZED_NAME_ID = "id";
   @SerializedName(SERIALIZED_NAME_ID)