phrase-api 3.8.0__tar.gz → 3.9.0__tar.gz

{phrase_api-3.8.0 → phrase_api-3.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: phrase-api
-Version: 3.8.0
+Version: 3.9.0
 Summary: Phrase Strings API Reference
 Home-page: https://github.com/phrase/phrase-python
 Author: Phrase Support

{phrase_api-3.8.0 → phrase_api-3.9.0}/README.md

@@ -5,7 +5,7 @@ Phrase Strings is a translation management platform for software projects. You c
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 3.8.0
+- Package version: 3.9.0
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 For more information, please visit [https://developers.phrase.com/api/](https://developers.phrase.com/api/)
 
@@ -169,6 +169,7 @@ Class | Method | HTTP request | Description
 *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
 *BranchesApi* | [**branch_show**](docs/BranchesApi.md#branch_show) | **GET** /projects/{project_id}/branches/{name} | Get a single branch
+*BranchesApi* | [**branch_sync**](docs/BranchesApi.md#branch_sync) | **PATCH** /projects/{project_id}/branches/{name}/sync | Sync a branch
 *BranchesApi* | [**branch_update**](docs/BranchesApi.md#branch_update) | **PATCH** /projects/{project_id}/branches/{name} | Update a branch
 *BranchesApi* | [**branches_list**](docs/BranchesApi.md#branches_list) | **GET** /projects/{project_id}/branches | List branches
 *CommentReactionsApi* | [**reaction_create**](docs/CommentReactionsApi.md#reaction_create) | **POST** /projects/{project_id}/keys/{key_id}/comments/{comment_id}/reactions | Create a reaction
@@ -450,6 +451,7 @@ Class | Method | HTTP request | Description
  - [BranchCreateParameters](docs/BranchCreateParameters.md)
  - [BranchMergeParameters](docs/BranchMergeParameters.md)
  - [BranchName](docs/BranchName.md)
+ - [BranchSyncParameters](docs/BranchSyncParameters.md)
  - [BranchUpdateParameters](docs/BranchUpdateParameters.md)
  - [Comment](docs/Comment.md)
  - [CommentCreateParameters](docs/CommentCreateParameters.md)

{phrase_api-3.8.0 → phrase_api-3.9.0}/phrase_api/__init__.py

@@ -13,7 +13,7 @@
 
 from __future__ import absolute_import
 
-__version__ = "3.8.0"
+__version__ = "3.9.0"
 
 # import apis into sdk package
 from phrase_api.api.accounts_api import AccountsApi
@@ -101,6 +101,7 @@ from phrase_api.models.branch import Branch
 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
+from phrase_api.models.branch_sync_parameters import BranchSyncParameters
 from phrase_api.models.branch_update_parameters import BranchUpdateParameters
 from phrase_api.models.comment import Comment
 from phrase_api.models.comment_create_parameters import CommentCreateParameters

{phrase_api-3.8.0 → phrase_api-3.9.0}/phrase_api/api/branches_api.py

@@ -418,7 +418,7 @@ class BranchesApi(object):
     def branch_merge(self, project_id, name, branch_merge_parameters, **kwargs):  # noqa: E501
         """Merge a branch  # noqa: E501
 
-        Merge an existing branch.   *Note: Merging a branch may take several minutes depending on diff size.*   # noqa: E501
+        Merge an existing branch.  *Note: Merging a branch may take several minutes depending on diff size.*   # 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_merge(project_id, name, branch_merge_parameters, async_req=True)
@@ -446,7 +446,7 @@ class BranchesApi(object):
     def branch_merge_with_http_info(self, project_id, name, branch_merge_parameters, **kwargs):  # noqa: E501
         """Merge a branch  # noqa: E501
 
-        Merge an existing branch.   *Note: Merging a branch may take several minutes depending on diff size.*   # noqa: E501
+        Merge an existing branch.  *Note: Merging a branch may take several minutes depending on diff size.*   # 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_merge_with_http_info(project_id, name, branch_merge_parameters, async_req=True)
@@ -680,6 +680,143 @@ class BranchesApi(object):
             _request_timeout=local_var_params.get('_request_timeout'),
             collection_formats=collection_formats)
 
+    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
+        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)
+        >>> result = thread.get()
+
+        :param async_req bool: execute request asynchronously
+        :param str project_id: Project ID (required)
+        :param str name: name (required)
+        :param BranchSyncParameters branch_sync_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_sync_with_http_info(project_id, name, branch_sync_parameters, **kwargs)  # noqa: E501
+
+    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
+        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)
+        >>> result = thread.get()
+
+        :param async_req bool: execute request asynchronously
+        :param str project_id: Project ID (required)
+        :param str name: name (required)
+        :param BranchSyncParameters branch_sync_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_sync_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_sync" % 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_sync`")  # 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_sync`")  # noqa: E501
+        # verify the required parameter 'branch_sync_parameters' is set
+        if self.api_client.client_side_validation and ('branch_sync_parameters' not in local_var_params or  # noqa: E501
+                                                        local_var_params['branch_sync_parameters'] is None):  # noqa: E501
+            raise ApiValueError("Missing the required parameter `branch_sync_parameters` when calling `branch_sync`")  # 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_sync_parameters' in local_var_params:
+            body_params = local_var_params['branch_sync_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}/sync', 'PATCH',
+            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_update(self, project_id, name, branch_update_parameters, **kwargs):  # noqa: E501
         """Update a branch  # noqa: E501
 

{phrase_api-3.8.0 → phrase_api-3.9.0}/phrase_api/api_client.py

@@ -77,7 +77,7 @@ class ApiClient(object):
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'OpenAPI-Generator/3.8.0/python'
+        self.user_agent = 'OpenAPI-Generator/3.9.0/python'
         self.client_side_validation = configuration.client_side_validation
 
     def __enter__(self):

{phrase_api-3.8.0 → phrase_api-3.9.0}/phrase_api/configuration.py

@@ -370,7 +370,7 @@ class Configuration(object):
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 2.0.0\n"\
-               "SDK Package Version: 3.8.0".\
+               "SDK Package Version: 3.9.0".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):

{phrase_api-3.8.0 → phrase_api-3.9.0}/phrase_api/models/__init__.py

@@ -32,6 +32,7 @@ from phrase_api.models.branch import Branch
 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
+from phrase_api.models.branch_sync_parameters import BranchSyncParameters
 from phrase_api.models.branch_update_parameters import BranchUpdateParameters
 from phrase_api.models.comment import Comment
 from phrase_api.models.comment_create_parameters import CommentCreateParameters

{phrase_api-3.8.0 → phrase_api-3.9.0}/phrase_api/models/branch_merge_parameters.py

@@ -55,7 +55,7 @@ class BranchMergeParameters(object):
     def strategy(self):
         """Gets the strategy of this BranchMergeParameters.  # noqa: E501
 
-        strategy used for merge blocking, use_main or use_branch  # noqa: E501
+        strategy used for merge conflicts, use_main or use_branch  # noqa: E501
 
         :return: The strategy of this BranchMergeParameters.  # noqa: E501
         :rtype: str
@@ -66,7 +66,7 @@ class BranchMergeParameters(object):
     def strategy(self, strategy):
         """Sets the strategy of this BranchMergeParameters.
 
-        strategy used for merge blocking, use_main or use_branch  # noqa: E501
+        strategy used for merge conflicts, use_main or use_branch  # noqa: E501
 
         :param strategy: The strategy of this BranchMergeParameters.  # noqa: E501
         :type: str

phrase_api-3.9.0/phrase_api/models/branch_sync_parameters.py

@@ -0,0 +1,121 @@
+# coding: utf-8
+
+"""
+    Phrase Strings API Reference
+
+    The version of the OpenAPI document: 2.0.0
+    Contact: support@phrase.com
+    Generated by: https://openapi-generator.tech
+"""
+
+
+import pprint
+import re  # noqa: F401
+
+import six
+
+from phrase_api.configuration import Configuration
+
+
+class BranchSyncParameters(object):
+    """NOTE: This class is auto generated by OpenAPI Generator.
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    """
+    Attributes:
+      openapi_types (dict): The key is attribute name
+                            and the value is attribute type.
+      attribute_map (dict): The key is attribute name
+                            and the value is json key in definition.
+    """
+    openapi_types = {
+        'strategy': 'str'
+    }
+
+    attribute_map = {
+        'strategy': 'strategy'
+    }
+
+    def __init__(self, strategy=None, local_vars_configuration=None):  # noqa: E501
+        """BranchSyncParameters - a model defined in OpenAPI"""  # noqa: E501
+        if local_vars_configuration is None:
+            local_vars_configuration = Configuration()
+        self.local_vars_configuration = local_vars_configuration
+
+        self._strategy = None
+        self.discriminator = None
+
+        if strategy is not None:
+            self.strategy = strategy
+
+    @property
+    def strategy(self):
+        """Gets the strategy of this BranchSyncParameters.  # noqa: E501
+
+        strategy used for conflicts, use_main or use_branch  # noqa: E501
+
+        :return: The strategy of this BranchSyncParameters.  # noqa: E501
+        :rtype: str
+        """
+        return self._strategy
+
+    @strategy.setter
+    def strategy(self, strategy):
+        """Sets the strategy of this BranchSyncParameters.
+
+        strategy used for conflicts, use_main or use_branch  # noqa: E501
+
+        :param strategy: The strategy of this BranchSyncParameters.  # noqa: E501
+        :type: str
+        """
+
+        self._strategy = strategy
+
+    def to_dict(self):
+        """Returns the model properties as a dict"""
+        result = {}
+
+        for attr, _ in six.iteritems(self.openapi_types):
+            value = getattr(self, attr)
+            if isinstance(value, list):
+                result[attr] = list(map(
+                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+                    value
+                ))
+            elif hasattr(value, "to_dict"):
+                result[attr] = value.to_dict()
+            elif isinstance(value, dict):
+                result[attr] = dict(map(
+                    lambda item: (item[0], item[1].to_dict())
+                    if hasattr(item[1], "to_dict") else item,
+                    value.items()
+                ))
+            else:
+                result[attr] = value
+
+        return result
+
+    def to_str(self):
+        """Returns the string representation of the model"""
+        return pprint.pformat(self.to_dict())
+
+    def __repr__(self):
+        """For `print` and `pprint`"""
+        return self.to_str()
+
+    def __eq__(self, other):
+        """Returns true if both objects are equal"""
+        if not isinstance(other, BranchSyncParameters):
+            return False
+
+        return self.to_dict() == other.to_dict()
+
+    def __ne__(self, other):
+        """Returns true if both objects are not equal"""
+        if not isinstance(other, BranchSyncParameters):
+            return True
+
+        return self.to_dict() != other.to_dict()

{phrase_api-3.8.0 → phrase_api-3.9.0}/phrase_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: phrase-api
-Version: 3.8.0
+Version: 3.9.0
 Summary: Phrase Strings API Reference
 Home-page: https://github.com/phrase/phrase-python
 Author: Phrase Support

{phrase_api-3.8.0 → phrase_api-3.9.0}/phrase_api.egg-info/SOURCES.txt

@@ -91,6 +91,7 @@ phrase_api/models/branch.py
 phrase_api/models/branch_create_parameters.py
 phrase_api/models/branch_merge_parameters.py
 phrase_api/models/branch_name.py
+phrase_api/models/branch_sync_parameters.py
 phrase_api/models/branch_update_parameters.py
 phrase_api/models/comment.py
 phrase_api/models/comment_create_parameters.py
@@ -313,6 +314,7 @@ test/test_branch.py
 test/test_branch_create_parameters.py
 test/test_branch_merge_parameters.py
 test/test_branch_name.py
+test/test_branch_sync_parameters.py
 test/test_branch_update_parameters.py
 test/test_branches_api.py
 test/test_comment.py

{phrase_api-3.8.0 → phrase_api-3.9.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "phrase_api"
-version = "3.8.0"
+version = "3.9.0"
 description = "Phrase Strings API Reference"
 authors = ["Phrase Support <support@phrase.com>"]
 license = "MIT"

{phrase_api-3.8.0 → phrase_api-3.9.0}/setup.py

@@ -12,7 +12,7 @@
 from setuptools import setup, find_packages  # noqa: H301
 
 NAME = "phrase-api"
-VERSION = "3.8.0"
+VERSION = "3.9.0"
 # To install the library, run the following
 #
 # python setup.py install

phrase_api-3.9.0/test/test_branch_sync_parameters.py

@@ -0,0 +1,54 @@
+# coding: utf-8
+
+"""
+    Phrase Strings API Reference
+
+    The version of the OpenAPI document: 2.0.0
+    Contact: support@phrase.com
+    Generated by: https://openapi-generator.tech
+"""
+
+
+from __future__ import absolute_import
+
+import unittest
+import datetime
+
+import phrase_api
+from phrase_api.models.branch_sync_parameters import BranchSyncParameters  # noqa: E501
+from phrase_api.rest import ApiException
+
+class TestBranchSyncParameters(unittest.TestCase):
+    """BranchSyncParameters unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional):
+        """Test BranchSyncParameters
+            include_option is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # model = phrase_api.models.branch_sync_parameters.BranchSyncParameters()  # noqa: E501
+
+        """
+        if include_optional :
+            return BranchSyncParameters(
+                strategy = 'use_main'
+            )
+        else :
+            return BranchSyncParameters(
+        )
+        """
+
+    def testBranchSyncParameters(self):
+        """Test BranchSyncParameters"""
+        inst_req_only = self.make_instance(include_optional=False)
+        inst_req_and_optional = self.make_instance(include_optional=True)
+
+
+if __name__ == '__main__':
+    unittest.main()

{phrase_api-3.8.0 → phrase_api-3.9.0}/test/test_branches_api.py

@@ -62,6 +62,13 @@ class TestBranchesApi(unittest.TestCase):
         """
         pass
 
+    def test_branch_sync(self):
+        """Test case for branch_sync
+
+        Sync a branch  # noqa: E501
+        """
+        pass
+
     def test_branch_update(self):
         """Test case for branch_update
 

{phrase_api-3.8.0 → phrase_api-3.9.0}/test/test_key_create_parameters.py

@@ -46,7 +46,7 @@ class TestKeyCreateParameters(unittest.TestCase):
                 data_type = 'number', 
                 tags = 'awesome-feature,needs-proofreading', 
                 max_characters_allowed = 140, 
-                screenshot = '[B@1189f179', 
+                screenshot = '[B@12550aaf', 
                 remove_screenshot = True, 
                 unformatted = True, 
                 default_translation_content = 'Default translation content', 

{phrase_api-3.8.0 → phrase_api-3.9.0}/test/test_key_update_parameters.py

@@ -46,7 +46,7 @@ class TestKeyUpdateParameters(unittest.TestCase):
                 data_type = 'number', 
                 tags = 'awesome-feature,needs-proofreading', 
                 max_characters_allowed = 140, 
-                screenshot = '[B@54978e18', 
+                screenshot = '[B@784bb800', 
                 remove_screenshot = True, 
                 unformatted = True, 
                 xml_space_preserve = True, 

{phrase_api-3.8.0 → phrase_api-3.9.0}/test/test_project_create_parameters.py

@@ -41,7 +41,7 @@ class TestProjectCreateParameters(unittest.TestCase):
                 main_format = 'yml', 
                 media = 'Python', 
                 shares_translation_memory = True, 
-                project_image = '[B@23f37949', 
+                project_image = '[B@4377d616', 
                 remove_project_image = True, 
                 account_id = 'abcd1234', 
                 point_of_contact = 'abcd1234', 

{phrase_api-3.8.0 → phrase_api-3.9.0}/test/test_project_update_parameters.py

@@ -43,7 +43,7 @@ class TestProjectUpdateParameters(unittest.TestCase):
                 main_format = 'yml', 
                 media = 'Python', 
                 shares_translation_memory = True, 
-                project_image = '[B@21ec86e6', 
+                project_image = '[B@4415cc21', 
                 remove_project_image = False, 
                 workflow = 'review', 
                 machine_translation_enabled = True, 

{phrase_api-3.8.0 → phrase_api-3.9.0}/test/test_screenshot_update_parameters.py

@@ -40,7 +40,7 @@ class TestScreenshotUpdateParameters(unittest.TestCase):
                 branch = 'my-feature-branch', 
                 name = 'A screenshot name', 
                 description = 'A screenshot description', 
-                filename = '[B@2908fc20'
+                filename = '[B@6fefa622'
             )
         else :
             return ScreenshotUpdateParameters(