Added Service Desk REST API module.

Updated docs.

Author: SLRover

atlassian/__init__.py

@@ -5,5 +5,6 @@
 from .portfolio import Portfolio
 from .bamboo import Bamboo
 from .crowd import Crowd
+from .service_desk import ServiceDesk
 
-__all__ = ['Confluence', 'Jira', 'Bitbucket', 'Portfolio', 'Bamboo', 'Stash', 'Crowd']
+__all__ = ['Confluence', 'Jira', 'Bitbucket', 'Portfolio', 'Bamboo', 'Stash', 'Crowd', 'ServiceDesk']

atlassian/service_desk.py

@@ -0,0 +1,120 @@
+# coding: utf8
+import logging
+from .rest_client import AtlassianRestAPI
+
+log = logging.getLogger(__name__)
+
+
+class ServiceDesk(AtlassianRestAPI):
+    def get_info(self):
+        """ Get info about Service Desk app """
+        return self.get('/rest/servicedeskapi/info')
+
+    def create_customer(self, full_name, email):
+        """
+        Creating customer user
+
+        :param full_name: str
+        :param email: str
+        :return: New customer
+        """
+        log.warning('Creating customer...')
+        data = {'fullName': full_name, 'email': email}
+        headers = {'Content-Type': 'application/json',
+                   'Accept': 'application/json',
+                   'X-ExperimentalApi': 'opt-in'
+                   }
+        return self.post('/rest/servicedeskapi/customer', headers=headers, data=data)
+
+    def get_customer_request(self, issue_id_or_key):
+        """
+        Get single request
+
+        :param issue_id_or_key: str
+        :return: Customer request
+        """
+        return self.get('/rest/servicedeskapi/request/{}'.format(issue_id_or_key))
+
+    def get_my_customer_requests(self):
+        """ Returning requests where you are the assignee """
+        requests = self.get('/rest/servicedeskapi/request')
+        requests_values = requests.get('values')
+        return requests_values
+
+    def create_customer_request(self, service_desk_id, request_type_id, values_dict):
+        """
+        Creating customer request
+
+        :param service_desk_id: str
+        :param request_type_id: str
+        :param values_dict: str
+        :return: New request
+        """
+        log.warning('Creating request...')
+        data = {"serviceDeskId": service_desk_id,
+                "requestTypeId": request_type_id,
+                "requestFieldValues": values_dict
+                }
+        return self.post('/rest/servicedeskapi/request', data=data)
+
+    def get_customer_request_status(self, issue_id_or_key):
+        """
+        Get customer request status name
+
+        :param issue_id_or_key: str
+        :return: Status name
+        """
+        request = self.get('/rest/servicedeskapi/request/{}/status'.format(issue_id_or_key)).get('values')
+        status = request[0].get('status')
+        return status
+
+    def perform_transition(self, issue_id_or_key, transition_id, comment=None):
+        """
+        Perform a customer transition for a given request and transition ID.
+        An optional comment can be included to provide a reason for the transition.
+
+        :param issue_id_or_key: str
+        :param transition_id: str
+        :param comment: OPTIONAL: str
+        :return: None
+        """
+        log.warning('Performing transition...')
+        headers = {'Content-Type': 'application/json',
+                   'Accept': 'application/json',
+                   'X-ExperimentalApi': 'opt-in'
+                   }
+        data = {'id': transition_id, 'additionalComment': {'body': comment}}
+        url = '/rest/servicedeskapi/request/{}/transition'.format(issue_id_or_key)
+        return self.post(url, headers=headers, data=data)
+
+    def create_request_comment(self, issue_id_or_key, body, public=True):
+        """
+        Creating request comment
+
+        :param issue_id_or_key: str
+        :param body: str
+        :param public: OPTIONAL: bool (default is True)
+        :return: New comment
+        """
+        log.warning('Creating comment...')
+        data = {"body": body, "public": public}
+        return self.post('/rest/servicedeskapi/request/{}/comment'.format(issue_id_or_key), data=data)
+
+    def get_request_comments(self, issue_id_or_key):
+        """
+        Get all comments in issue
+
+        :param issue_id_or_key: str
+        :return: Issue comments
+        """
+        return self.get('/rest/servicedeskapi/request/{}/comment'.format(issue_id_or_key))
+
+    def get_request_comment_by_id(self, issue_id_or_key, comment_id):
+        """
+        Get single comment by ID
+
+        :param issue_id_or_key: str
+        :param comment_id: str
+        :return: Single comment
+        """
+        return self.get('/rest/servicedeskapi/request/{0}/comment/{1}'.format(issue_id_or_key, comment_id))

docs/index.rst

@@ -37,12 +37,18 @@ Add a connection:
         username='admin',
         password='admin')
 
+    service_desk = ServiceDesk(
+        url='http://localhost:8080',
+        username='admin',
+        password='admin')
+
 .. toctree::
    :maxdept:2
 
    jira
    confluence
    bitbucket
+   service_desk
 
 .. |Build Status| image:: https://travis-ci.org/AstroMatt/atlassian-python-api.svg?branch=master
    :target: https://pypi.python.org/pypi/atlassian-python-api

docs/service_desk.rst

@@ -0,0 +1,54 @@
+Jira Service Desk module
+========================
+
+Get info about Service Desk
+---------------------------
+
+.. code-block:: python
+
+    sd.get_info()
+
+Create customer
+---------------
+
+**EXPERIMENTAL** (may change without notice)
+
+.. code-block:: python
+
+    sd.create_customer(full_name, email)
+
+The Request actions
+-------------------
+
+.. code-block:: python
+
+    # Create customer request
+    sd.create_customer_request(service_desk_id, request_type_id, values_dict)
+
+    # Get customer request by ID
+    sd.get_customer_request(issue_id_or_key)
+
+    # Get customer requests
+    sd.get_my_customer_requests()
+
+    # Get customer request status
+    sd.get_customer_request_status(issue_id_or_key)
+
+    # Create comment. Optional argument public (True or False), default is True
+    sd.create_request_comment(issue_id_or_key, body, public=True)
+
+    # Get request comments
+    sd.get_request_comments(issue_id_or_key)
+
+    # Get request comment
+    sd.get_request_comment_by_id(issue_id_or_key, comment_id)
+
+Transitions
+-----------
+
+**EXPERIMENTAL** (may change without notice)
+
+.. code-block:: python
+
+    # Perform transition. Optional argument comment (string), default is None
+    sd.perform_transition(issue_id_or_key, transition_id, comment=None)