mergepythonclient 1.0.8__tar.gz → 1.0.9__tar.gz

mergepythonclient-1.0.9/PKG-INFO

@@ -0,0 +1,232 @@
+Metadata-Version: 2.1
+Name: mergepythonclient
+Version: 1.0.9
+Summary: 
+Requires-Python: >=3.8,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Dist: httpx (>=0.21.2)
+Requires-Dist: pydantic (>=1.9.2)
+Requires-Dist: typing_extensions (>=4.0.0)
+Description-Content-Type: text/markdown
+
+# Merge Python Library
+
+[![pypi](https://img.shields.io/pypi/v/MergePythonClient.svg)](https://pypi.python.org/pypi/MergePythonClient)
+
+The Merge Python library provides access to the Merge API from Python.
+
+## Documentation
+
+API reference documentation is available [here](https://docs.merge.dev/).
+
+## Installation
+
+```sh
+pip install --upgrade MergePythonClient
+```
+
+## Instantiation
+
+```python
+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:
+
+```python
+client = Merge(api_key="YOUR_API_KEY")
+
+client.ats. # APIs specific to the ATS Category
+
+client.hris. # APIs specific to the HRIS Category
+```
+
+## Usage
+
+### Async Client
+The SDK also exports an async client so that you can make non-blocking
+calls to our API. This client leverages `httpx`'s AsyncClient, and exports all the same functions and functionality of the sync client.
+
+```python
+import asyncio
+from merge.client import AsyncMerge
+
+client = AsyncMerge(
+    api_key="<YOUR_API_KEY>", 
+    account_token="<YOUR_ACCOUNT_TOKEN>")
+
+async def main() -> None:
+    await merge_client.ats.link_token.create(
+        end_user_email_address="john.smith@gmail.com",
+        end_user_organization_name="acme",
+        end_user_origin_id="1234",
+        categories=[CategoriesEnum.ATS],
+        link_expiry_mins=30,
+    )
+
+asyncio.run(main())
+```
+
+### Create Link Token
+
+```python
+import merge
+from merge.client import Merge
+from merge.resources.ats.types import CategoriesEnum
+
+merge_client = Merge(
+    api_key="<YOUR_API_KEY>", 
+    account_token="<YOUR_ACCOUNT_TOKEN>")
+
+link_token_response = merge_client.ats.link_token.create(
+    end_user_email_address="john.smith@gmail.com",
+    end_user_organization_name="acme",
+    end_user_origin_id="1234",
+    categories=[CategoriesEnum.ATS],
+    link_expiry_mins=30,
+)
+
+print("Created link token", link_token_response.link_token)
+```
+
+### Get Employee
+
+```python
+import merge
+from merge.client import Merge
+
+merge_client = Merge(
+    api_key="<YOUR_API_KEY>", 
+    account_token="<YOUR_ACCOUNT_TOKEN>")
+
+employee = merge_client.hris.employees.retrieve(
+    id="0958cbc6-6040-430a-848e-aafacbadf4ae")
+```
+
+### Get Candidate
+
+```python
+import merge
+from merge.client import Merge
+
+merge_client = Merge(
+    api_key="<YOUR_API_KEY>", 
+    account_token="<YOUR_ACCOUNT_TOKEN>")
+
+candidate = merge_client.ats.candidates.retrieve(
+    id="521b18c2-4d01-4297-b451-19858d07c133")
+```
+
+### Filter Candidate
+
+```python
+import merge
+from merge.client import Merge
+
+merge_client = Merge(
+    api_key="<YOUR_API_KEY>", 
+    account_token="<YOUR_ACCOUNT_TOKEN>")
+
+candidates_response = merge_client.ats.candidates.list(
+    created_after="2030-01-01")
+
+print(candidates_response.results)
+```
+
+### Get Contact
+
+```python
+import merge
+from merge.client import Merge
+
+merge_client = Merge(
+    api_key="<YOUR_API_KEY>", 
+    account_token="<YOUR_ACCOUNT_TOKEN>")
+
+contact = merge_client.accounting.contacts.retrieve(
+    id="c640b80b-fac9-409f-aa19-1f9221aec445")
+```
+
+### Create Ticket
+
+```python
+import merge
+from merge.client import Merge
+from merge.resources.ticketing.types import TicketStatusEnum
+
+merge_client = Merge(
+    api_key="<YOUR_API_KEY>", 
+    account_token="<YOUR_ACCOUNT_TOKEN>")
+
+merge_client.ticketing.tickets.create(
+    model=merge.ticketing.TicketRequest(
+        name="Please add more integrations",
+        assignees=[
+            "17a54124-287f-494d-965e-3c5b330c9a68"
+        ],
+        creator="3fa85f64-5717-4562-b3fc-2c963f66afa6",
+        due_date="2022-10-11T00:00:00Z",
+        status=TicketStatusEnum.OPEN,
+    ))
+```
+
+## File Download
+
+```python
+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:
+```python
+
+# 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")
+```
+
+## 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!
+

mergepythonclient-1.0.9/README.md

@@ -0,0 +1,216 @@
+# Merge Python Library
+
+[![pypi](https://img.shields.io/pypi/v/MergePythonClient.svg)](https://pypi.python.org/pypi/MergePythonClient)
+
+The Merge Python library provides access to the Merge API from Python.
+
+## Documentation
+
+API reference documentation is available [here](https://docs.merge.dev/).
+
+## Installation
+
+```sh
+pip install --upgrade MergePythonClient
+```
+
+## Instantiation
+
+```python
+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:
+
+```python
+client = Merge(api_key="YOUR_API_KEY")
+
+client.ats. # APIs specific to the ATS Category
+
+client.hris. # APIs specific to the HRIS Category
+```
+
+## Usage
+
+### Async Client
+The SDK also exports an async client so that you can make non-blocking
+calls to our API. This client leverages `httpx`'s AsyncClient, and exports all the same functions and functionality of the sync client.
+
+```python
+import asyncio
+from merge.client import AsyncMerge
+
+client = AsyncMerge(
+    api_key="<YOUR_API_KEY>", 
+    account_token="<YOUR_ACCOUNT_TOKEN>")
+
+async def main() -> None:
+    await merge_client.ats.link_token.create(
+        end_user_email_address="john.smith@gmail.com",
+        end_user_organization_name="acme",
+        end_user_origin_id="1234",
+        categories=[CategoriesEnum.ATS],
+        link_expiry_mins=30,
+    )
+
+asyncio.run(main())
+```
+
+### Create Link Token
+
+```python
+import merge
+from merge.client import Merge
+from merge.resources.ats.types import CategoriesEnum
+
+merge_client = Merge(
+    api_key="<YOUR_API_KEY>", 
+    account_token="<YOUR_ACCOUNT_TOKEN>")
+
+link_token_response = merge_client.ats.link_token.create(
+    end_user_email_address="john.smith@gmail.com",
+    end_user_organization_name="acme",
+    end_user_origin_id="1234",
+    categories=[CategoriesEnum.ATS],
+    link_expiry_mins=30,
+)
+
+print("Created link token", link_token_response.link_token)
+```
+
+### Get Employee
+
+```python
+import merge
+from merge.client import Merge
+
+merge_client = Merge(
+    api_key="<YOUR_API_KEY>", 
+    account_token="<YOUR_ACCOUNT_TOKEN>")
+
+employee = merge_client.hris.employees.retrieve(
+    id="0958cbc6-6040-430a-848e-aafacbadf4ae")
+```
+
+### Get Candidate
+
+```python
+import merge
+from merge.client import Merge
+
+merge_client = Merge(
+    api_key="<YOUR_API_KEY>", 
+    account_token="<YOUR_ACCOUNT_TOKEN>")
+
+candidate = merge_client.ats.candidates.retrieve(
+    id="521b18c2-4d01-4297-b451-19858d07c133")
+```
+
+### Filter Candidate
+
+```python
+import merge
+from merge.client import Merge
+
+merge_client = Merge(
+    api_key="<YOUR_API_KEY>", 
+    account_token="<YOUR_ACCOUNT_TOKEN>")
+
+candidates_response = merge_client.ats.candidates.list(
+    created_after="2030-01-01")
+
+print(candidates_response.results)
+```
+
+### Get Contact
+
+```python
+import merge
+from merge.client import Merge
+
+merge_client = Merge(
+    api_key="<YOUR_API_KEY>", 
+    account_token="<YOUR_ACCOUNT_TOKEN>")
+
+contact = merge_client.accounting.contacts.retrieve(
+    id="c640b80b-fac9-409f-aa19-1f9221aec445")
+```
+
+### Create Ticket
+
+```python
+import merge
+from merge.client import Merge
+from merge.resources.ticketing.types import TicketStatusEnum
+
+merge_client = Merge(
+    api_key="<YOUR_API_KEY>", 
+    account_token="<YOUR_ACCOUNT_TOKEN>")
+
+merge_client.ticketing.tickets.create(
+    model=merge.ticketing.TicketRequest(
+        name="Please add more integrations",
+        assignees=[
+            "17a54124-287f-494d-965e-3c5b330c9a68"
+        ],
+        creator="3fa85f64-5717-4562-b3fc-2c963f66afa6",
+        due_date="2022-10-11T00:00:00Z",
+        status=TicketStatusEnum.OPEN,
+    ))
+```
+
+## File Download
+
+```python
+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:
+```python
+
+# 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")
+```
+
+## 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!

mergepythonclient-1.0.9/pyproject.toml

@@ -0,0 +1,23 @@
+[tool.poetry]
+name = "MergePythonClient"
+version = "1.0.9"
+description = ""
+readme = "README.md"
+authors = []
+packages = [
+    { include = "merge", from = "src"}
+]
+
+[tool.poetry.dependencies]
+python = "^3.8"
+httpx = ">=0.21.2"
+pydantic = ">= 1.9.2"
+typing_extensions = ">= 4.0.0"
+
+[tool.poetry.dev-dependencies]
+mypy = "^1.8.0"
+pytest = "^7.4.0"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

mergepythonclient-1.0.9/src/merge/client.py

@@ -0,0 +1,73 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import httpx
+
+from .core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from .environment import MergeEnvironment
+from .resources.accounting.client import AccountingClient, AsyncAccountingClient
+from .resources.ats.client import AsyncAtsClient, AtsClient
+from .resources.crm.client import AsyncCrmClient, CrmClient
+from .resources.filestorage.client import AsyncFilestorageClient, FilestorageClient
+from .resources.hris.client import AsyncHrisClient, HrisClient
+from .resources.ticketing.client import AsyncTicketingClient, TicketingClient
+
+
+class Merge:
+    def __init__(
+        self,
+        *,
+        base_url: typing.Optional[str] = None,
+        environment: MergeEnvironment = MergeEnvironment.PRODUCTION,
+        account_token: typing.Optional[str] = None,
+        api_key: typing.Union[str, typing.Callable[[], str]],
+        timeout: typing.Optional[float] = 60,
+        httpx_client: typing.Optional[httpx.Client] = None
+    ):
+        self._client_wrapper = SyncClientWrapper(
+            base_url=_get_base_url(base_url=base_url, environment=environment),
+            account_token=account_token,
+            api_key=api_key,
+            httpx_client=httpx.Client(timeout=timeout) if httpx_client is None else httpx_client,
+        )
+        self.ats = AtsClient(client_wrapper=self._client_wrapper)
+        self.crm = CrmClient(client_wrapper=self._client_wrapper)
+        self.filestorage = FilestorageClient(client_wrapper=self._client_wrapper)
+        self.ticketing = TicketingClient(client_wrapper=self._client_wrapper)
+        self.hris = HrisClient(client_wrapper=self._client_wrapper)
+        self.accounting = AccountingClient(client_wrapper=self._client_wrapper)
+
+
+class AsyncMerge:
+    def __init__(
+        self,
+        *,
+        base_url: typing.Optional[str] = None,
+        environment: MergeEnvironment = MergeEnvironment.PRODUCTION,
+        account_token: typing.Optional[str] = None,
+        api_key: typing.Union[str, typing.Callable[[], str]],
+        timeout: typing.Optional[float] = 60,
+        httpx_client: typing.Optional[httpx.AsyncClient] = None
+    ):
+        self._client_wrapper = AsyncClientWrapper(
+            base_url=_get_base_url(base_url=base_url, environment=environment),
+            account_token=account_token,
+            api_key=api_key,
+            httpx_client=httpx.AsyncClient(timeout=timeout) if httpx_client is None else httpx_client,
+        )
+        self.ats = AsyncAtsClient(client_wrapper=self._client_wrapper)
+        self.crm = AsyncCrmClient(client_wrapper=self._client_wrapper)
+        self.filestorage = AsyncFilestorageClient(client_wrapper=self._client_wrapper)
+        self.ticketing = AsyncTicketingClient(client_wrapper=self._client_wrapper)
+        self.hris = AsyncHrisClient(client_wrapper=self._client_wrapper)
+        self.accounting = AsyncAccountingClient(client_wrapper=self._client_wrapper)
+
+
+def _get_base_url(*, base_url: typing.Optional[str] = None, environment: MergeEnvironment) -> str:
+    if base_url is not None:
+        return base_url
+    elif environment is not None:
+        return environment.value
+    else:
+        raise Exception("Please pass in either base_url or environment to construct the client")

mergepythonclient-1.0.9/src/merge/core/client_wrapper.py

@@ -0,0 +1,64 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import httpx
+
+
+class BaseClientWrapper:
+    def __init__(
+        self,
+        *,
+        account_token: typing.Optional[str] = None,
+        api_key: typing.Union[str, typing.Callable[[], str]],
+        base_url: str,
+    ):
+        self._account_token = account_token
+        self._api_key = api_key
+        self._base_url = base_url
+
+    def get_headers(self) -> typing.Dict[str, str]:
+        headers: typing.Dict[str, str] = {
+            "X-Fern-Language": "Python",
+            "X-Fern-SDK-Name": "MergePythonClient",
+            "X-Fern-SDK-Version": "1.0.9",
+        }
+        if self._account_token is not None:
+            headers["X-Account-Token"] = self._account_token
+        headers["Authorization"] = f"Bearer {self._get_api_key()}"
+        return headers
+
+    def _get_api_key(self) -> str:
+        if isinstance(self._api_key, str):
+            return self._api_key
+        else:
+            return self._api_key()
+
+    def get_base_url(self) -> str:
+        return self._base_url
+
+
+class SyncClientWrapper(BaseClientWrapper):
+    def __init__(
+        self,
+        *,
+        account_token: typing.Optional[str] = None,
+        api_key: typing.Union[str, typing.Callable[[], str]],
+        base_url: str,
+        httpx_client: httpx.Client,
+    ):
+        super().__init__(account_token=account_token, api_key=api_key, base_url=base_url)
+        self.httpx_client = httpx_client
+
+
+class AsyncClientWrapper(BaseClientWrapper):
+    def __init__(
+        self,
+        *,
+        account_token: typing.Optional[str] = None,
+        api_key: typing.Union[str, typing.Callable[[], str]],
+        base_url: str,
+        httpx_client: httpx.AsyncClient,
+    ):
+        super().__init__(account_token=account_token, api_key=api_key, base_url=base_url)
+        self.httpx_client = httpx_client