phrase-api 3.0.2__tar.gz → 3.0.3__tar.gz

{phrase_api-3.0.2 → phrase_api-3.0.3}/PKG-INFO

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

{phrase_api-3.0.2 → phrase_api-3.0.3}/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.0.2
+- Package version: 3.0.3
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 For more information, please visit [https://developers.phrase.com/api/](https://developers.phrase.com/api/)
 
@@ -481,6 +481,7 @@ Class | Method | HTTP request | Description
  - [JobCreateParameters](docs/JobCreateParameters.md)
  - [JobDetails](docs/JobDetails.md)
  - [JobKeysCreateParameters](docs/JobKeysCreateParameters.md)
+ - [JobKeysDeleteParameters](docs/JobKeysDeleteParameters.md)
  - [JobLocale](docs/JobLocale.md)
  - [JobLocaleCompleteParameters](docs/JobLocaleCompleteParameters.md)
  - [JobLocaleCompleteReviewParameters](docs/JobLocaleCompleteReviewParameters.md)

{phrase_api-3.0.2 → phrase_api-3.0.3}/phrase_api/__init__.py

@@ -13,7 +13,7 @@
 
 from __future__ import absolute_import
 
-__version__ = "3.0.2"
+__version__ = "3.0.3"
 
 # import apis into sdk package
 from phrase_api.api.accounts_api import AccountsApi
@@ -145,6 +145,7 @@ from phrase_api.models.job_complete_parameters import JobCompleteParameters
 from phrase_api.models.job_create_parameters import JobCreateParameters
 from phrase_api.models.job_details import JobDetails
 from phrase_api.models.job_keys_create_parameters import JobKeysCreateParameters
+from phrase_api.models.job_keys_delete_parameters import JobKeysDeleteParameters
 from phrase_api.models.job_locale import JobLocale
 from phrase_api.models.job_locale_complete_parameters import JobLocaleCompleteParameters
 from phrase_api.models.job_locale_complete_review_parameters import JobLocaleCompleteReviewParameters

{phrase_api-3.0.2 → phrase_api-3.0.3}/phrase_api/api/jobs_api.py

@@ -578,21 +578,20 @@ class JobsApi(object):
             _request_timeout=local_var_params.get('_request_timeout'),
             collection_formats=collection_formats)
 
-    def job_keys_delete(self, project_id, id, **kwargs):  # noqa: E501
+    def job_keys_delete(self, project_id, id, job_keys_delete_parameters, **kwargs):  # noqa: E501
         """Remove keys from job  # noqa: E501
 
         Remove multiple keys from existing job.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
-        >>> thread = api.job_keys_delete(project_id, id, async_req=True)
+        >>> thread = api.job_keys_delete(project_id, id, job_keys_delete_parameters, async_req=True)
         >>> result = thread.get()
 
         :param async_req bool: execute request asynchronously
         :param str project_id: Project ID (required)
         :param str id: ID (required)
+        :param JobKeysDeleteParameters job_keys_delete_parameters: (required)
         :param str x_phrase_app_otp: Two-Factor-Authentication token (optional)
-        :param str branch: specify the branch to use
-        :param List[str] translation_key_ids: ids of keys that should be removed from the job
         :param _preload_content: if False, the urllib3.HTTPResponse object will
                                  be returned without reading/decoding response
                                  data. Default is True.
@@ -605,23 +604,22 @@ class JobsApi(object):
                  returns the request thread.
         """
         kwargs['_return_http_data_only'] = True
-        return self.job_keys_delete_with_http_info(project_id, id, **kwargs)  # noqa: E501
+        return self.job_keys_delete_with_http_info(project_id, id, job_keys_delete_parameters, **kwargs)  # noqa: E501
 
-    def job_keys_delete_with_http_info(self, project_id, id, **kwargs):  # noqa: E501
+    def job_keys_delete_with_http_info(self, project_id, id, job_keys_delete_parameters, **kwargs):  # noqa: E501
         """Remove keys from job  # noqa: E501
 
         Remove multiple keys from existing job.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
-        >>> thread = api.job_keys_delete_with_http_info(project_id, id, async_req=True)
+        >>> thread = api.job_keys_delete_with_http_info(project_id, id, job_keys_delete_parameters, async_req=True)
         >>> result = thread.get()
 
         :param async_req bool: execute request asynchronously
         :param str project_id: Project ID (required)
         :param str id: ID (required)
+        :param JobKeysDeleteParameters job_keys_delete_parameters: (required)
         :param str x_phrase_app_otp: Two-Factor-Authentication token (optional)
-        :param str branch: specify the branch to use
-        :param List[str] translation_key_ids: ids of keys that should be removed from the job
         :param _return_http_data_only: response data without head status code
                                        and headers
         :param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -641,9 +639,8 @@ class JobsApi(object):
         all_params = [
             'project_id',
             'id',
-            'x_phrase_app_otp',
-            'branch',
-            'translation_key_ids'
+            'job_keys_delete_parameters',
+            'x_phrase_app_otp'
         ]
         all_params.extend(
             [
@@ -670,6 +667,10 @@ class JobsApi(object):
         if self.api_client.client_side_validation and ('id' not in local_var_params or  # noqa: E501
                                                         local_var_params['id'] is None):  # noqa: E501
             raise ApiValueError("Missing the required parameter `id` when calling `job_keys_delete`")  # noqa: E501
+        # verify the required parameter 'job_keys_delete_parameters' is set
+        if self.api_client.client_side_validation and ('job_keys_delete_parameters' not in local_var_params or  # noqa: E501
+                                                        local_var_params['job_keys_delete_parameters'] is None):  # noqa: E501
+            raise ApiValueError("Missing the required parameter `job_keys_delete_parameters` when calling `job_keys_delete`")  # noqa: E501
 
         collection_formats = {}
 
@@ -680,11 +681,6 @@ class JobsApi(object):
             path_params['id'] = local_var_params['id']  # noqa: E501
 
         query_params = []
-        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
-        if 'translation_key_ids' in local_var_params and local_var_params['translation_key_ids'] is not None:  # noqa: E501
-            query_params.append(('translation_key_ids', local_var_params['translation_key_ids']))  # noqa: E501
-            collection_formats['translation_key_ids'] = 'multi'  # noqa: E501
 
         header_params = {}
         if 'x_phrase_app_otp' in local_var_params:
@@ -694,6 +690,12 @@ class JobsApi(object):
         local_var_files = {}
 
         body_params = None
+        if 'job_keys_delete_parameters' in local_var_params:
+            body_params = local_var_params['job_keys_delete_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
 

{phrase_api-3.0.2 → phrase_api-3.0.3}/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.0.2/python'
+        self.user_agent = 'OpenAPI-Generator/3.0.3/python'
         self.client_side_validation = configuration.client_side_validation
 
     def __enter__(self):

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

{phrase_api-3.0.2 → phrase_api-3.0.3}/phrase_api/models/__init__.py

@@ -78,6 +78,7 @@ from phrase_api.models.job_complete_parameters import JobCompleteParameters
 from phrase_api.models.job_create_parameters import JobCreateParameters
 from phrase_api.models.job_details import JobDetails
 from phrase_api.models.job_keys_create_parameters import JobKeysCreateParameters
+from phrase_api.models.job_keys_delete_parameters import JobKeysDeleteParameters
 from phrase_api.models.job_locale import JobLocale
 from phrase_api.models.job_locale_complete_parameters import JobLocaleCompleteParameters
 from phrase_api.models.job_locale_complete_review_parameters import JobLocaleCompleteReviewParameters

phrase_api-3.0.3/phrase_api/models/job_keys_delete_parameters.py

@@ -0,0 +1,150 @@
+# 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 JobKeysDeleteParameters(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 = {
+        'branch': 'str',
+        'translation_key_ids': 'List[str]'
+    }
+
+    attribute_map = {
+        'branch': 'branch',
+        'translation_key_ids': 'translation_key_ids'
+    }
+
+    def __init__(self, branch=None, translation_key_ids=None, local_vars_configuration=None):  # noqa: E501
+        """JobKeysDeleteParameters - 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._branch = None
+        self._translation_key_ids = None
+        self.discriminator = None
+
+        if branch is not None:
+            self.branch = branch
+        self.translation_key_ids = translation_key_ids
+
+    @property
+    def branch(self):
+        """Gets the branch of this JobKeysDeleteParameters.  # noqa: E501
+
+        specify the branch to use  # noqa: E501
+
+        :return: The branch of this JobKeysDeleteParameters.  # noqa: E501
+        :rtype: str
+        """
+        return self._branch
+
+    @branch.setter
+    def branch(self, branch):
+        """Sets the branch of this JobKeysDeleteParameters.
+
+        specify the branch to use  # noqa: E501
+
+        :param branch: The branch of this JobKeysDeleteParameters.  # noqa: E501
+        :type: str
+        """
+
+        self._branch = branch
+
+    @property
+    def translation_key_ids(self):
+        """Gets the translation_key_ids of this JobKeysDeleteParameters.  # noqa: E501
+
+        ids of keys that should be deleted from the job  # noqa: E501
+
+        :return: The translation_key_ids of this JobKeysDeleteParameters.  # noqa: E501
+        :rtype: List[str]
+        """
+        return self._translation_key_ids
+
+    @translation_key_ids.setter
+    def translation_key_ids(self, translation_key_ids):
+        """Sets the translation_key_ids of this JobKeysDeleteParameters.
+
+        ids of keys that should be deleted from the job  # noqa: E501
+
+        :param translation_key_ids: The translation_key_ids of this JobKeysDeleteParameters.  # noqa: E501
+        :type: List[str]
+        """
+        if self.local_vars_configuration.client_side_validation and translation_key_ids is None:  # noqa: E501
+            raise ValueError("Invalid value for `translation_key_ids`, must not be `None`")  # noqa: E501
+
+        self._translation_key_ids = translation_key_ids
+
+    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, JobKeysDeleteParameters):
+            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, JobKeysDeleteParameters):
+            return True
+
+        return self.to_dict() != other.to_dict()

{phrase_api-3.0.2 → phrase_api-3.0.3}/phrase_api.egg-info/PKG-INFO

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

{phrase_api-3.0.2 → phrase_api-3.0.3}/phrase_api.egg-info/SOURCES.txt

@@ -135,6 +135,7 @@ phrase_api/models/job_complete_parameters.py
 phrase_api/models/job_create_parameters.py
 phrase_api/models/job_details.py
 phrase_api/models/job_keys_create_parameters.py
+phrase_api/models/job_keys_delete_parameters.py
 phrase_api/models/job_locale.py
 phrase_api/models/job_locale_complete_parameters.py
 phrase_api/models/job_locale_complete_review_parameters.py
@@ -364,6 +365,7 @@ test/test_job_complete_parameters.py
 test/test_job_create_parameters.py
 test/test_job_details.py
 test/test_job_keys_create_parameters.py
+test/test_job_keys_delete_parameters.py
 test/test_job_locale.py
 test/test_job_locale_complete_parameters.py
 test/test_job_locale_complete_review_parameters.py

{phrase_api-3.0.2 → phrase_api-3.0.3}/pyproject.toml

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

{phrase_api-3.0.2 → phrase_api-3.0.3}/setup.py

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

phrase_api-3.0.3/test/test_job_keys_delete_parameters.py

@@ -0,0 +1,56 @@
+# 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.job_keys_delete_parameters import JobKeysDeleteParameters  # noqa: E501
+from phrase_api.rest import ApiException
+
+class TestJobKeysDeleteParameters(unittest.TestCase):
+    """JobKeysDeleteParameters unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional):
+        """Test JobKeysDeleteParameters
+            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.job_keys_delete_parameters.JobKeysDeleteParameters()  # noqa: E501
+
+        """
+        if include_optional :
+            return JobKeysDeleteParameters(
+                branch = 'my-feature-branch', 
+                translation_key_ids = ["abcd1234cdef1234abcd1234cdef1234"]
+            )
+        else :
+            return JobKeysDeleteParameters(
+                translation_key_ids = ["abcd1234cdef1234abcd1234cdef1234"],
+        )
+        """
+
+    def testJobKeysDeleteParameters(self):
+        """Test JobKeysDeleteParameters"""
+        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.0.2 → phrase_api-3.0.3}/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@83d91c1', 
+                screenshot = '[B@1148eca4', 
                 remove_screenshot = True, 
                 unformatted = True, 
                 default_translation_content = 'Default translation content', 

{phrase_api-3.0.2 → phrase_api-3.0.3}/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@5c6eb961', 
+                screenshot = '[B@4d37c839', 
                 remove_screenshot = True, 
                 unformatted = True, 
                 xml_space_preserve = True, 

{phrase_api-3.0.2 → phrase_api-3.0.3}/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@78995f04', 
+                project_image = '[B@3fd3d49c', 
                 remove_project_image = True, 
                 account_id = 'abcd1234', 
                 point_of_contact = 'abcd1234', 

{phrase_api-3.0.2 → phrase_api-3.0.3}/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@6bb7e609', 
+                project_image = '[B@2cce1da1', 
                 remove_project_image = False, 
                 workflow = 'review', 
                 machine_translation_enabled = True, 

{phrase_api-3.0.2 → phrase_api-3.0.3}/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@3aee98e7'
+                filename = '[B@309ea91f'
             )
         else :
             return ScreenshotUpdateParameters(