Deploying from phrase/strings-openapi@4099e32d

Author: Phrase

.openapi-generator/FILES

@@ -24,6 +24,7 @@ docs/BlacklistedKeyCreateParameters.md
 docs/BlacklistedKeyUpdateParameters.md
 docs/BlacklistedKeysApi.md
 docs/Branch.md
+docs/BranchCreateComparisonParameters.md
 docs/BranchCreateParameters.md
 docs/BranchMergeParameters.md
 docs/BranchName.md
@@ -359,6 +360,7 @@ phrase_api/models/blacklisted_key.py
 phrase_api/models/blacklisted_key_create_parameters.py
 phrase_api/models/blacklisted_key_update_parameters.py
 phrase_api/models/branch.py
+phrase_api/models/branch_create_comparison_parameters.py
 phrase_api/models/branch_create_parameters.py
 phrase_api/models/branch_merge_parameters.py
 phrase_api/models/branch_name.py
@@ -590,6 +592,7 @@ test/test_blacklisted_key_create_parameters.py
 test/test_blacklisted_key_update_parameters.py
 test/test_blacklisted_keys_api.py
 test/test_branch.py
+test/test_branch_create_comparison_parameters.py
 test/test_branch_create_parameters.py
 test/test_branch_merge_parameters.py
 test/test_branch_name.py

README.md

@@ -166,6 +166,7 @@ Class | Method | HTTP request | Description
 *BlacklistedKeysApi* | [**blacklisted_key_update**](docs/BlacklistedKeysApi.md#blacklisted_key_update) | **PATCH** /projects/{project_id}/blacklisted_keys/{id} | Update a blocked key
 *BlacklistedKeysApi* | [**blacklisted_keys_list**](docs/BlacklistedKeysApi.md#blacklisted_keys_list) | **GET** /projects/{project_id}/blacklisted_keys | List blocked keys
 *BranchesApi* | [**branch_compare**](docs/BranchesApi.md#branch_compare) | **GET** /projects/{project_id}/branches/{name}/compare | Compare branches
+*BranchesApi* | [**branch_comparison_create**](docs/BranchesApi.md#branch_comparison_create) | **POST** /projects/{project_id}/branches/{name}/compare | Create comparison (async.)
 *BranchesApi* | [**branch_create**](docs/BranchesApi.md#branch_create) | **POST** /projects/{project_id}/branches | Create a branch
 *BranchesApi* | [**branch_delete**](docs/BranchesApi.md#branch_delete) | **DELETE** /projects/{project_id}/branches/{name} | Delete a branch
 *BranchesApi* | [**branch_merge**](docs/BranchesApi.md#branch_merge) | **PATCH** /projects/{project_id}/branches/{name}/merge | Merge a branch
@@ -449,6 +450,7 @@ Class | Method | HTTP request | Description
  - [BlacklistedKeyCreateParameters](docs/BlacklistedKeyCreateParameters.md)
  - [BlacklistedKeyUpdateParameters](docs/BlacklistedKeyUpdateParameters.md)
  - [Branch](docs/Branch.md)
+ - [BranchCreateComparisonParameters](docs/BranchCreateComparisonParameters.md)
  - [BranchCreateParameters](docs/BranchCreateParameters.md)
  - [BranchMergeParameters](docs/BranchMergeParameters.md)
  - [BranchName](docs/BranchName.md)

docs/BranchCreateComparisonParameters.md

@@ -0,0 +1,10 @@
+# BranchCreateComparisonParameters
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**direction** | **str** | direction of comparison, possible values are sync or merge (only for v2 branches) | [optional] [default to 'merge']
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

docs/BranchesApi.md

@@ -5,6 +5,7 @@ All URIs are relative to *https://api.phrase.com/v2*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**branch_compare**](BranchesApi.md#branch_compare) | **GET** /projects/{project_id}/branches/{name}/compare | Compare branches
+[**branch_comparison_create**](BranchesApi.md#branch_comparison_create) | **POST** /projects/{project_id}/branches/{name}/compare | Create comparison (async.)
 [**branch_create**](BranchesApi.md#branch_create) | **POST** /projects/{project_id}/branches | Create a branch
 [**branch_delete**](BranchesApi.md#branch_delete) | **DELETE** /projects/{project_id}/branches/{name} | Delete a branch
 [**branch_merge**](BranchesApi.md#branch_merge) | **PATCH** /projects/{project_id}/branches/{name}/merge | Merge a branch
@@ -19,7 +20,7 @@ Method | HTTP request | Description
 
 Compare branches
 
-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.* 
 
 ### Example
 
@@ -77,6 +78,77 @@ void (empty response body)
 **200** | OK |  * X-Rate-Limit-Limit -  <br>  * X-Rate-Limit-Remaining -  <br>  * X-Rate-Limit-Reset -  <br>  |
 **400** | Bad request |  * X-Rate-Limit-Limit -  <br>  * X-Rate-Limit-Remaining -  <br>  * X-Rate-Limit-Reset -  <br>  |
 **404** | Not Found |  * X-Rate-Limit-Limit -  <br>  * X-Rate-Limit-Remaining -  <br>  * X-Rate-Limit-Reset -  <br>  |
+**409** | Conflict |  * X-Rate-Limit-Limit -  <br>  * X-Rate-Limit-Remaining -  <br>  * X-Rate-Limit-Reset -  <br>  |
+**429** | Rate Limiting |  * X-Rate-Limit-Limit -  <br>  * X-Rate-Limit-Remaining -  <br>  * X-Rate-Limit-Reset -  <br>  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **branch_comparison_create**
+> branch_comparison_create(project_id, name, branch_create_comparison_parameters, x_phrase_app_otp=x_phrase_app_otp)
+
+Create comparison (async.)
+
+Create a branch comparison asynchronously. 
+
+### Example
+
+```python
+from __future__ import print_function
+import time
+import phrase_api
+from phrase_api.rest import ApiException
+from pprint import pprint
+
+configuration = phrase_api.Configuration()
+configuration.api_key['Authorization'] = 'YOUR_API_KEY'
+configuration.api_key_prefix['Authorization'] = 'token'
+
+# Enter a context with an instance of the API client
+with phrase_api.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = phrase_api.BranchesApi(api_client)
+    project_id = 'project_id_example' # str | Project ID (required)
+    name = 'name_example' # str | name (required)
+    branch_create_comparison_parameters = phrase_api.BranchCreateComparisonParameters() # BranchCreateComparisonParameters |  (required)
+    x_phrase_app_otp = 'x_phrase_app_otp_example' # str | Two-Factor-Authentication token (optional)
+
+    try:
+        # Create comparison (async.)
+        api_instance.branch_comparison_create(project_id, name, branch_create_comparison_parameters, x_phrase_app_otp=x_phrase_app_otp)
+    except ApiException as e:
+        print("Exception when calling BranchesApi->branch_comparison_create: %s\n" % e)
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **str**| Project ID | 
+ **name** | **str**| name | 
+ **branch_create_comparison_parameters** | [**BranchCreateComparisonParameters**](BranchCreateComparisonParameters.md)|  | 
+ **x_phrase_app_otp** | **str**| Two-Factor-Authentication token (optional) | [optional] 
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**202** | Accepted |  * X-Rate-Limit-Limit -  <br>  * X-Rate-Limit-Remaining -  <br>  * X-Rate-Limit-Reset -  <br>  |
+**400** | Bad request |  * X-Rate-Limit-Limit -  <br>  * X-Rate-Limit-Remaining -  <br>  * X-Rate-Limit-Reset -  <br>  |
+**404** | Not Found |  * X-Rate-Limit-Limit -  <br>  * X-Rate-Limit-Remaining -  <br>  * X-Rate-Limit-Reset -  <br>  |
+**409** | Conflict |  * X-Rate-Limit-Limit -  <br>  * X-Rate-Limit-Remaining -  <br>  * X-Rate-Limit-Reset -  <br>  |
 **429** | Rate Limiting |  * X-Rate-Limit-Limit -  <br>  * X-Rate-Limit-Remaining -  <br>  * X-Rate-Limit-Reset -  <br>  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
@@ -358,7 +430,7 @@ Name | Type | Description  | Notes
 
 Sync a branch
 
-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.* 
 
 ### Example
 

phrase_api/__init__.py

@@ -98,6 +98,7 @@
 from phrase_api.models.blacklisted_key_create_parameters import BlacklistedKeyCreateParameters
 from phrase_api.models.blacklisted_key_update_parameters import BlacklistedKeyUpdateParameters
 from phrase_api.models.branch import Branch
+from phrase_api.models.branch_create_comparison_parameters import BranchCreateComparisonParameters
 from phrase_api.models.branch_create_parameters import BranchCreateParameters
 from phrase_api.models.branch_merge_parameters import BranchMergeParameters
 from phrase_api.models.branch_name import BranchName

phrase_api/api/branches_api.py

@@ -38,7 +38,7 @@ def __init__(self, api_client=None):
     def branch_compare(self, project_id, name, **kwargs):  # noqa: E501
         """Compare branches  # noqa: E501
 
-        Compare branch with main branch.   *Note: Comparing a branch may take several minutes depending on the project size.*   # noqa: E501
+        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.*   # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
         >>> thread = api.branch_compare(project_id, name, async_req=True)
@@ -65,7 +65,7 @@ def branch_compare(self, project_id, name, **kwargs):  # noqa: E501
     def branch_compare_with_http_info(self, project_id, name, **kwargs):  # noqa: E501
         """Compare branches  # noqa: E501
 
-        Compare branch with main branch.   *Note: Comparing a branch may take several minutes depending on the project size.*   # noqa: E501
+        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.*   # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
         >>> thread = api.branch_compare_with_http_info(project_id, name, async_req=True)
@@ -159,6 +159,143 @@ def branch_compare_with_http_info(self, project_id, name, **kwargs):  # noqa: E5
             _request_timeout=local_var_params.get('_request_timeout'),
             collection_formats=collection_formats)
 
+    def branch_comparison_create(self, project_id, name, branch_create_comparison_parameters, **kwargs):  # noqa: E501
+        """Create comparison (async.)  # noqa: E501
+
+        Create a branch comparison asynchronously.   # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.branch_comparison_create(project_id, name, branch_create_comparison_parameters, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool: execute request asynchronously
+        :param str project_id: Project ID (required)
+        :param str name: name (required)
+        :param BranchCreateComparisonParameters branch_create_comparison_parameters: (required)
+        :param str x_phrase_app_otp: Two-Factor-Authentication token (optional)
+        :param _preload_content: if False, the urllib3.HTTPResponse object will
+                                 be returned without reading/decoding response
+                                 data. Default is True.
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :return: None
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        return self.branch_comparison_create_with_http_info(project_id, name, branch_create_comparison_parameters, **kwargs)  # noqa: E501
+
+    def branch_comparison_create_with_http_info(self, project_id, name, branch_create_comparison_parameters, **kwargs):  # noqa: E501
+        """Create comparison (async.)  # noqa: E501
+
+        Create a branch comparison asynchronously.   # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.branch_comparison_create_with_http_info(project_id, name, branch_create_comparison_parameters, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool: execute request asynchronously
+        :param str project_id: Project ID (required)
+        :param str name: name (required)
+        :param BranchCreateComparisonParameters branch_create_comparison_parameters: (required)
+        :param str x_phrase_app_otp: Two-Factor-Authentication token (optional)
+        :param _return_http_data_only: response data without head status code
+                                       and headers
+        :param _preload_content: if False, the urllib3.HTTPResponse object will
+                                 be returned without reading/decoding response
+                                 data. Default is True.
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :return: None
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        local_var_params = locals()
+
+        all_params = [
+            'project_id',
+            'name',
+            'branch_create_comparison_parameters',
+            'x_phrase_app_otp'
+        ]
+        all_params.extend(
+            [
+                'async_req',
+                '_return_http_data_only',
+                '_preload_content',
+                '_request_timeout'
+            ]
+        )
+
+        for key, val in six.iteritems(local_var_params['kwargs']):
+            if key not in all_params:
+                raise ApiTypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method branch_comparison_create" % key
+                )
+            local_var_params[key] = val
+        del local_var_params['kwargs']
+        # verify the required parameter 'project_id' is set
+        if self.api_client.client_side_validation and ('project_id' not in local_var_params or  # noqa: E501
+                                                        local_var_params['project_id'] is None):  # noqa: E501
+            raise ApiValueError("Missing the required parameter `project_id` when calling `branch_comparison_create`")  # noqa: E501
+        # verify the required parameter 'name' is set
+        if self.api_client.client_side_validation and ('name' not in local_var_params or  # noqa: E501
+                                                        local_var_params['name'] is None):  # noqa: E501
+            raise ApiValueError("Missing the required parameter `name` when calling `branch_comparison_create`")  # noqa: E501
+        # verify the required parameter 'branch_create_comparison_parameters' is set
+        if self.api_client.client_side_validation and ('branch_create_comparison_parameters' not in local_var_params or  # noqa: E501
+                                                        local_var_params['branch_create_comparison_parameters'] is None):  # noqa: E501
+            raise ApiValueError("Missing the required parameter `branch_create_comparison_parameters` when calling `branch_comparison_create`")  # noqa: E501
+
+        collection_formats = {}
+
+        path_params = {}
+        if 'project_id' in local_var_params:
+            path_params['project_id'] = local_var_params['project_id']  # noqa: E501
+        if 'name' in local_var_params:
+            path_params['name'] = local_var_params['name']  # noqa: E501
+
+        query_params = []
+
+        header_params = {}
+        if 'x_phrase_app_otp' in local_var_params:
+            header_params['X-PhraseApp-OTP'] = local_var_params['x_phrase_app_otp']  # noqa: E501
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        if 'branch_create_comparison_parameters' in local_var_params:
+            body_params = local_var_params['branch_create_comparison_parameters']
+        # HTTP header `Content-Type`
+        header_params['Content-Type'] = self.api_client.select_header_content_type(  # noqa: E501
+            ['application/json'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = ['Basic', 'Token']  # noqa: E501
+
+        return self.api_client.call_api(
+            '/projects/{project_id}/branches/{name}/compare', 'POST',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type=None,  # noqa: E501
+            auth_settings=auth_settings,
+            async_req=local_var_params.get('async_req'),
+            _return_http_data_only=local_var_params.get('_return_http_data_only'),  # noqa: E501
+            _preload_content=local_var_params.get('_preload_content', True),
+            _request_timeout=local_var_params.get('_request_timeout'),
+            collection_formats=collection_formats)
+
     def branch_create(self, project_id, branch_create_parameters, **kwargs):  # noqa: E501
         """Create a branch  # noqa: E501
 
@@ -683,7 +820,7 @@ def branch_show_with_http_info(self, project_id, name, **kwargs):  # noqa: E501
     def branch_sync(self, project_id, name, branch_sync_parameters, **kwargs):  # noqa: E501
         """Sync a branch  # noqa: E501
 
-        Sync an existing branch.  *Note: Only available for branches created with new branching. New branching is currently in private beta*   # noqa: E501
+        Sync an existing branch.  *Note: Only available for branches created with new branching.*   # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
         >>> thread = api.branch_sync(project_id, name, branch_sync_parameters, async_req=True)
@@ -711,7 +848,7 @@ def branch_sync(self, project_id, name, branch_sync_parameters, **kwargs):  # no
     def branch_sync_with_http_info(self, project_id, name, branch_sync_parameters, **kwargs):  # noqa: E501
         """Sync a branch  # noqa: E501
 
-        Sync an existing branch.  *Note: Only available for branches created with new branching. New branching is currently in private beta*   # noqa: E501
+        Sync an existing branch.  *Note: Only available for branches created with new branching.*   # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
         >>> thread = api.branch_sync_with_http_info(project_id, name, branch_sync_parameters, async_req=True)

phrase_api/models/__init__.py

@@ -29,6 +29,7 @@
 from phrase_api.models.blacklisted_key_create_parameters import BlacklistedKeyCreateParameters
 from phrase_api.models.blacklisted_key_update_parameters import BlacklistedKeyUpdateParameters
 from phrase_api.models.branch import Branch
+from phrase_api.models.branch_create_comparison_parameters import BranchCreateComparisonParameters
 from phrase_api.models.branch_create_parameters import BranchCreateParameters
 from phrase_api.models.branch_merge_parameters import BranchMergeParameters
 from phrase_api.models.branch_name import BranchName