Skip to content

Commit 0011856

Browse files
authored
Added delete_company to v2 API (#60)
* Added delete_company and test * Update README to include Delete for Company.
1 parent b96c136 commit 0011856

File tree

4 files changed

+10
-0
lines changed

4 files changed

+10
-0
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ It includes the following features from the [Freshdesk v2 API](https://developer
3939
- [Get](http://developer.freshdesk.com/api/#view_company)
4040
- [List](http://developer.freshdesk.com/api/#list_all_companies) (from 1.2.8)
4141
- [Filter](https://developers.freshdesk.com/api/#filter_companies) (from 1.3.2)
42+
- [Delete](https://developers.freshdesk.com/api/#delete_company)
4243
* [Roles](https://developers.freshdesk.com/api/#roles) (from 1.1.1)
4344
- [Get](http://developer.freshdesk.com/api/#view_role)
4445
- [List](http://developer.freshdesk.com/api/#list_role)

freshdesk/v2/api.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -403,6 +403,11 @@ def filter_companies(self, query, **kwargs):
403403
page += 1
404404

405405
return [Company(**c) for c in companies]
406+
407+
def delete_company(self, company_id):
408+
"""Delete the company for the given company ID"""
409+
url = "companies/%d" % company_id
410+
self._api._delete(url)
406411

407412

408413
class RoleAPI(object):

freshdesk/v2/tests/conftest.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ def __init__(self, *args):
6262
re.compile(r"agents/1$"): None,
6363
re.compile(r"contacts/1$"): None,
6464
re.compile(r"contacts/1/hard_delete\?force=True$"): None,
65+
re.compile(r"companies/1$"): None
6566
},
6667
}
6768

freshdesk/v2/tests/test_company.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,3 +46,6 @@ def test_filter_query(api):
4646
assert isinstance(companies[0], Company)
4747
assert len(companies) == 2
4848
assert "lexcorp.org" in companies[0].domains
49+
50+
def test_delete_company(api):
51+
assert api.companies.delete_company(1) is None

0 commit comments

Comments
 (0)