mergepythonclient 2.0.0__tar.gz → 2.1.0__tar.gz

{mergepythonclient-2.0.0 → mergepythonclient-2.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mergepythonclient
-Version: 2.0.0
+Version: 2.1.0
 Summary: 
 Requires-Python: >=3.8,<4.0
 Classifier: Intended Audience :: Developers
@@ -20,7 +20,7 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Typing :: Typed
 Requires-Dist: httpx (>=0.21.2)
 Requires-Dist: pydantic (>=1.9.2)
-Requires-Dist: pydantic-core (>=2.18.2,<3.0.0)
+Requires-Dist: pydantic-core (>=2.18.2)
 Requires-Dist: typing_extensions (>=4.0.0)
 Description-Content-Type: text/markdown
 
@@ -45,6 +45,24 @@ pip install MergePythonClient
 
 A full reference for this library is available [here](https://github.com/merge-api/merge-python-client/blob/HEAD/./reference.md).
 
+## Usage
+
+Instantiate and use the client with the following:
+
+```python
+from merge import Merge
+from merge.resources.ats import ActivityRequest
+
+client = Merge(
+    account_token="YOUR_ACCOUNT_TOKEN",
+    api_key="YOUR_API_KEY",
+)
+client.ats.activities.create(
+    model=ActivityRequest(),
+    remote_user_id="remote_user_id",
+)
+```
+
 ## Instantiation
 
 ```python
@@ -68,24 +86,6 @@ client.ats. # APIs specific to the ATS Category
 client.hris. # APIs specific to the HRIS Category
 ```
 
-## Usage
-
-Instantiate and use the client with the following:
-
-```python
-from merge import Merge
-from merge.resources.ats import ActivityRequest
-
-client = Merge(
-    account_token="YOUR_ACCOUNT_TOKEN",
-    api_key="YOUR_API_KEY",
-)
-client.ats.activities.create(
-    model=ActivityRequest(),
-    remote_user_id="remote_user_id",
-)
-```
-
 ## Async Client
 
 The SDK also exports an `async` client so that you can make non-blocking calls to our API.
@@ -127,49 +127,6 @@ except ApiError as e:
     print(e.body)
 ```
 
-## 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")
-```
-
 ## Advanced
 
 ### Access Raw Response Data
@@ -255,4 +212,47 @@ a proof of concept, but know that we will not be able to merge it as-is. We sugg
 an issue first to discuss with us!
 
 On the other hand, contributions to the README are always very welcome!
+## 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")
+```
+
 

{mergepythonclient-2.0.0 → mergepythonclient-2.1.0}/pyproject.toml

@@ -3,7 +3,7 @@ name = "MergePythonClient"
 
 [tool.poetry]
 name = "MergePythonClient"
-version = "2.0.0"
+version = "2.1.0"
 description = ""
 readme = "README.md"
 authors = []
@@ -37,7 +37,7 @@ Repository = 'https://github.com/merge-api/merge-python-client'
 python = "^3.8"
 httpx = ">=0.21.2"
 pydantic = ">= 1.9.2"
-pydantic-core = "^2.18.2"
+pydantic-core = ">=2.18.2"
 typing_extensions = ">= 4.0.0"
 
 [tool.poetry.group.dev.dependencies]

{mergepythonclient-2.0.0 → mergepythonclient-2.1.0}/src/merge/client.py

@@ -33,6 +33,9 @@ class Merge:
 
     account_token : typing.Optional[str]
     api_key : typing.Union[str, typing.Callable[[], str]]
+    headers : typing.Optional[typing.Dict[str, str]]
+        Additional headers to send with every request.
+
     timeout : typing.Optional[float]
         The timeout to be used, in seconds, for requests. By default the timeout is 60 seconds, unless a custom httpx client is used, in which case this default is not enforced.
 
@@ -59,6 +62,7 @@ class Merge:
         environment: MergeEnvironment = MergeEnvironment.PRODUCTION,
         account_token: typing.Optional[str] = None,
         api_key: typing.Union[str, typing.Callable[[], str]],
+        headers: typing.Optional[typing.Dict[str, str]] = None,
         timeout: typing.Optional[float] = None,
         follow_redirects: typing.Optional[bool] = True,
         httpx_client: typing.Optional[httpx.Client] = None,
@@ -70,6 +74,7 @@ class Merge:
             base_url=_get_base_url(base_url=base_url, environment=environment),
             account_token=account_token,
             api_key=api_key,
+            headers=headers,
             httpx_client=httpx_client
             if httpx_client is not None
             else httpx.Client(timeout=_defaulted_timeout, follow_redirects=follow_redirects)
@@ -78,10 +83,10 @@ class Merge:
             timeout=_defaulted_timeout,
         )
         self.ats = AtsClient(client_wrapper=self._client_wrapper)
-        self.filestorage = FilestorageClient(client_wrapper=self._client_wrapper)
-        self.ticketing = TicketingClient(client_wrapper=self._client_wrapper)
         self.crm = CrmClient(client_wrapper=self._client_wrapper)
+        self.filestorage = FilestorageClient(client_wrapper=self._client_wrapper)
         self.hris = HrisClient(client_wrapper=self._client_wrapper)
+        self.ticketing = TicketingClient(client_wrapper=self._client_wrapper)
         self.accounting = AccountingClient(client_wrapper=self._client_wrapper)
 
 
@@ -105,6 +110,9 @@ class AsyncMerge:
 
     account_token : typing.Optional[str]
     api_key : typing.Union[str, typing.Callable[[], str]]
+    headers : typing.Optional[typing.Dict[str, str]]
+        Additional headers to send with every request.
+
     timeout : typing.Optional[float]
         The timeout to be used, in seconds, for requests. By default the timeout is 60 seconds, unless a custom httpx client is used, in which case this default is not enforced.
 
@@ -131,6 +139,7 @@ class AsyncMerge:
         environment: MergeEnvironment = MergeEnvironment.PRODUCTION,
         account_token: typing.Optional[str] = None,
         api_key: typing.Union[str, typing.Callable[[], str]],
+        headers: typing.Optional[typing.Dict[str, str]] = None,
         timeout: typing.Optional[float] = None,
         follow_redirects: typing.Optional[bool] = True,
         httpx_client: typing.Optional[httpx.AsyncClient] = None,
@@ -142,6 +151,7 @@ class AsyncMerge:
             base_url=_get_base_url(base_url=base_url, environment=environment),
             account_token=account_token,
             api_key=api_key,
+            headers=headers,
             httpx_client=httpx_client
             if httpx_client is not None
             else httpx.AsyncClient(timeout=_defaulted_timeout, follow_redirects=follow_redirects)
@@ -150,10 +160,10 @@ class AsyncMerge:
             timeout=_defaulted_timeout,
         )
         self.ats = AsyncAtsClient(client_wrapper=self._client_wrapper)
-        self.filestorage = AsyncFilestorageClient(client_wrapper=self._client_wrapper)
-        self.ticketing = AsyncTicketingClient(client_wrapper=self._client_wrapper)
         self.crm = AsyncCrmClient(client_wrapper=self._client_wrapper)
+        self.filestorage = AsyncFilestorageClient(client_wrapper=self._client_wrapper)
         self.hris = AsyncHrisClient(client_wrapper=self._client_wrapper)
+        self.ticketing = AsyncTicketingClient(client_wrapper=self._client_wrapper)
         self.accounting = AsyncAccountingClient(client_wrapper=self._client_wrapper)
 
 

{mergepythonclient-2.0.0 → mergepythonclient-2.1.0}/src/merge/core/client_wrapper.py

@@ -12,20 +12,23 @@ class BaseClientWrapper:
         *,
         account_token: typing.Optional[str] = None,
         api_key: typing.Union[str, typing.Callable[[], str]],
+        headers: typing.Optional[typing.Dict[str, str]] = None,
         base_url: str,
         timeout: typing.Optional[float] = None,
     ):
         self._account_token = account_token
         self._api_key = api_key
+        self._headers = headers
         self._base_url = base_url
         self._timeout = timeout
 
     def get_headers(self) -> typing.Dict[str, str]:
         headers: typing.Dict[str, str] = {
-            "User-Agent": "MergePythonClient/2.0.0",
+            "User-Agent": "MergePythonClient/2.1.0",
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "MergePythonClient",
-            "X-Fern-SDK-Version": "2.0.0",
+            "X-Fern-SDK-Version": "2.1.0",
+            **(self.get_custom_headers() or {}),
         }
         if self._account_token is not None:
             headers["X-Account-Token"] = self._account_token
@@ -38,6 +41,9 @@ class BaseClientWrapper:
         else:
             return self._api_key()
 
+    def get_custom_headers(self) -> typing.Optional[typing.Dict[str, str]]:
+        return self._headers
+
     def get_base_url(self) -> str:
         return self._base_url
 
@@ -51,11 +57,14 @@ class SyncClientWrapper(BaseClientWrapper):
         *,
         account_token: typing.Optional[str] = None,
         api_key: typing.Union[str, typing.Callable[[], str]],
+        headers: typing.Optional[typing.Dict[str, str]] = None,
         base_url: str,
         timeout: typing.Optional[float] = None,
         httpx_client: httpx.Client,
     ):
-        super().__init__(account_token=account_token, api_key=api_key, base_url=base_url, timeout=timeout)
+        super().__init__(
+            account_token=account_token, api_key=api_key, headers=headers, base_url=base_url, timeout=timeout
+        )
         self.httpx_client = HttpClient(
             httpx_client=httpx_client,
             base_headers=self.get_headers,
@@ -70,11 +79,14 @@ class AsyncClientWrapper(BaseClientWrapper):
         *,
         account_token: typing.Optional[str] = None,
         api_key: typing.Union[str, typing.Callable[[], str]],
+        headers: typing.Optional[typing.Dict[str, str]] = None,
         base_url: str,
         timeout: typing.Optional[float] = None,
         httpx_client: httpx.AsyncClient,
     ):
-        super().__init__(account_token=account_token, api_key=api_key, base_url=base_url, timeout=timeout)
+        super().__init__(
+            account_token=account_token, api_key=api_key, headers=headers, base_url=base_url, timeout=timeout
+        )
         self.httpx_client = AsyncHttpClient(
             httpx_client=httpx_client,
             base_headers=self.get_headers,

{mergepythonclient-2.0.0 → mergepythonclient-2.1.0}/README.md

@@ -19,6 +19,24 @@ pip install MergePythonClient
 
 A full reference for this library is available [here](https://github.com/merge-api/merge-python-client/blob/HEAD/./reference.md).
 
+## Usage
+
+Instantiate and use the client with the following:
+
+```python
+from merge import Merge
+from merge.resources.ats import ActivityRequest
+
+client = Merge(
+    account_token="YOUR_ACCOUNT_TOKEN",
+    api_key="YOUR_API_KEY",
+)
+client.ats.activities.create(
+    model=ActivityRequest(),
+    remote_user_id="remote_user_id",
+)
+```
+
 ## Instantiation
 
 ```python
@@ -42,24 +60,6 @@ client.ats. # APIs specific to the ATS Category
 client.hris. # APIs specific to the HRIS Category
 ```
 
-## Usage
-
-Instantiate and use the client with the following:
-
-```python
-from merge import Merge
-from merge.resources.ats import ActivityRequest
-
-client = Merge(
-    account_token="YOUR_ACCOUNT_TOKEN",
-    api_key="YOUR_API_KEY",
-)
-client.ats.activities.create(
-    model=ActivityRequest(),
-    remote_user_id="remote_user_id",
-)
-```
-
 ## Async Client
 
 The SDK also exports an `async` client so that you can make non-blocking calls to our API.
@@ -101,49 +101,6 @@ except ApiError as e:
     print(e.body)
 ```
 
-## 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")
-```
-
 ## Advanced
 
 ### Access Raw Response Data
@@ -229,3 +186,46 @@ a proof of concept, but know that we will not be able to merge it as-is. We sugg
 an issue first to discuss with us!
 
 On the other hand, contributions to the README are always very welcome!
+## 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")
+```
+