Deploying from phrase/strings-openapi@4099e32d

Author: Phrase

.openapi-generator/FILES

@@ -77,6 +77,7 @@ src/models/BlacklistedKey.ts
 src/models/BlacklistedKeyCreateParameters.ts
 src/models/BlacklistedKeyUpdateParameters.ts
 src/models/Branch.ts
+src/models/BranchCreateComparisonParameters.ts
 src/models/BranchCreateParameters.ts
 src/models/BranchMergeParameters.ts
 src/models/BranchName.ts

README.md

@@ -219,6 +219,7 @@ Class | Method | HTTP request | Description
 *BlacklistedKeysApi* | **blacklistedKeyUpdate** | **PATCH** /projects/{project_id}/blacklisted_keys/{id} | Update a blocked key
 *BlacklistedKeysApi* | **blacklistedKeysList** | **GET** /projects/{project_id}/blacklisted_keys | List blocked keys
 *BranchesApi* | **branchCompare** | **GET** /projects/{project_id}/branches/{name}/compare | Compare branches
+*BranchesApi* | **branchComparisonCreate** | **POST** /projects/{project_id}/branches/{name}/compare | Create comparison (async.)
 *BranchesApi* | **branchCreate** | **POST** /projects/{project_id}/branches | Create a branch
 *BranchesApi* | **branchDelete** | **DELETE** /projects/{project_id}/branches/{name} | Delete a branch
 *BranchesApi* | **branchMerge** | **PATCH** /projects/{project_id}/branches/{name}/merge | Merge a branch

src/apis/BranchesApi.ts

@@ -17,6 +17,9 @@ import {
     Branch,
     BranchFromJSON,
     BranchToJSON,
+    BranchCreateComparisonParameters,
+    BranchCreateComparisonParametersFromJSON,
+    BranchCreateComparisonParametersToJSON,
     BranchCreateParameters,
     BranchCreateParametersFromJSON,
     BranchCreateParametersToJSON,
@@ -37,6 +40,13 @@ export interface BranchCompareRequest {
     xPhraseAppOTP?: string;
 }
 
+export interface BranchComparisonCreateRequest {
+    projectId: string;
+    name: string;
+    branchCreateComparisonParameters: BranchCreateComparisonParameters;
+    xPhraseAppOTP?: string;
+}
+
 export interface BranchCreateRequest {
     projectId: string;
     branchCreateParameters: BranchCreateParameters;
@@ -89,7 +99,7 @@ export interface BranchesListRequest {
 export class BranchesApi extends runtime.BaseAPI {
 
     /**
-     * Compare branch with main branch.   *Note: Comparing a branch may take several minutes depending on the project size.* 
+     * Compare branch with main branch.  *Note: Comparing a branch may take several minutes depending on the project size. Consider using the `POST /compare` endpoint for creating comparison asynchronously.* 
      * Compare branches
      */
     async branchCompareRaw(requestParameters: BranchCompareRequest): Promise<runtime.ApiResponse<any>> {
@@ -127,14 +137,68 @@ export class BranchesApi extends runtime.BaseAPI {
     }
 
     /**
-     * Compare branch with main branch.   *Note: Comparing a branch may take several minutes depending on the project size.* 
+     * Compare branch with main branch.  *Note: Comparing a branch may take several minutes depending on the project size. Consider using the `POST /compare` endpoint for creating comparison asynchronously.* 
      * Compare branches
      */
     async branchCompare(requestParameters: BranchCompareRequest): Promise<any> {
         const response = await this.branchCompareRaw(requestParameters);
         return await response.value();
     }
 
+    /**
+     * Create a branch comparison asynchronously. 
+     * Create comparison (async.)
+     */
+    async branchComparisonCreateRaw(requestParameters: BranchComparisonCreateRequest): Promise<runtime.ApiResponse<any>> {
+        if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
+            throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling branchComparisonCreate.');
+        }
+
+        if (requestParameters.name === null || requestParameters.name === undefined) {
+            throw new runtime.RequiredError('name','Required parameter requestParameters.name was null or undefined when calling branchComparisonCreate.');
+        }
+
+        if (requestParameters.branchCreateComparisonParameters === null || requestParameters.branchCreateComparisonParameters === undefined) {
+            throw new runtime.RequiredError('branchCreateComparisonParameters','Required parameter requestParameters.branchCreateComparisonParameters was null or undefined when calling branchComparisonCreate.');
+        }
+
+        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}/branches/{name}/compare`.replace(`{${"project_id"}}`, encodeURIComponent(String(requestParameters.projectId))).replace(`{${"name"}}`, encodeURIComponent(String(requestParameters.name))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: BranchCreateComparisonParametersToJSON(requestParameters.branchCreateComparisonParameters),
+        });
+
+        return new runtime.TextApiResponse(response) as any;
+    }
+
+    /**
+     * Create a branch comparison asynchronously. 
+     * Create comparison (async.)
+     */
+    async branchComparisonCreate(requestParameters: BranchComparisonCreateRequest): Promise<any> {
+        const response = await this.branchComparisonCreateRaw(requestParameters);
+        return await response.value();
+    }
+
     /**
      * Create a new branch.  *Note: Creating a new branch may take several minutes depending on the project size.* 
      * Create a branch
@@ -334,7 +398,7 @@ export class BranchesApi extends runtime.BaseAPI {
     }
 
     /**
-     * Sync an existing branch.  *Note: Only available for branches created with new branching. New branching is currently in private beta* 
+     * Sync an existing branch.  *Note: Only available for branches created with new branching.* 
      * Sync a branch
      */
     async branchSyncRaw(requestParameters: BranchSyncRequest): Promise<runtime.ApiResponse<any>> {
@@ -379,7 +443,7 @@ export class BranchesApi extends runtime.BaseAPI {
     }
 
     /**
-     * Sync an existing branch.  *Note: Only available for branches created with new branching. New branching is currently in private beta* 
+     * Sync an existing branch.  *Note: Only available for branches created with new branching.* 
      * Sync a branch
      */
     async branchSync(requestParameters: BranchSyncRequest): Promise<any> {

src/models/BranchCreateComparisonParameters.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 BranchCreateComparisonParameters
+ */
+export interface BranchCreateComparisonParameters {
+    /**
+     * direction of comparison, possible values are sync or merge (only for v2 branches)
+     * @type {string}
+     * @memberof BranchCreateComparisonParameters
+     */
+    direction?: string;
+}
+
+export function BranchCreateComparisonParametersFromJSON(json: any): BranchCreateComparisonParameters {
+    return BranchCreateComparisonParametersFromJSONTyped(json, false);
+}
+
+export function BranchCreateComparisonParametersFromJSONTyped(json: any, ignoreDiscriminator: boolean): BranchCreateComparisonParameters {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'direction': !exists(json, 'direction') ? undefined : json['direction'],
+    };
+}
+
+export function BranchCreateComparisonParametersToJSON(value?: BranchCreateComparisonParameters | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'direction': value.direction,
+    };
+}
+
+

src/models/index.ts

@@ -14,6 +14,7 @@ export * from './BlacklistedKey';
 export * from './BlacklistedKeyCreateParameters';
 export * from './BlacklistedKeyUpdateParameters';
 export * from './Branch';
+export * from './BranchCreateComparisonParameters';
 export * from './BranchCreateParameters';
 export * from './BranchMergeParameters';
 export * from './BranchName';