phrase-api 2.5.0__tar.gz → 2.6.0__tar.gz

{phrase_api-2.5.0 → phrase_api-2.6.0}/PKG-INFO

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

{phrase_api-2.5.0 → phrase_api-2.6.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: 2.5.0
+- Package version: 2.6.0
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 For more information, please visit [https://developers.phrase.com/api/](https://developers.phrase.com/api/)
 

{phrase_api-2.5.0 → phrase_api-2.6.0}/phrase_api/__init__.py

@@ -13,7 +13,7 @@
 
 from __future__ import absolute_import
 
-__version__ = "2.5.0"
+__version__ = "2.6.0"
 
 # import apis into sdk package
 from phrase_api.api.accounts_api import AccountsApi

{phrase_api-2.5.0 → phrase_api-2.6.0}/phrase_api/api/uploads_api.py

@@ -61,7 +61,7 @@ class UploadsApi(object):
         :param bool skip_unverification: Indicates whether the upload should unverify updated translations.
         :param str file_encoding: Enforces a specific encoding on the file contents. Valid options are \\\"UTF-8\\\", \\\"UTF-16\\\" and \\\"ISO-8859-1\\\".
         :param object locale_mapping: Mapping between locale names and translation columns. Required in some formats like CSV or XLSX.
-        :param object format_options: Additional options available for specific formats. See our format guide for complete list.
+        :param object format_options: Additional options available for specific formats. See our format guide for the [complete list](https://support.phrase.com/hc/en-us/articles/9652464547740-List-of-Supported-File-Types-Strings).
         :param bool autotranslate: If set, translations for the uploaded language will be fetched automatically.
         :param bool mark_reviewed: Indicated whether the imported translations should be marked as reviewed. This setting is available if the review workflow is enabled for the project.
         :param bool tag_only_affected_keys: Indicates whether only keys affected (created or updated) by the upload should be tagged. The default is `false`
@@ -106,7 +106,7 @@ class UploadsApi(object):
         :param bool skip_unverification: Indicates whether the upload should unverify updated translations.
         :param str file_encoding: Enforces a specific encoding on the file contents. Valid options are \\\"UTF-8\\\", \\\"UTF-16\\\" and \\\"ISO-8859-1\\\".
         :param object locale_mapping: Mapping between locale names and translation columns. Required in some formats like CSV or XLSX.
-        :param object format_options: Additional options available for specific formats. See our format guide for complete list.
+        :param object format_options: Additional options available for specific formats. See our format guide for the [complete list](https://support.phrase.com/hc/en-us/articles/9652464547740-List-of-Supported-File-Types-Strings).
         :param bool autotranslate: If set, translations for the uploaded language will be fetched automatically.
         :param bool mark_reviewed: Indicated whether the imported translations should be marked as reviewed. This setting is available if the review workflow is enabled for the project.
         :param bool tag_only_affected_keys: Indicates whether only keys affected (created or updated) by the upload should be tagged. The default is `false`

{phrase_api-2.5.0 → phrase_api-2.6.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/2.5.0/python'
+        self.user_agent = 'OpenAPI-Generator/2.6.0/python'
         self.client_side_validation = configuration.client_side_validation
 
     def __enter__(self):
@@ -151,7 +151,7 @@ class ApiClient(object):
         if query_params:
             query_params = self.sanitize_for_serialization(query_params)
             query_params = self.parameters_to_tuples(query_params, collection_formats)
-            query_params = self.flatten_query_params(query_params)
+            query_params = self.flatten_params(query_params)
 
         # post parameters
         if post_params or files:
@@ -159,6 +159,7 @@ class ApiClient(object):
             post_params = self.sanitize_for_serialization(post_params)
             post_params = self.parameters_to_tuples(post_params,
                                                     collection_formats)
+            post_params = self.flatten_params(post_params)
             post_params.extend(self.files_parameters(files))
 
         # auth setting
@@ -453,7 +454,7 @@ class ApiClient(object):
                 new_params.append((k, v))
         return new_params
 
-    def flatten_query_params(self, params):
+    def flatten_params(self, params):
         result_params = {}
         for key, value in params:
             if isinstance(value, dict):

{phrase_api-2.5.0 → phrase_api-2.6.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: 2.5.0".\
+               "SDK Package Version: 2.6.0".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):

{phrase_api-2.5.0 → phrase_api-2.6.0}/phrase_api/models/key_create_parameters.py

@@ -44,6 +44,7 @@ class KeyCreateParameters(object):
         'remove_screenshot': 'bool',
         'unformatted': 'bool',
         'default_translation_content': 'str',
+        'autotranslate': 'bool',
         'xml_space_preserve': 'bool',
         'original_file': 'str',
         'localized_format_string': 'str',
@@ -64,6 +65,7 @@ class KeyCreateParameters(object):
         'remove_screenshot': 'remove_screenshot',
         'unformatted': 'unformatted',
         'default_translation_content': 'default_translation_content',
+        'autotranslate': 'autotranslate',
         'xml_space_preserve': 'xml_space_preserve',
         'original_file': 'original_file',
         'localized_format_string': 'localized_format_string',
@@ -71,7 +73,7 @@ class KeyCreateParameters(object):
         'custom_metadata': 'custom_metadata'
     }
 
-    def __init__(self, branch=None, name=None, description=None, plural=None, name_plural=None, data_type=None, tags=None, max_characters_allowed=None, screenshot=None, remove_screenshot=None, unformatted=None, default_translation_content=None, xml_space_preserve=None, original_file=None, localized_format_string=None, localized_format_key=None, custom_metadata=None, local_vars_configuration=None):  # noqa: E501
+    def __init__(self, branch=None, name=None, description=None, plural=None, name_plural=None, data_type=None, tags=None, max_characters_allowed=None, screenshot=None, remove_screenshot=None, unformatted=None, default_translation_content=None, autotranslate=None, xml_space_preserve=None, original_file=None, localized_format_string=None, localized_format_key=None, custom_metadata=None, local_vars_configuration=None):  # noqa: E501
         """KeyCreateParameters - a model defined in OpenAPI"""  # noqa: E501
         if local_vars_configuration is None:
             local_vars_configuration = Configuration()
@@ -89,6 +91,7 @@ class KeyCreateParameters(object):
         self._remove_screenshot = None
         self._unformatted = None
         self._default_translation_content = None
+        self._autotranslate = None
         self._xml_space_preserve = None
         self._original_file = None
         self._localized_format_string = None
@@ -119,6 +122,8 @@ class KeyCreateParameters(object):
             self.unformatted = unformatted
         if default_translation_content is not None:
             self.default_translation_content = default_translation_content
+        if autotranslate is not None:
+            self.autotranslate = autotranslate
         if xml_space_preserve is not None:
             self.xml_space_preserve = xml_space_preserve
         if original_file is not None:
@@ -408,6 +413,29 @@ class KeyCreateParameters(object):
 
         self._default_translation_content = default_translation_content
 
+    @property
+    def autotranslate(self):
+        """Gets the autotranslate of this KeyCreateParameters.  # noqa: E501
+
+        Indicates whether the key should be autotranslated to other locales based on the copy provided in `default_translation_content`.  # noqa: E501
+
+        :return: The autotranslate of this KeyCreateParameters.  # noqa: E501
+        :rtype: bool
+        """
+        return self._autotranslate
+
+    @autotranslate.setter
+    def autotranslate(self, autotranslate):
+        """Sets the autotranslate of this KeyCreateParameters.
+
+        Indicates whether the key should be autotranslated to other locales based on the copy provided in `default_translation_content`.  # noqa: E501
+
+        :param autotranslate: The autotranslate of this KeyCreateParameters.  # noqa: E501
+        :type: bool
+        """
+
+        self._autotranslate = autotranslate
+
     @property
     def xml_space_preserve(self):
         """Gets the xml_space_preserve of this KeyCreateParameters.  # noqa: E501

{phrase_api-2.5.0 → phrase_api-2.6.0}/phrase_api.egg-info/PKG-INFO

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

{phrase_api-2.5.0 → phrase_api-2.6.0}/pyproject.toml

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

{phrase_api-2.5.0 → phrase_api-2.6.0}/setup.py

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

{phrase_api-2.5.0 → phrase_api-2.6.0}/test/test_key_create_parameters.py

@@ -45,10 +45,11 @@ class TestKeyCreateParameters(unittest.TestCase):
                 data_type = 'number', 
                 tags = 'awesome-feature,needs-proofreading', 
                 max_characters_allowed = 140, 
-                screenshot = '[B@45ef4dcb', 
+                screenshot = '[B@7caf0725', 
                 remove_screenshot = True, 
                 unformatted = True, 
                 default_translation_content = 'Default translation content', 
+                autotranslate = True, 
                 xml_space_preserve = True, 
                 original_file = '', 
                 localized_format_string = '', 

{phrase_api-2.5.0 → phrase_api-2.6.0}/test/test_key_update_parameters.py

@@ -45,7 +45,7 @@ class TestKeyUpdateParameters(unittest.TestCase):
                 data_type = 'number', 
                 tags = 'awesome-feature,needs-proofreading', 
                 max_characters_allowed = 140, 
-                screenshot = '[B@54557dd8', 
+                screenshot = '[B@644acaff', 
                 remove_screenshot = True, 
                 unformatted = True, 
                 xml_space_preserve = True, 

{phrase_api-2.5.0 → phrase_api-2.6.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@639f7054', 
+                project_image = '[B@210d1b45', 
                 remove_project_image = True, 
                 account_id = 'abcd1234', 
                 point_of_contact = 'abcd1234', 

{phrase_api-2.5.0 → phrase_api-2.6.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@26f6fbbd', 
+                project_image = '[B@29862f60', 
                 remove_project_image = False, 
                 workflow = 'review', 
                 machine_translation_enabled = True, 

{phrase_api-2.5.0 → phrase_api-2.6.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@5dea8bf2'
+                filename = '[B@35b1e5e5'
             )
         else :
             return ScreenshotUpdateParameters(

{phrase_api-2.5.0 → phrase_api-2.6.0}/test/test_uploads_api.py

@@ -15,7 +15,7 @@ import unittest
 import sys
 
 if sys.version_info[:2] <= (3, 7):
-    from mock import Mock, patch 
+    from mock import Mock, patch
 else:
     from unittest.mock import Mock, patch
 
@@ -23,7 +23,6 @@ import phrase_api
 from phrase_api.api.uploads_api import UploadsApi  # noqa: E501
 from phrase_api.rest import ApiException
 
-
 class TestUploadsApi(unittest.TestCase):
     """UploadsApi unit test stubs"""
 
@@ -42,7 +41,7 @@ class TestUploadsApi(unittest.TestCase):
         Upload a new file  # noqa: E501
         """
         mock_post.return_value = Mock(ok=True)
-        mock_post.return_value.data = '{"id": "upload_id", "format": "simple_json"}'.encode()
+        mock_post.return_value.data = '{"id": "upload_id", "format": "csv"}'.encode()
         mock_post.return_value.getencoding.return_value = 'utf-8'
         mock_post.return_value.status = 201
         mock_post.return_value.getheader.side_effect = { 'Content-Type': "application/json" }.get
@@ -52,17 +51,29 @@ class TestUploadsApi(unittest.TestCase):
             api_instance = phrase_api.UploadsApi(api_client)
             api_response = api_instance.upload_create(
                 project_id,
-                file="./test/fixtures/en.json",
-                file_format="simple_json",
-                locale_id="en"
+                file="./test/fixtures/test.csv",
+                file_format="csv",
+                locale_id="en",
+                locale_mapping={
+                    "en": 2
+                },
+                format_options={
+                    "deep_parameter": {"foo": "bar"}
+                }
             )
 
             self.assertEqual("https://api.phrase.com/v2/projects/project_id_example/uploads", mock_post.call_args_list[0].args[1])
+            body = mock_post.call_args.kwargs["body"].decode('utf-8')
+            self.assertRegex(body, r'name="file"; filename="test.csv"\r\nContent-Type: text/csv\r\n\r\n')
+            self.assertRegex(body, r'name="file_format"\r\n\r\ncsv\r\n')
+            self.assertRegex(body, r'name="locale_id"\r\n\r\nen\r\n')
+            self.assertRegex(body, r'name="locale_mapping\[en\]"\r\n\r\n2\r\n')
+            self.assertRegex(body, r'name="format_options\[deep_parameter\]\[foo\]"\r\n\r\nbar\r\n')
 
             self.assertIsNotNone(api_response)
             self.assertIsInstance(api_response, phrase_api.models.upload.Upload)
             self.assertEqual("upload_id", api_response.id)
-            self.assertEqual("simple_json", api_response.format)
+            self.assertEqual("csv", api_response.format)
 
     def test_upload_show(self):
         """Test case for upload_show