Metadata-Version: 2.4
Name: helpfalcon
Version: 1.0.0
Summary: HelpFalcon API client for Python, generated from the OpenAPI document.
License: MIT
Project-URL: Homepage, https://helpfalcon.com/developers/client-libraries
Project-URL: Documentation, https://helpfalcon.com/developers
Project-URL: API reference, https://helpfalcon.com/developers/api
Project-URL: Changelog, https://helpfalcon.com/developers/api-changelog
Keywords: helpfalcon,helpdesk,api,zendesk
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# helpfalcon

HelpFalcon API client for Python 3.9+. Every REST API operation is a method, generated from the
OpenAPI document; standard library only.

```python
from helpfalcon import HelpFalcon

client = HelpFalcon("https://acme.example.com", token=os.environ["HELPFALCON_TOKEN"])
ticket = client.tickets.get(id="0190...")
client.tickets.update(id=ticket["id"], body={"status": "solved"})
for t in client.paginate(client.tickets.list, status="open"):
    print(t["subject"])
client.request("GET", "/zd/api/v2/tickets.json")  # Zendesk-compatible API
```

Errors raise `HelpFalconError` (`status`, `body`). `429` and `503` are retried after `Retry-After`.
Docs: https://helpfalcon.com/developers/client-libraries
