Deploying from phrase/strings-openapi@6a696db0

Author: Phrase

.openapi-generator/FILES

@@ -247,6 +247,7 @@ src/models/TranslationKeyDetails.ts
 src/models/TranslationOrder.ts
 src/models/TranslationParent.ts
 src/models/TranslationReviewParameters.ts
+src/models/TranslationUnreviewParameters.ts
 src/models/TranslationUnverifyParameters.ts
 src/models/TranslationUpdateParameters.ts
 src/models/TranslationVerifyParameters.ts
@@ -256,6 +257,7 @@ src/models/TranslationsExcludeParameters.ts
 src/models/TranslationsIncludeParameters.ts
 src/models/TranslationsReviewParameters.ts
 src/models/TranslationsSearchParameters.ts
+src/models/TranslationsUnreviewParameters.ts
 src/models/TranslationsUnverifyParameters.ts
 src/models/TranslationsVerifyParameters.ts
 src/models/Upload.ts

README.md

@@ -433,6 +433,7 @@ Class | Method | HTTP request | Description
 *TranslationsApi* | **translationInclude** | **PATCH** /projects/{project_id}/translations/{id}/include | Include a translation
 *TranslationsApi* | **translationReview** | **PATCH** /projects/{project_id}/translations/{id}/review | Review a translation
 *TranslationsApi* | **translationShow** | **GET** /projects/{project_id}/translations/{id} | Get a single translation
+*TranslationsApi* | **translationUnreview** | **PATCH** /projects/{project_id}/translations/{id}/unreview | Unreview a translation
 *TranslationsApi* | **translationUnverify** | **PATCH** /projects/{project_id}/translations/{id}/unverify | Mark a translation as unverified
 *TranslationsApi* | **translationUpdate** | **PATCH** /projects/{project_id}/translations/{id} | Update a translation
 *TranslationsApi* | **translationVerify** | **PATCH** /projects/{project_id}/translations/{id}/verify | Verify a translation
@@ -443,6 +444,7 @@ Class | Method | HTTP request | Description
 *TranslationsApi* | **translationsList** | **GET** /projects/{project_id}/translations | List all translations
 *TranslationsApi* | **translationsReviewCollection** | **PATCH** /projects/{project_id}/translations/review | Review translations selected by query
 *TranslationsApi* | **translationsSearch** | **POST** /projects/{project_id}/translations/search | Search translations
+*TranslationsApi* | **translationsUnreviewCollection** | **PATCH** /projects/{project_id}/translations/unreview | Unreview translations selected by query
 *TranslationsApi* | **translationsUnverifyCollection** | **PATCH** /projects/{project_id}/translations/unverify | Unverify translations by query
 *TranslationsApi* | **translationsVerifyCollection** | **PATCH** /projects/{project_id}/translations/verify | Verify translations by query
 *UploadsApi* | **uploadCreate** | **POST** /projects/{project_id}/uploads | Upload a new file

src/apis/TranslationsApi.ts

@@ -35,6 +35,9 @@ import {
     TranslationReviewParameters,
     TranslationReviewParametersFromJSON,
     TranslationReviewParametersToJSON,
+    TranslationUnreviewParameters,
+    TranslationUnreviewParametersFromJSON,
+    TranslationUnreviewParametersToJSON,
     TranslationUnverifyParameters,
     TranslationUnverifyParametersFromJSON,
     TranslationUnverifyParametersToJSON,
@@ -56,6 +59,9 @@ import {
     TranslationsSearchParameters,
     TranslationsSearchParametersFromJSON,
     TranslationsSearchParametersToJSON,
+    TranslationsUnreviewParameters,
+    TranslationsUnreviewParametersFromJSON,
+    TranslationsUnreviewParametersToJSON,
     TranslationsUnverifyParameters,
     TranslationsUnverifyParametersFromJSON,
     TranslationsUnverifyParametersToJSON,
@@ -98,6 +104,13 @@ export interface TranslationShowRequest {
     branch?: string;
 }
 
+export interface TranslationUnreviewRequest {
+    projectId: string;
+    id: string;
+    translationUnreviewParameters: TranslationUnreviewParameters;
+    xPhraseAppOTP?: string;
+}
+
 export interface TranslationUnverifyRequest {
     projectId: string;
     id: string;
@@ -182,6 +195,12 @@ export interface TranslationsSearchRequest {
     perPage?: number;
 }
 
+export interface TranslationsUnreviewCollectionRequest {
+    projectId: string;
+    translationsUnreviewParameters: TranslationsUnreviewParameters;
+    xPhraseAppOTP?: string;
+}
+
 export interface TranslationsUnverifyCollectionRequest {
     projectId: string;
     translationsUnverifyParameters: TranslationsUnverifyParameters;
@@ -462,6 +481,60 @@ export class TranslationsApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Mark a reviewed translation as translated.
+     * Unreview a translation
+     */
+    async translationUnreviewRaw(requestParameters: TranslationUnreviewRequest): Promise<runtime.ApiResponse<TranslationDetails>> {
+        if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
+            throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling translationUnreview.');
+        }
+
+        if (requestParameters.id === null || requestParameters.id === undefined) {
+            throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling translationUnreview.');
+        }
+
+        if (requestParameters.translationUnreviewParameters === null || requestParameters.translationUnreviewParameters === undefined) {
+            throw new runtime.RequiredError('translationUnreviewParameters','Required parameter requestParameters.translationUnreviewParameters was null or undefined when calling translationUnreview.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (requestParameters.xPhraseAppOTP !== undefined && requestParameters.xPhraseAppOTP !== null) {
+            headerParameters['X-PhraseApp-OTP'] = String(requestParameters.xPhraseAppOTP);
+        }
+
+        if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
+            headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
+        }
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // Token authentication
+        }
+
+        const response = await this.request({
+            path: `/projects/{project_id}/translations/{id}/unreview`.replace(`{${"project_id"}}`, encodeURIComponent(String(requestParameters.projectId))).replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))),
+            method: 'PATCH',
+            headers: headerParameters,
+            query: queryParameters,
+            body: TranslationUnreviewParametersToJSON(requestParameters.translationUnreviewParameters),
+        });
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => TranslationDetailsFromJSON(jsonValue));
+    }
+
+    /**
+     * Mark a reviewed translation as translated.
+     * Unreview a translation
+     */
+    async translationUnreview(requestParameters: TranslationUnreviewRequest): Promise<TranslationDetails> {
+        const response = await this.translationUnreviewRaw(requestParameters);
+        return await response.value();
+    }
+
     /**
      * Mark an existing translation as unverified.
      * Mark a translation as unverified
@@ -1049,6 +1122,56 @@ export class TranslationsApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Unreview translations matching query.
+     * Unreview translations selected by query
+     */
+    async translationsUnreviewCollectionRaw(requestParameters: TranslationsUnreviewCollectionRequest): Promise<runtime.ApiResponse<AffectedCount>> {
+        if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
+            throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling translationsUnreviewCollection.');
+        }
+
+        if (requestParameters.translationsUnreviewParameters === null || requestParameters.translationsUnreviewParameters === undefined) {
+            throw new runtime.RequiredError('translationsUnreviewParameters','Required parameter requestParameters.translationsUnreviewParameters was null or undefined when calling translationsUnreviewCollection.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (requestParameters.xPhraseAppOTP !== undefined && requestParameters.xPhraseAppOTP !== null) {
+            headerParameters['X-PhraseApp-OTP'] = String(requestParameters.xPhraseAppOTP);
+        }
+
+        if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
+            headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
+        }
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // Token authentication
+        }
+
+        const response = await this.request({
+            path: `/projects/{project_id}/translations/unreview`.replace(`{${"project_id"}}`, encodeURIComponent(String(requestParameters.projectId))),
+            method: 'PATCH',
+            headers: headerParameters,
+            query: queryParameters,
+            body: TranslationsUnreviewParametersToJSON(requestParameters.translationsUnreviewParameters),
+        });
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => AffectedCountFromJSON(jsonValue));
+    }
+
+    /**
+     * Unreview translations matching query.
+     * Unreview translations selected by query
+     */
+    async translationsUnreviewCollection(requestParameters: TranslationsUnreviewCollectionRequest): Promise<AffectedCount> {
+        const response = await this.translationsUnreviewCollectionRaw(requestParameters);
+        return await response.value();
+    }
+
     /**
      * Mark translations matching query as unverified.
      * Unverify translations by query

src/models/TranslationUnreviewParameters.ts

@@ -0,0 +1,56 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Phrase Strings API Reference
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@phrase.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface TranslationUnreviewParameters
+ */
+export interface TranslationUnreviewParameters {
+    /**
+     * specify the branch to use
+     * @type {string}
+     * @memberof TranslationUnreviewParameters
+     */
+    branch?: string;
+}
+
+export function TranslationUnreviewParametersFromJSON(json: any): TranslationUnreviewParameters {
+    return TranslationUnreviewParametersFromJSONTyped(json, false);
+}
+
+export function TranslationUnreviewParametersFromJSONTyped(json: any, ignoreDiscriminator: boolean): TranslationUnreviewParameters {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'branch': !exists(json, 'branch') ? undefined : json['branch'],
+    };
+}
+
+export function TranslationUnreviewParametersToJSON(value?: TranslationUnreviewParameters | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'branch': value.branch,
+    };
+}
+
+

src/models/TranslationsUnreviewParameters.ts

@@ -0,0 +1,64 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Phrase Strings API Reference
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@phrase.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface TranslationsUnreviewParameters
+ */
+export interface TranslationsUnreviewParameters {
+    /**
+     * specify the branch to use
+     * @type {string}
+     * @memberof TranslationsUnreviewParameters
+     */
+    branch?: string;
+    /**
+     * Specify a query to find translations by content (including wildcards).<br><br> <i>Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).</i><br> The following qualifiers are supported in the query:<br> <ul>   <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li>   <li><code>tags:XYZ</code> for tags on the translation</li>   <li><code>unverified:{true|false}</code> for verification status</li>   <li><code>excluded:{true|false}</code> for exclusion status</li>   <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>. 
+     * @type {string}
+     * @memberof TranslationsUnreviewParameters
+     */
+    q?: string;
+}
+
+export function TranslationsUnreviewParametersFromJSON(json: any): TranslationsUnreviewParameters {
+    return TranslationsUnreviewParametersFromJSONTyped(json, false);
+}
+
+export function TranslationsUnreviewParametersFromJSONTyped(json: any, ignoreDiscriminator: boolean): TranslationsUnreviewParameters {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'branch': !exists(json, 'branch') ? undefined : json['branch'],
+        'q': !exists(json, 'q') ? undefined : json['q'],
+    };
+}
+
+export function TranslationsUnreviewParametersToJSON(value?: TranslationsUnreviewParameters | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'branch': value.branch,
+        'q': value.q,
+    };
+}
+
+

src/models/index.ts

@@ -186,6 +186,7 @@ export * from './TranslationKeyDetails';
 export * from './TranslationOrder';
 export * from './TranslationParent';
 export * from './TranslationReviewParameters';
+export * from './TranslationUnreviewParameters';
 export * from './TranslationUnverifyParameters';
 export * from './TranslationUpdateParameters';
 export * from './TranslationVerifyParameters';
@@ -195,6 +196,7 @@ export * from './TranslationsExcludeParameters';
 export * from './TranslationsIncludeParameters';
 export * from './TranslationsReviewParameters';
 export * from './TranslationsSearchParameters';
+export * from './TranslationsUnreviewParameters';
 export * from './TranslationsUnverifyParameters';
 export * from './TranslationsVerifyParameters';
 export * from './Upload';