Merge Python Library
The Merge Python library provides convenient access to the Merge APIs from Python.
Table of Contents
- Documentation
- Installation
- Reference
- Usage
- Instantiation
- Categories
- Async Client
- Exception Handling
- Advanced
- Contributing
- File Download
- Pagination
Documentation
API reference documentation is available here.
Installation
pip install MergePythonClient
Reference
A full reference for this library is available here.
Usage
Instantiate and use the client with the following:
from merge import Merge
client = Merge(
api_key="<token>",
)
client.ats.account_token.regenerate_create()
Instantiation
import merge
from merge.client import Merge
client = Merge(api_key="YOUR_API_KEY", account_token="YOUR_ACCOUNT_TOKEN")
Categories
This SDK contains the ATS, HRIS, CRM, Ticketing, Accounting, and File Storage categories. Even if you do not plan on using more than one Merge API category right now, the SDK provides upgrade-flexibility in case you find new Merge API categories useful in the future.
Each category is namespaced:
client = Merge(api_key="YOUR_API_KEY")
client.ats. # APIs specific to the ATS Category
client.hris. # APIs specific to the HRIS Category
Async Client
The SDK also exports an async client so that you can make non-blocking calls to our API. Note that if you are constructing an Async httpx client class to pass into this client, use httpx.AsyncClient() instead of httpx.Client() (e.g. for the httpx_client parameter of this client).
import asyncio
from merge import AsyncMerge
client = AsyncMerge(
api_key="<token>",
)
async def main() -> None:
await client.ats.account_token.regenerate_create()
asyncio.run(main())
Exception Handling
When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error will be thrown.
from merge.core.api_error import ApiError
try:
client.ats.account_token.regenerate_create()
except ApiError as e:
print(e.status_code)
print(e.body)
Advanced
Access Raw Response Data
The SDK provides access to raw response data, including headers, through the .with_raw_response property.
The .with_raw_response property returns a "raw" client that can be used to access the .headers and .data attributes.
from merge import Merge
client = Merge(...)
response = client.ats.account_token.with_raw_response.regenerate_create()
print(response.headers) # access the response headers
print(response.status_code) # access the response status code
print(response.data) # access the underlying object
Retries
The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long as the request is deemed retryable and the number of retry attempts has not grown larger than the configured retry limit (default: 2).
A request is deemed retryable when any of the following HTTP status codes is returned:
Use the max_retries request option to configure this behavior.
client.ats.account_token.regenerate_create(request_options={
"max_retries": 1
})
Timeouts
The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.
from merge import Merge
client = Merge(..., timeout=20.0)
# Override timeout for a specific method
client.ats.account_token.regenerate_create(request_options={
"timeout_in_seconds": 1
})
Custom Client
You can override the httpx client to customize it for your use-case. Some common use-cases include support for proxies
and transports.
import httpx
from merge import Merge
client = Merge(
...,
httpx_client=httpx.Client(
proxy="http://my.test.proxy.example.com",
transport=httpx.HTTPTransport(local_address="0.0.0.0"),
),
)
Contributing
While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!
On the other hand, contributions to the README are always very welcome!
File Download
import merge
from merge.client import Merge
merge_client = Merge(
api_key="<YOUR_API_KEY>",
account_token="<YOUR_ACCOUNT_TOKEN>")
files = merge_client.filestorage.files.list(name="<FILE_NAME>").results
id = files[0].id
name = files[0].name
local_filename = f"<LOCAL_FILE_PATH>/{name}"
response = merge_client.filestorage.files.download_retrieve(id=id)
with open(local_filename, "wb") as f:
for chunk in response:
f.write(chunk)
Pagination
The SDK may return paginated results. Endpoints that return paginated results will
include a next and prev property on the response. To get the next page, you can
pass in the value of next to the cursor property on the request. Similarly, to
get the previous page, you can pass in the value of prev to the cursor property on
the request.
Below is an example of iterating over all pages:
# response contains the first page
response = merge_client.hris.employees.list(created_after="2030-01-01")
# if there is a next page, load it by passing `next` to the cursor argument
while response.next is not None:
response = hris_client.employees.list(
cursor=response.next,
created_after="2030-01-01")
2 maintainers
Metadata
2 maintainers
Release files for mergepythonclient 4.2.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mergepythonclient-4.2.1.tar.gz | 1.2 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mergepythonclient-4.2.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 4.3 MB
Release files / mergepythonclient-4.2.1.tar.gz
| Download URL | mergepythonclient-4.2.1.tar.gz |
|---|---|
| Size | 1.2 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
653c29129287d776ff55bab0a70c09b8bfbfa158ecee792df7264ed22f5f4b0a
|
|
BLAKE2b-256 checksum How to use checksums |
c636753e9159b80554e62cb6cfbb194365408179dfa64015f24aba34a64f94fd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.5.1 CPython/3.10.21 Linux/6.17.0-1022-azure
|
Release files / mergepythonclient-4.2.1-py3-none-any.whl
| Download URL | mergepythonclient-4.2.1-py3-none-any.whl |
|---|---|
| Size | 3.1 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8a706e38caa4da1e9bb0b3c9d3af19ea08a4f968f552b1cc0f2cccde5d752e50
|
|
BLAKE2b-256 checksum How to use checksums |
d53757ed9877a0989237c53e9f425874abf64ce33b9c0886279861bad3a8234c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.5.1 CPython/3.10.21 Linux/6.17.0-1022-azure
|
