Add last changed API

PyBambooHR/PyBambooHR.py

@@ -712,6 +712,30 @@ def get_meta_users(self):
 
         return r.json()
 
+    def get_last_changed(self, iso_timestamp):
+        """
+        API method for discovering which employees have been recently added, changed or deleted.
+        https://www.bamboohr.com/api/documentation/changes.php
+        @param iso_timestamp: get last changed since this ISO 8601 timestamp
+
+        @return: dictionary with employees which have been changed recently
+        """
+
+        url = self.base_url + "employees/changed/"
+        payload = {
+            'since': "{}".format(iso_timestamp)
+        }
+        # Convert payload to stop percent encoding the URL for requests
+        payload_str = "&".join("%s=%s" % (k,v) for k,v in payload.items())
+
+        r = requests.get(url, timeout=self.timeout, headers=self.headers, params=payload_str, auth=(self.api_key, ''))
+        r.raise_for_status()
+
+        last_changed = r.json()
+
+        return last_changed
+
+
     def _query(self, url, params, raw=False):
         url = self.base_url + url
         r = requests.get(url, timeout=self.timeout, params=params, headers=self.headers, auth=(self.api_key, ''))

README.md

@@ -93,3 +93,20 @@ bamboo = PyBambooHR(subdomain='yoursub', api_key='yourapikeyhere', only_current=
 
 ```
 BambooHR has effective dates for when promotions are scheduled to happen or when new hires are going to join the organization. In order to see these events before they happen using the BambooHR API set `only_current` to `False`. As a note, this only works for pulling reports and getting employee information. This does not work on getting the employee directory.
+
+
+Getting last changed
+```python
+from PyBambooHR import PyBambooHR
+
+bamboo = PyBambooHR(subdomain='yoursub', api_key='yourapikeyhere')
+
+# Date in ISO 8601, 15 minutes ago
+since_time = (datetime.datetime.now() - datetime.timedelta(minutes=15)).replace(microsecond=0)
+since_time_iso = since_time.strftime('%Y-%m-%dT%H:%M:%SZ')
+
+result = get_last_changed(since_time_iso)
+
+```
+
+Note: Last change timestamps are a newer feature in BambooHR, and they only started recording these dates from June 5th, 2011.