Unified-python-sdk 0.26.0__tar.gz → 0.26.1__tar.gz

{unified_python_sdk-0.26.0 → unified_python_sdk-0.26.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: Unified-python-sdk
-Version: 0.26.0
+Version: 0.26.1
 Summary: Python Client SDK for Unified.to
 Home-page: https://github.com/unified-to/unified-python-sdk.git
 Author: Unified API Inc.
@@ -35,18 +35,19 @@ Unified.to API: One API to Rule Them All
 
 <!-- Start Table of Contents [toc] -->
 ## Table of Contents
+<!-- $toc-max-depth=2 -->
+  * [SDK Installation](https://github.com/unified-to/unified-python-sdk/blob/master/#sdk-installation)
+  * [IDE Support](https://github.com/unified-to/unified-python-sdk/blob/master/#ide-support)
+  * [SDK Example Usage](https://github.com/unified-to/unified-python-sdk/blob/master/#sdk-example-usage)
+  * [Available Resources and Operations](https://github.com/unified-to/unified-python-sdk/blob/master/#available-resources-and-operations)
+  * [File uploads](https://github.com/unified-to/unified-python-sdk/blob/master/#file-uploads)
+  * [Retries](https://github.com/unified-to/unified-python-sdk/blob/master/#retries)
+  * [Error Handling](https://github.com/unified-to/unified-python-sdk/blob/master/#error-handling)
+  * [Server Selection](https://github.com/unified-to/unified-python-sdk/blob/master/#server-selection)
+  * [Custom HTTP Client](https://github.com/unified-to/unified-python-sdk/blob/master/#custom-http-client)
+  * [Authentication](https://github.com/unified-to/unified-python-sdk/blob/master/#authentication)
+  * [Debugging](https://github.com/unified-to/unified-python-sdk/blob/master/#debugging)
 
-* [SDK Installation](https://github.com/unified-to/unified-python-sdk/blob/master/#sdk-installation)
-* [IDE Support](https://github.com/unified-to/unified-python-sdk/blob/master/#ide-support)
-* [SDK Example Usage](https://github.com/unified-to/unified-python-sdk/blob/master/#sdk-example-usage)
-* [Available Resources and Operations](https://github.com/unified-to/unified-python-sdk/blob/master/#available-resources-and-operations)
-* [File uploads](https://github.com/unified-to/unified-python-sdk/blob/master/#file-uploads)
-* [Retries](https://github.com/unified-to/unified-python-sdk/blob/master/#retries)
-* [Error Handling](https://github.com/unified-to/unified-python-sdk/blob/master/#error-handling)
-* [Server Selection](https://github.com/unified-to/unified-python-sdk/blob/master/#server-selection)
-* [Custom HTTP Client](https://github.com/unified-to/unified-python-sdk/blob/master/#custom-http-client)
-* [Authentication](https://github.com/unified-to/unified-python-sdk/blob/master/#authentication)
-* [Debugging](https://github.com/unified-to/unified-python-sdk/blob/master/#debugging)
 <!-- End Table of Contents [toc] -->
 
 <!-- Start SDK Installation [installation] -->
@@ -89,16 +90,20 @@ Generally, the SDK will work well with most IDEs out of the box. However, when u
 ```python
 # Synchronous Example
 from unified_python_sdk import UnifiedTo
+from unified_python_sdk.models import shared
 
-s = UnifiedTo()
-
-res = s.accounting.create_accounting_account(request={
-    "connection_id": "<value>",
-})
+with UnifiedTo(
+    security=shared.Security(
+        jwt="<YOUR_API_KEY_HERE>",
+    ),
+) as s:
+    res = s.accounting.create_accounting_account(request={
+        "connection_id": "<value>",
+    })
 
-if res.accounting_account is not None:
-    # handle response
-    pass
+    if res.accounting_account is not None:
+        # handle response
+        pass
 ```
 
 </br>
@@ -108,15 +113,21 @@ The same SDK client can also be used to make asychronous requests by importing a
 # Asynchronous Example
 import asyncio
 from unified_python_sdk import UnifiedTo
+from unified_python_sdk.models import shared
 
 async def main():
-    s = UnifiedTo()
-    res = await s.accounting.create_accounting_account_async(request={
-        "connection_id": "<value>",
-    })
-    if res.accounting_account is not None:
-        # handle response
-        pass
+    async with UnifiedTo(
+        security=shared.Security(
+            jwt="<YOUR_API_KEY_HERE>",
+        ),
+    ) as s:
+        res = await s.accounting.create_accounting_account_async(request={
+            "connection_id": "<value>",
+        })
+
+        if res.accounting_account is not None:
+            # handle response
+            pass
 
 asyncio.run(main())
 ```
@@ -1129,17 +1140,21 @@ Certain SDK methods accept file objects as part of a request body or multi-part
 
 ```python
 from unified_python_sdk import UnifiedTo
+from unified_python_sdk.models import shared
 
-s = UnifiedTo()
-
-res = s.passthrough.create_passthrough_raw(request={
-    "connection_id": "<value>",
-    "path": "/etc/periodic",
-})
+with UnifiedTo(
+    security=shared.Security(
+        jwt="<YOUR_API_KEY_HERE>",
+    ),
+) as s:
+    res = s.passthrough.create_passthrough_raw(request={
+        "connection_id": "<value>",
+        "path": "/etc/periodic",
+    })
 
-if res is not None:
-    # handle response
-    pass
+    if res is not None:
+        # handle response
+        pass
 
 ```
 <!-- End File uploads [file-upload] -->
@@ -1152,37 +1167,44 @@ Some of the endpoints in this SDK support retries. If you use the SDK without an
 To change the default retry strategy for a single API call, simply provide a `RetryConfig` object to the call:
 ```python
 from unified_python_sdk import UnifiedTo
+from unified_python_sdk.models import shared
 from unified_to.utils import BackoffStrategy, RetryConfig
 
-s = UnifiedTo()
-
-res = s.accounting.create_accounting_account(request={
-    "connection_id": "<value>",
-},
-    RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
+with UnifiedTo(
+    security=shared.Security(
+        jwt="<YOUR_API_KEY_HERE>",
+    ),
+) as s:
+    res = s.accounting.create_accounting_account(request={
+        "connection_id": "<value>",
+    },
+        RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
 
-if res.accounting_account is not None:
-    # handle response
-    pass
+    if res.accounting_account is not None:
+        # handle response
+        pass
 
 ```
 
 If you'd like to override the default retry strategy for all operations that support retries, you can use the `retry_config` optional parameter when initializing the SDK:
 ```python
 from unified_python_sdk import UnifiedTo
+from unified_python_sdk.models import shared
 from unified_to.utils import BackoffStrategy, RetryConfig
 
-s = UnifiedTo(
+with UnifiedTo(
     retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
-)
-
-res = s.accounting.create_accounting_account(request={
-    "connection_id": "<value>",
-})
+    security=shared.Security(
+        jwt="<YOUR_API_KEY_HERE>",
+    ),
+) as s:
+    res = s.accounting.create_accounting_account(request={
+        "connection_id": "<value>",
+    })
 
-if res.accounting_account is not None:
-    # handle response
-    pass
+    if res.accounting_account is not None:
+        # handle response
+        pass
 
 ```
 <!-- End Retries [retries] -->
@@ -1211,23 +1233,26 @@ When custom error responses are specified for an operation, the SDK may also rai
 
 ```python
 from unified_python_sdk import UnifiedTo
-from unified_python_sdk.models import errors
-
-s = UnifiedTo()
-
-res = None
-try:
-    res = s.accounting.create_accounting_account(request={
-        "connection_id": "<value>",
-    })
-
-    if res.accounting_account is not None:
-        # handle response
-        pass
+from unified_python_sdk.models import errors, shared
 
-except errors.SDKError as e:
-    # handle exception
-    raise(e)
+with UnifiedTo(
+    security=shared.Security(
+        jwt="<YOUR_API_KEY_HERE>",
+    ),
+) as s:
+    res = None
+    try:
+        res = s.accounting.create_accounting_account(request={
+            "connection_id": "<value>",
+        })
+
+        if res.accounting_account is not None:
+            # handle response
+            pass
+
+    except errors.SDKError as e:
+        # handle exception
+        raise(e)
 ```
 <!-- End Error Handling [errors] -->
 
@@ -1249,18 +1274,21 @@ You can override the default server globally by passing a server index to the `s
 
 ```python
 from unified_python_sdk import UnifiedTo
+from unified_python_sdk.models import shared
 
-s = UnifiedTo(
+with UnifiedTo(
     server_idx=1,
-)
-
-res = s.accounting.create_accounting_account(request={
-    "connection_id": "<value>",
-})
+    security=shared.Security(
+        jwt="<YOUR_API_KEY_HERE>",
+    ),
+) as s:
+    res = s.accounting.create_accounting_account(request={
+        "connection_id": "<value>",
+    })
 
-if res.accounting_account is not None:
-    # handle response
-    pass
+    if res.accounting_account is not None:
+        # handle response
+        pass
 
 ```
 
@@ -1269,18 +1297,21 @@ if res.accounting_account is not None:
 The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
 ```python
 from unified_python_sdk import UnifiedTo
+from unified_python_sdk.models import shared
 
-s = UnifiedTo(
+with UnifiedTo(
     server_url="https://api.unified.to",
-)
-
-res = s.accounting.create_accounting_account(request={
-    "connection_id": "<value>",
-})
+    security=shared.Security(
+        jwt="<YOUR_API_KEY_HERE>",
+    ),
+) as s:
+    res = s.accounting.create_accounting_account(request={
+        "connection_id": "<value>",
+    })
 
-if res.accounting_account is not None:
-    # handle response
-    pass
+    if res.accounting_account is not None:
+        # handle response
+        pass
 
 ```
 <!-- End Server Selection [server] -->
@@ -1386,19 +1417,18 @@ You can set the security parameters through the `security` optional parameter wh
 from unified_python_sdk import UnifiedTo
 from unified_python_sdk.models import shared
 
-s = UnifiedTo(
+with UnifiedTo(
     security=shared.Security(
         jwt="<YOUR_API_KEY_HERE>",
     ),
-)
-
-res = s.accounting.create_accounting_account(request={
-    "connection_id": "<value>",
-})
+) as s:
+    res = s.accounting.create_accounting_account(request={
+        "connection_id": "<value>",
+    })
 
-if res.accounting_account is not None:
-    # handle response
-    pass
+    if res.accounting_account is not None:
+        # handle response
+        pass
 
 ```
 <!-- End Authentication [security] -->

{unified_python_sdk-0.26.0 → unified_python_sdk-0.26.1}/README-PYPI.md

@@ -12,18 +12,19 @@ Unified.to API: One API to Rule Them All
 
 <!-- Start Table of Contents [toc] -->
 ## Table of Contents
+<!-- $toc-max-depth=2 -->
+  * [SDK Installation](https://github.com/unified-to/unified-python-sdk/blob/master/#sdk-installation)
+  * [IDE Support](https://github.com/unified-to/unified-python-sdk/blob/master/#ide-support)
+  * [SDK Example Usage](https://github.com/unified-to/unified-python-sdk/blob/master/#sdk-example-usage)
+  * [Available Resources and Operations](https://github.com/unified-to/unified-python-sdk/blob/master/#available-resources-and-operations)
+  * [File uploads](https://github.com/unified-to/unified-python-sdk/blob/master/#file-uploads)
+  * [Retries](https://github.com/unified-to/unified-python-sdk/blob/master/#retries)
+  * [Error Handling](https://github.com/unified-to/unified-python-sdk/blob/master/#error-handling)
+  * [Server Selection](https://github.com/unified-to/unified-python-sdk/blob/master/#server-selection)
+  * [Custom HTTP Client](https://github.com/unified-to/unified-python-sdk/blob/master/#custom-http-client)
+  * [Authentication](https://github.com/unified-to/unified-python-sdk/blob/master/#authentication)
+  * [Debugging](https://github.com/unified-to/unified-python-sdk/blob/master/#debugging)
 
-* [SDK Installation](https://github.com/unified-to/unified-python-sdk/blob/master/#sdk-installation)
-* [IDE Support](https://github.com/unified-to/unified-python-sdk/blob/master/#ide-support)
-* [SDK Example Usage](https://github.com/unified-to/unified-python-sdk/blob/master/#sdk-example-usage)
-* [Available Resources and Operations](https://github.com/unified-to/unified-python-sdk/blob/master/#available-resources-and-operations)
-* [File uploads](https://github.com/unified-to/unified-python-sdk/blob/master/#file-uploads)
-* [Retries](https://github.com/unified-to/unified-python-sdk/blob/master/#retries)
-* [Error Handling](https://github.com/unified-to/unified-python-sdk/blob/master/#error-handling)
-* [Server Selection](https://github.com/unified-to/unified-python-sdk/blob/master/#server-selection)
-* [Custom HTTP Client](https://github.com/unified-to/unified-python-sdk/blob/master/#custom-http-client)
-* [Authentication](https://github.com/unified-to/unified-python-sdk/blob/master/#authentication)
-* [Debugging](https://github.com/unified-to/unified-python-sdk/blob/master/#debugging)
 <!-- End Table of Contents [toc] -->
 
 <!-- Start SDK Installation [installation] -->
@@ -66,16 +67,20 @@ Generally, the SDK will work well with most IDEs out of the box. However, when u
 ```python
 # Synchronous Example
 from unified_python_sdk import UnifiedTo
+from unified_python_sdk.models import shared
 
-s = UnifiedTo()
-
-res = s.accounting.create_accounting_account(request={
-    "connection_id": "<value>",
-})
+with UnifiedTo(
+    security=shared.Security(
+        jwt="<YOUR_API_KEY_HERE>",
+    ),
+) as s:
+    res = s.accounting.create_accounting_account(request={
+        "connection_id": "<value>",
+    })
 
-if res.accounting_account is not None:
-    # handle response
-    pass
+    if res.accounting_account is not None:
+        # handle response
+        pass
 ```
 
 </br>
@@ -85,15 +90,21 @@ The same SDK client can also be used to make asychronous requests by importing a
 # Asynchronous Example
 import asyncio
 from unified_python_sdk import UnifiedTo
+from unified_python_sdk.models import shared
 
 async def main():
-    s = UnifiedTo()
-    res = await s.accounting.create_accounting_account_async(request={
-        "connection_id": "<value>",
-    })
-    if res.accounting_account is not None:
-        # handle response
-        pass
+    async with UnifiedTo(
+        security=shared.Security(
+            jwt="<YOUR_API_KEY_HERE>",
+        ),
+    ) as s:
+        res = await s.accounting.create_accounting_account_async(request={
+            "connection_id": "<value>",
+        })
+
+        if res.accounting_account is not None:
+            # handle response
+            pass
 
 asyncio.run(main())
 ```
@@ -1106,17 +1117,21 @@ Certain SDK methods accept file objects as part of a request body or multi-part
 
 ```python
 from unified_python_sdk import UnifiedTo
+from unified_python_sdk.models import shared
 
-s = UnifiedTo()
-
-res = s.passthrough.create_passthrough_raw(request={
-    "connection_id": "<value>",
-    "path": "/etc/periodic",
-})
+with UnifiedTo(
+    security=shared.Security(
+        jwt="<YOUR_API_KEY_HERE>",
+    ),
+) as s:
+    res = s.passthrough.create_passthrough_raw(request={
+        "connection_id": "<value>",
+        "path": "/etc/periodic",
+    })
 
-if res is not None:
-    # handle response
-    pass
+    if res is not None:
+        # handle response
+        pass
 
 ```
 <!-- End File uploads [file-upload] -->
@@ -1129,37 +1144,44 @@ Some of the endpoints in this SDK support retries. If you use the SDK without an
 To change the default retry strategy for a single API call, simply provide a `RetryConfig` object to the call:
 ```python
 from unified_python_sdk import UnifiedTo
+from unified_python_sdk.models import shared
 from unified_to.utils import BackoffStrategy, RetryConfig
 
-s = UnifiedTo()
-
-res = s.accounting.create_accounting_account(request={
-    "connection_id": "<value>",
-},
-    RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
+with UnifiedTo(
+    security=shared.Security(
+        jwt="<YOUR_API_KEY_HERE>",
+    ),
+) as s:
+    res = s.accounting.create_accounting_account(request={
+        "connection_id": "<value>",
+    },
+        RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
 
-if res.accounting_account is not None:
-    # handle response
-    pass
+    if res.accounting_account is not None:
+        # handle response
+        pass
 
 ```
 
 If you'd like to override the default retry strategy for all operations that support retries, you can use the `retry_config` optional parameter when initializing the SDK:
 ```python
 from unified_python_sdk import UnifiedTo
+from unified_python_sdk.models import shared
 from unified_to.utils import BackoffStrategy, RetryConfig
 
-s = UnifiedTo(
+with UnifiedTo(
     retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
-)
-
-res = s.accounting.create_accounting_account(request={
-    "connection_id": "<value>",
-})
+    security=shared.Security(
+        jwt="<YOUR_API_KEY_HERE>",
+    ),
+) as s:
+    res = s.accounting.create_accounting_account(request={
+        "connection_id": "<value>",
+    })
 
-if res.accounting_account is not None:
-    # handle response
-    pass
+    if res.accounting_account is not None:
+        # handle response
+        pass
 
 ```
 <!-- End Retries [retries] -->
@@ -1188,23 +1210,26 @@ When custom error responses are specified for an operation, the SDK may also rai
 
 ```python
 from unified_python_sdk import UnifiedTo
-from unified_python_sdk.models import errors
-
-s = UnifiedTo()
-
-res = None
-try:
-    res = s.accounting.create_accounting_account(request={
-        "connection_id": "<value>",
-    })
-
-    if res.accounting_account is not None:
-        # handle response
-        pass
+from unified_python_sdk.models import errors, shared
 
-except errors.SDKError as e:
-    # handle exception
-    raise(e)
+with UnifiedTo(
+    security=shared.Security(
+        jwt="<YOUR_API_KEY_HERE>",
+    ),
+) as s:
+    res = None
+    try:
+        res = s.accounting.create_accounting_account(request={
+            "connection_id": "<value>",
+        })
+
+        if res.accounting_account is not None:
+            # handle response
+            pass
+
+    except errors.SDKError as e:
+        # handle exception
+        raise(e)
 ```
 <!-- End Error Handling [errors] -->
 
@@ -1226,18 +1251,21 @@ You can override the default server globally by passing a server index to the `s
 
 ```python
 from unified_python_sdk import UnifiedTo
+from unified_python_sdk.models import shared
 
-s = UnifiedTo(
+with UnifiedTo(
     server_idx=1,
-)
-
-res = s.accounting.create_accounting_account(request={
-    "connection_id": "<value>",
-})
+    security=shared.Security(
+        jwt="<YOUR_API_KEY_HERE>",
+    ),
+) as s:
+    res = s.accounting.create_accounting_account(request={
+        "connection_id": "<value>",
+    })
 
-if res.accounting_account is not None:
-    # handle response
-    pass
+    if res.accounting_account is not None:
+        # handle response
+        pass
 
 ```
 
@@ -1246,18 +1274,21 @@ if res.accounting_account is not None:
 The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
 ```python
 from unified_python_sdk import UnifiedTo
+from unified_python_sdk.models import shared
 
-s = UnifiedTo(
+with UnifiedTo(
     server_url="https://api.unified.to",
-)
-
-res = s.accounting.create_accounting_account(request={
-    "connection_id": "<value>",
-})
+    security=shared.Security(
+        jwt="<YOUR_API_KEY_HERE>",
+    ),
+) as s:
+    res = s.accounting.create_accounting_account(request={
+        "connection_id": "<value>",
+    })
 
-if res.accounting_account is not None:
-    # handle response
-    pass
+    if res.accounting_account is not None:
+        # handle response
+        pass
 
 ```
 <!-- End Server Selection [server] -->
@@ -1363,19 +1394,18 @@ You can set the security parameters through the `security` optional parameter wh
 from unified_python_sdk import UnifiedTo
 from unified_python_sdk.models import shared
 
-s = UnifiedTo(
+with UnifiedTo(
     security=shared.Security(
         jwt="<YOUR_API_KEY_HERE>",
     ),
-)
-
-res = s.accounting.create_accounting_account(request={
-    "connection_id": "<value>",
-})
+) as s:
+    res = s.accounting.create_accounting_account(request={
+        "connection_id": "<value>",
+    })
 
-if res.accounting_account is not None:
-    # handle response
-    pass
+    if res.accounting_account is not None:
+        # handle response
+        pass
 
 ```
 <!-- End Authentication [security] -->

{unified_python_sdk-0.26.0 → unified_python_sdk-0.26.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "Unified-python-sdk"
-version = "0.26.0"
+version = "0.26.1"
 description = "Python Client SDK for Unified.to"
 authors = ["Unified API Inc.",]
 readme = "README-PYPI.md"
@@ -26,7 +26,7 @@ python-dateutil = "^2.8.2"
 typing-inspect = "^0.9.0"
 
 [tool.poetry.group.dev.dependencies]
-mypy = "==1.10.1"
+mypy = "==1.13.0"
 pylint = "==3.2.3"
 types-python-dateutil = "^2.9.0.20240316"
 

{unified_python_sdk-0.26.0 → unified_python_sdk-0.26.1}/src/unified_python_sdk/_version.py

@@ -3,7 +3,7 @@
 import importlib.metadata
 
 __title__: str = "Unified-python-sdk"
-__version__: str = "0.26.0"
+__version__: str = "0.26.1"
 
 try:
     if __package__ is not None:

{unified_python_sdk-0.26.0 → unified_python_sdk-0.26.1}/src/unified_python_sdk/httpclient.py

@@ -41,6 +41,9 @@ class HttpClient(Protocol):
     ) -> httpx.Request:
         pass
 
+    def close(self) -> None:
+        pass
+
 
 @runtime_checkable
 class AsyncHttpClient(Protocol):
@@ -76,3 +79,6 @@ class AsyncHttpClient(Protocol):
         extensions: Optional[httpx._types.RequestExtensions] = None,
     ) -> httpx.Request:
         pass
+
+    async def aclose(self) -> None:
+        pass