rattail/rattail-harvest
2
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Add stop_time_entry() API method

Browse source
This commit is contained in:
Lance Edgar 2022-02-20 21:15:48 -06:00
parent d8e9714771
commit c6332be453
1 changed files with 18 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
rattail_harvest/harvest/webapi.py
View file

@ -58,6 +58,9 @@ class HarvestWebAPI(object):
elif request_method == 'POST': elif request_method == 'POST':
response = requests.post('{}/{}'.format(self.base_url, api_method), response = requests.post('{}/{}'.format(self.base_url, api_method),
headers=headers, params=params) headers=headers, params=params)
elif request_method == 'PATCH':
response = requests.patch('{}/{}'.format(self.base_url, api_method),
headers=headers, params=params)
else: else:
raise NotImplementedError("unknown request method: {}".format( raise NotImplementedError("unknown request method: {}".format(
request_method)) request_method))
@ -76,6 +79,12 @@ class HarvestWebAPI(object):
""" """
return self._request('POST', api_method, params=params) return self._request('POST', api_method, params=params)
def patch(self, api_method, params=None):
"""
Perform a PATCH request for the given API method, and return the response.
"""
return self._request('PATCH', api_method, params=params)
def get_company(self): def get_company(self):
""" """
Retrieves the company for the currently authenticated user. Retrieves the company for the currently authenticated user.
@ -168,6 +177,15 @@ class HarvestWebAPI(object):
response = self.post('/time_entries', params=kwargs) response = self.post('/time_entries', params=kwargs)
return response.json() return response.json()
def stop_time_entry(self, time_entry_id):
"""
Stop a running time entry.
https://help.getharvest.com/api-v2/timesheets-api/timesheets/time-entries/#stop-a-running-time-entry
"""
response = self.patch('/time_entries/{}/stop'.format(time_entry_id))
return response.json()
def make_harvest_webapi(config): def make_harvest_webapi(config):
access_token = config.require('harvest', 'api.access_token') access_token = config.require('harvest', 'api.access_token')