Allow creating task with action and completion_rule. (#544)

Author: ab

AUTHORS.rst

@@ -12,3 +12,4 @@ used to interact with the Box API. This is a list of contributors.
 - `@capk1rk <https://github.com/capk1rk>`_
 - `@aculler <https://github.com/aculler>`_
 - `@ben-reilly <https://github.com/ben-reilly>`_
+- `@ab <https://github.com/ab>`_

HISTORY.rst

@@ -7,6 +7,7 @@ Next Release
 ++++++++
 - Allow ints to be passed in as item IDs
 - Fix bug with updating a collaboration role to owner
+- Allow creating tasks with the `action` and `completion_rule` parameters.
 - Add support for `copyInstanceOnItemCopy` field for metadata templates
 
 2.9.0 (2020-06-23)

boxsdk/object/file.py

@@ -531,7 +531,8 @@ def add_comment(self, message):
         )
 
     @api_call
-    def create_task(self, message=None, due_at=None):
+    def create_task(self, message=None, due_at=None, action='review',
+                    completion_rule=None):
         """
         Create a task on the given file.
 
@@ -543,6 +544,17 @@ def create_task(self, message=None, due_at=None):
             When this task is due.
         :type due_at:
             `unicode` or None
+        :param action:
+            The type of task the task assignee will be prompted to perform.
+            Value is one of review,complete
+        :type action:
+            `unicode`
+        :param completion_rule:
+            Defines which assignees need to complete this task before the task
+            is considered completed.
+            Value is one of all_assignees,any_assignee
+        :type completion_rule:
+            `unicode` or None
         :return:
             The newly created task
         :rtype:
@@ -554,12 +566,14 @@ def create_task(self, message=None, due_at=None):
                 'type': 'file',
                 'id': self.object_id
             },
-            'action': 'review',
+            'action': action,
         }
         if message is not None:
             task_attributes['message'] = message
         if due_at is not None:
             task_attributes['due_at'] = due_at
+        if completion_rule is not None:
+            task_attributes['completion_rule'] = completion_rule
         box_response = self._session.post(url, data=json.dumps(task_attributes))
         response = box_response.json()
         return self.translator.translate(

test/unit/object/test_file.py

@@ -150,6 +150,48 @@ def test_create_task(test_file, test_task, mock_box_session):
     assert new_task.due_at == due_at
 
 
+def test_create_task_with_review(test_file, test_task, mock_box_session):
+    # pylint:disable=redefined-outer-name
+    expected_url = "{0}/tasks".format(API.BASE_API_URL)
+    due_at = '2020-09-18T12:09:43-00:00'
+    action = 'complete'
+    message = 'Test Message'
+    completion_rule = 'any_assignee'
+    expected_body = {
+        'item': {
+            'type': 'file',
+            'id': '42',
+        },
+        'action': action,
+        'message': message,
+        'due_at': due_at,
+        'completion_rule': completion_rule,
+    }
+    mock_box_session.post.return_value.json.return_value = {
+        'type': test_task.object_type,
+        'id': test_task.object_id,
+        'due_at': due_at,
+        'action': action,
+        'message': message,
+        'completion_rule': completion_rule,
+    }
+    value = json.dumps(expected_body)
+    new_task = test_file.create_task(
+        message=message,
+        due_at=due_at,
+        action=action,
+        completion_rule=completion_rule,
+    )
+    mock_box_session.post.assert_called_once_with(expected_url, data=value)
+    assert isinstance(new_task, Task)
+    assert new_task.object_type == test_task.object_type
+    assert new_task.object_id == test_task.object_id
+    assert new_task.action == action
+    assert new_task.message == message
+    assert new_task.due_at == due_at
+    assert new_task.completion_rule == completion_rule
+
+
 def test_get_tasks(test_file, mock_box_session):
     expected_url = test_file.get_url('tasks')
     task_body = {