Deploying from phrase/openapi@f670e276

Author: Phrase

.openapi-generator/FILES

@@ -87,6 +87,7 @@ docs/JobCompleteParameters.md
 docs/JobCreateParameters.md
 docs/JobDetails.md
 docs/JobKeysCreateParameters.md
+docs/JobKeysDeleteParameters.md
 docs/JobLocale.md
 docs/JobLocaleCompleteParameters.md
 docs/JobLocaleCompleteReviewParameters.md
@@ -396,6 +397,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
@@ -633,6 +635,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

README.md

@@ -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)

docs/JobKeysDeleteParameters.md

@@ -0,0 +1,11 @@
+# JobKeysDeleteParameters
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **str** | specify the branch to use | [optional] 
+**translation_key_ids** | **List[str]** | ids of keys that should be deleted from the job | 
+
+[[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/JobsApi.md

@@ -297,7 +297,7 @@ Name | Type | Description  | Notes
 [[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)
 
 # **job_keys_delete**
-> job_keys_delete(project_id, id, x_phrase_app_otp=x_phrase_app_otp, branch=branch, translation_key_ids=translation_key_ids)
+> job_keys_delete(project_id, id, job_keys_delete_parameters, x_phrase_app_otp=x_phrase_app_otp)
 
 Remove keys from job
 
@@ -322,13 +322,12 @@ with phrase_api.ApiClient(configuration) as api_client:
     api_instance = phrase_api.JobsApi(api_client)
     project_id = 'project_id_example' # str | Project ID (required)
     id = 'id_example' # str | ID (required)
+    job_keys_delete_parameters = phrase_api.JobKeysDeleteParameters() # JobKeysDeleteParameters |  (required)
     x_phrase_app_otp = 'x_phrase_app_otp_example' # str | Two-Factor-Authentication token (optional)
-    branch = 'my-feature-branch' # str | specify the branch to use
-    translation_key_ids = ['[\"abcd1234cdef1234abcd1234cdef1234\"]'] # List[str] | ids of keys that should be removed from the job
 
     try:
         # Remove keys from job
-        api_instance.job_keys_delete(project_id, id, x_phrase_app_otp=x_phrase_app_otp, branch=branch, translation_key_ids=translation_key_ids)
+        api_instance.job_keys_delete(project_id, id, job_keys_delete_parameters, x_phrase_app_otp=x_phrase_app_otp)
     except ApiException as e:
         print("Exception when calling JobsApi->job_keys_delete: %s\n" % e)
 ```
@@ -340,9 +339,8 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **project_id** | **str**| Project ID | 
  **id** | **str**| ID | 
+ **job_keys_delete_parameters** | [**JobKeysDeleteParameters**](JobKeysDeleteParameters.md)|  | 
  **x_phrase_app_otp** | **str**| Two-Factor-Authentication token (optional) | [optional] 
- **branch** | **str**| specify the branch to use | [optional] 
- **translation_key_ids** | [**List[str]**](str.md)| ids of keys that should be removed from the job | [optional] 
 
 ### Return type
 
@@ -354,7 +352,7 @@ void (empty response body)
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
+ - **Content-Type**: application/json
  - **Accept**: Not defined
 
 ### HTTP response details

phrase_api/__init__.py

@@ -145,6 +145,7 @@
 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/api/jobs_api.py

@@ -578,21 +578,20 @@ def job_keys_create_with_http_info(self, project_id, id, job_keys_create_paramet
             _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 @@ def job_keys_delete(self, project_id, id, **kwargs):  # noqa: E501
                  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 @@ def job_keys_delete_with_http_info(self, project_id, id, **kwargs):  # noqa: E50
         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 @@ def job_keys_delete_with_http_info(self, project_id, id, **kwargs):  # noqa: E50
         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 @@ def job_keys_delete_with_http_info(self, project_id, id, **kwargs):  # noqa: E50
             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 @@ def job_keys_delete_with_http_info(self, project_id, id, **kwargs):  # noqa: E50
         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/models/__init__.py

@@ -78,6 +78,7 @@
 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/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: [email protected]
+    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()