phrase-api 2.3.0__tar.gz → 2.4.0__tar.gz

{phrase_api-2.3.0 → phrase_api-2.4.0}/PKG-INFO

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

{phrase_api-2.3.0 → phrase_api-2.4.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.3.0
+- Package version: 2.4.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.3.0 → phrase_api-2.4.0}/phrase_api/__init__.py

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

{phrase_api-2.3.0 → phrase_api-2.4.0}/phrase_api/api/keys_api.py

@@ -583,7 +583,7 @@ class KeysApi(object):
         :param str project_id: Project ID (required)
         :param str x_phrase_app_otp: Two-Factor-Authentication token (optional)
         :param str branch: specify the branch to use
-        :param str q: Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul>   <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li>   <li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons  need to be escaped with double backslashes</li>   <li><code>tags:tag_name</code> to filter for keys with certain tags</li>   <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li>   <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li>   <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>. 
+        :param str q: Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul>   <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li>   <li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons  need to be escaped with double backslashes</li>   <li><code>tags:tag_name</code> to filter for keys with certain tags</li>   <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li>   <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li>   <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li> </ul> <br/> <p><strong>Caution:</strong> Query parameters with empty values will be treated as though they are not included in the request and will be ignored.</p> <br/> Find more examples <a href=\"#overview--usage-examples\">here</a>. 
         :param str locale_id: Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
         :param _preload_content: if False, the urllib3.HTTPResponse object will
                                  be returned without reading/decoding response
@@ -612,7 +612,7 @@ class KeysApi(object):
         :param str project_id: Project ID (required)
         :param str x_phrase_app_otp: Two-Factor-Authentication token (optional)
         :param str branch: specify the branch to use
-        :param str q: Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul>   <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li>   <li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons  need to be escaped with double backslashes</li>   <li><code>tags:tag_name</code> to filter for keys with certain tags</li>   <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li>   <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li>   <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>. 
+        :param str q: Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul>   <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li>   <li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons  need to be escaped with double backslashes</li>   <li><code>tags:tag_name</code> to filter for keys with certain tags</li>   <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li>   <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li>   <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li> </ul> <br/> <p><strong>Caution:</strong> Query parameters with empty values will be treated as though they are not included in the request and will be ignored.</p> <br/> Find more examples <a href=\"#overview--usage-examples\">here</a>. 
         :param str locale_id: Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
         :param _return_http_data_only: response data without head status code
                                        and headers

{phrase_api-2.3.0 → phrase_api-2.4.0}/phrase_api/api/tags_api.py

@@ -443,6 +443,7 @@ class TagsApi(object):
         :param str x_phrase_app_otp: Two-Factor-Authentication token (optional)
         :param int page: Page number
         :param int per_page: Limit on the number of objects to be returned, between 1 and 100. 25 by default
+        :param bool exclude_system_tags: excludes tags generated by the system, e.g. job, upload or figma tags
         :param str branch: specify the branch to use
         :param _preload_content: if False, the urllib3.HTTPResponse object will
                                  be returned without reading/decoding response
@@ -472,6 +473,7 @@ class TagsApi(object):
         :param str x_phrase_app_otp: Two-Factor-Authentication token (optional)
         :param int page: Page number
         :param int per_page: Limit on the number of objects to be returned, between 1 and 100. 25 by default
+        :param bool exclude_system_tags: excludes tags generated by the system, e.g. job, upload or figma tags
         :param str branch: specify the branch to use
         :param _return_http_data_only: response data without head status code
                                        and headers
@@ -494,6 +496,7 @@ class TagsApi(object):
             'x_phrase_app_otp',
             'page',
             'per_page',
+            'exclude_system_tags',
             'branch'
         ]
         all_params.extend(
@@ -529,6 +532,8 @@ class TagsApi(object):
             query_params.append(('page', local_var_params['page']))  # noqa: E501
         if 'per_page' in local_var_params and local_var_params['per_page'] is not None:  # noqa: E501
             query_params.append(('per_page', local_var_params['per_page']))  # noqa: E501
+        if 'exclude_system_tags' in local_var_params and local_var_params['exclude_system_tags'] is not None:  # noqa: E501
+            query_params.append(('exclude_system_tags', local_var_params['exclude_system_tags']))  # noqa: E501
         if 'branch' in local_var_params and local_var_params['branch'] is not None:  # noqa: E501
             query_params.append(('branch', local_var_params['branch']))  # noqa: E501
 

{phrase_api-2.3.0 → phrase_api-2.4.0}/phrase_api/api/uploads_api.py

@@ -54,6 +54,7 @@ class UploadsApi(object):
         :param str tags: List of tags separated by comma to be associated with the new keys contained in the upload.
         :param bool update_translations: Indicates whether existing translations should be updated with the file content.
         :param bool update_translation_keys: Pass `false` here to prevent new keys from being created and existing keys updated.
+        :param bool update_translations_on_source_match: Update target translations only if the source translations of the uploaded multilingual file match the stored translations.
         :param bool update_descriptions: Existing key descriptions will be updated with the file content. Empty descriptions overwrite existing descriptions.
         :param bool convert_emoji: This option is obsolete. Providing the option will cause a bad request error.
         :param bool skip_upload_tags: Indicates whether the upload should not create upload tags.
@@ -97,6 +98,7 @@ class UploadsApi(object):
         :param str tags: List of tags separated by comma to be associated with the new keys contained in the upload.
         :param bool update_translations: Indicates whether existing translations should be updated with the file content.
         :param bool update_translation_keys: Pass `false` here to prevent new keys from being created and existing keys updated.
+        :param bool update_translations_on_source_match: Update target translations only if the source translations of the uploaded multilingual file match the stored translations.
         :param bool update_descriptions: Existing key descriptions will be updated with the file content. Empty descriptions overwrite existing descriptions.
         :param bool convert_emoji: This option is obsolete. Providing the option will cause a bad request error.
         :param bool skip_upload_tags: Indicates whether the upload should not create upload tags.
@@ -133,6 +135,7 @@ class UploadsApi(object):
             'tags',
             'update_translations',
             'update_translation_keys',
+            'update_translations_on_source_match',
             'update_descriptions',
             'convert_emoji',
             'skip_upload_tags',
@@ -206,6 +209,8 @@ class UploadsApi(object):
             form_params.append(('update_translations', local_var_params['update_translations']))  # noqa: E501
         if 'update_translation_keys' in local_var_params:
             form_params.append(('update_translation_keys', local_var_params['update_translation_keys']))  # noqa: E501
+        if 'update_translations_on_source_match' in local_var_params:
+            form_params.append(('update_translations_on_source_match', local_var_params['update_translations_on_source_match']))  # noqa: E501
         if 'update_descriptions' in local_var_params:
             form_params.append(('update_descriptions', local_var_params['update_descriptions']))  # noqa: E501
         if 'convert_emoji' in local_var_params:

{phrase_api-2.3.0 → phrase_api-2.4.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.3.0/python'
+        self.user_agent = 'OpenAPI-Generator/2.4.0/python'
         self.client_side_validation = configuration.client_side_validation
 
     def __enter__(self):

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

{phrase_api-2.3.0 → phrase_api-2.4.0}/phrase_api/models/locale_download_create_parameters.py

@@ -43,6 +43,7 @@ class LocaleDownloadCreateParameters(object):
         'encoding': 'str',
         'include_unverified_translations': 'bool',
         'use_last_reviewed_version': 'bool',
+        'locale_ids': 'List[str]',
         'fallback_locale_id': 'str',
         'source_locale_id': 'str',
         'custom_metadata_filters': 'object'
@@ -60,12 +61,13 @@ class LocaleDownloadCreateParameters(object):
         'encoding': 'encoding',
         'include_unverified_translations': 'include_unverified_translations',
         'use_last_reviewed_version': 'use_last_reviewed_version',
+        'locale_ids': 'locale_ids',
         'fallback_locale_id': 'fallback_locale_id',
         'source_locale_id': 'source_locale_id',
         'custom_metadata_filters': 'custom_metadata_filters'
     }
 
-    def __init__(self, file_format=None, branch=None, tags=None, include_empty_translations=None, exclude_empty_zero_forms=None, include_translated_keys=None, keep_notranslate_tags=None, format_options=None, encoding=None, include_unverified_translations=None, use_last_reviewed_version=None, fallback_locale_id=None, source_locale_id=None, custom_metadata_filters=None, local_vars_configuration=None):  # noqa: E501
+    def __init__(self, file_format=None, branch=None, tags=None, include_empty_translations=None, exclude_empty_zero_forms=None, include_translated_keys=None, keep_notranslate_tags=None, format_options=None, encoding=None, include_unverified_translations=None, use_last_reviewed_version=None, locale_ids=None, fallback_locale_id=None, source_locale_id=None, custom_metadata_filters=None, local_vars_configuration=None):  # noqa: E501
         """LocaleDownloadCreateParameters - a model defined in OpenAPI"""  # noqa: E501
         if local_vars_configuration is None:
             local_vars_configuration = Configuration()
@@ -82,6 +84,7 @@ class LocaleDownloadCreateParameters(object):
         self._encoding = None
         self._include_unverified_translations = None
         self._use_last_reviewed_version = None
+        self._locale_ids = None
         self._fallback_locale_id = None
         self._source_locale_id = None
         self._custom_metadata_filters = None
@@ -108,6 +111,8 @@ class LocaleDownloadCreateParameters(object):
             self.include_unverified_translations = include_unverified_translations
         if use_last_reviewed_version is not None:
             self.use_last_reviewed_version = use_last_reviewed_version
+        if locale_ids is not None:
+            self.locale_ids = locale_ids
         if fallback_locale_id is not None:
             self.fallback_locale_id = fallback_locale_id
         if source_locale_id is not None:
@@ -370,6 +375,29 @@ class LocaleDownloadCreateParameters(object):
 
         self._use_last_reviewed_version = use_last_reviewed_version
 
+    @property
+    def locale_ids(self):
+        """Gets the locale_ids of this LocaleDownloadCreateParameters.  # noqa: E501
+
+        Locale IDs or locale names  # noqa: E501
+
+        :return: The locale_ids of this LocaleDownloadCreateParameters.  # noqa: E501
+        :rtype: List[str]
+        """
+        return self._locale_ids
+
+    @locale_ids.setter
+    def locale_ids(self, locale_ids):
+        """Sets the locale_ids of this LocaleDownloadCreateParameters.
+
+        Locale IDs or locale names  # noqa: E501
+
+        :param locale_ids: The locale_ids of this LocaleDownloadCreateParameters.  # noqa: E501
+        :type: List[str]
+        """
+
+        self._locale_ids = locale_ids
+
     @property
     def fallback_locale_id(self):
         """Gets the fallback_locale_id of this LocaleDownloadCreateParameters.  # noqa: E501

{phrase_api-2.3.0 → phrase_api-2.4.0}/phrase_api.egg-info/PKG-INFO

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

{phrase_api-2.3.0 → phrase_api-2.4.0}/pyproject.toml

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

{phrase_api-2.3.0 → phrase_api-2.4.0}/setup.py

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

{phrase_api-2.3.0 → phrase_api-2.4.0}/test/test_key_create_parameters.py

@@ -45,7 +45,7 @@ class TestKeyCreateParameters(unittest.TestCase):
                 data_type = 'number', 
                 tags = 'awesome-feature,needs-proofreading', 
                 max_characters_allowed = 140, 
-                screenshot = '[B@58da1b27', 
+                screenshot = '[B@73d8f219', 
                 remove_screenshot = True, 
                 unformatted = True, 
                 default_translation_content = 'Default translation content', 

{phrase_api-2.3.0 → phrase_api-2.4.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@347c6044', 
+                screenshot = '[B@3a4dea70', 
                 remove_screenshot = True, 
                 unformatted = True, 
                 xml_space_preserve = True, 

{phrase_api-2.3.0 → phrase_api-2.4.0}/test/test_locale_download_create_parameters.py

@@ -48,6 +48,7 @@ class TestLocaleDownloadCreateParameters(unittest.TestCase):
                 encoding = 'UTF-8', 
                 include_unverified_translations = True, 
                 use_last_reviewed_version = True, 
+                locale_ids = ["de","en"], 
                 fallback_locale_id = 'abcd1234abcd1234abcd1234abcd1234', 
                 source_locale_id = 'abcd1234abcd1234abcd1234abcd1234', 
                 custom_metadata_filters = None

{phrase_api-2.3.0 → phrase_api-2.4.0}/test/test_locales_api.py

@@ -12,7 +12,12 @@
 from __future__ import absolute_import
 
 import unittest
-from unittest.mock import Mock, patch
+import sys
+
+if sys.version_info[:2] <= (3, 7):
+    from mock import Mock, patch 
+else:
+    from unittest.mock import Mock, patch
 
 
 import phrase_api

{phrase_api-2.3.0 → phrase_api-2.4.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@5531484a', 
+                project_image = '[B@6622f6b4', 
                 remove_project_image = True, 
                 account_id = 'abcd1234', 
                 point_of_contact = 'abcd1234', 

{phrase_api-2.3.0 → phrase_api-2.4.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@99caac2', 
+                project_image = '[B@398e1a48', 
                 remove_project_image = False, 
                 workflow = 'review', 
                 machine_translation_enabled = True, 

{phrase_api-2.3.0 → phrase_api-2.4.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@776609b'
+                filename = '[B@2be33ac'
             )
         else :
             return ScreenshotUpdateParameters(

{phrase_api-2.3.0 → phrase_api-2.4.0}/test/test_uploads_api.py

@@ -12,7 +12,12 @@
 from __future__ import absolute_import
 
 import unittest
-from unittest.mock import Mock, patch
+import sys
+
+if sys.version_info[:2] <= (3, 7):
+    from mock import Mock, patch 
+else:
+    from unittest.mock import Mock, patch
 
 import phrase_api
 from phrase_api.api.uploads_api import UploadsApi  # noqa: E501