worqhat 3.1.0__tar.gz → 3.4.0__tar.gz

worqhat-3.4.0/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "3.4.0"
+}

{worqhat-3.1.0 → worqhat-3.4.0}/CHANGELOG.md

@@ -1,27 +1,14 @@
 # Changelog
 
-## 3.1.0 (2025-07-24)
+## 3.4.0 (2025-07-31)
 
-Full Changelog: [v3.1.0-alpha.3...v3.1.0](https://github.com/WorqHat/worqhat-python-sdk/compare/v3.1.0-alpha.3...v3.1.0)
-
-## 3.1.0-alpha.3 (2025-07-24)
-
-Full Changelog: [v3.1.0-alpha.2...v3.1.0-alpha.3](https://github.com/WorqHat/worqhat-python-sdk/compare/v3.1.0-alpha.2...v3.1.0-alpha.3)
-
-## 3.1.0-alpha.2 (2025-07-24)
-
-Full Changelog: [v3.1.0-alpha.1...v3.1.0-alpha.2](https://github.com/WorqHat/worqhat-python-sdk/compare/v3.1.0-alpha.1...v3.1.0-alpha.2)
+Full Changelog: [v0.0.1-alpha.0...v3.4.0](https://github.com/WorqHat/worqhat-python-sdk/compare/v0.0.1-alpha.0...v3.4.0)
 
 ### Features
 
+* **api:** update via SDK Studio ([ce75dcc](https://github.com/WorqHat/worqhat-python-sdk/commit/ce75dcc31b078bab025560c5b196a4eecf7f1227))
+* **api:** update via SDK Studio ([ec19825](https://github.com/WorqHat/worqhat-python-sdk/commit/ec19825709fbe7994a811981d5eb77630a0594ce))
 * **api:** update via SDK Studio ([85ab7a2](https://github.com/WorqHat/worqhat-python-sdk/commit/85ab7a2e5c871ed5921ef6044c0f9926b939948d))
-
-## 3.1.0-alpha.1 (2025-07-24)
-
-Full Changelog: [v0.0.1-alpha.0...v3.1.0-alpha.1](https://github.com/WorqHat/worqhat-python-sdk/compare/v0.0.1-alpha.0...v3.1.0-alpha.1)
-
-### Features
-
 * **api:** update via SDK Studio ([1dca18a](https://github.com/WorqHat/worqhat-python-sdk/commit/1dca18acf452a7cc35c6e541d69b8a31ac90d29a))
 * **api:** update via SDK Studio ([fbb6ab5](https://github.com/WorqHat/worqhat-python-sdk/commit/fbb6ab5d66c30d8ee3bd9328eab85304efd42614))
 
@@ -29,7 +16,13 @@ Full Changelog: [v0.0.1-alpha.0...v3.1.0-alpha.1](https://github.com/WorqHat/wor
 ### Chores
 
 * configure new SDK language ([c4d0258](https://github.com/WorqHat/worqhat-python-sdk/commit/c4d0258ea522088e0f6181228d1f04a64230b2d7))
+* sync repo ([b2b1c38](https://github.com/WorqHat/worqhat-python-sdk/commit/b2b1c381aa08870a807c303164f6ff9689f8aea2))
 * sync repo ([4766968](https://github.com/WorqHat/worqhat-python-sdk/commit/476696875aa8f142f588c4f016fa8110a0ec4e08))
+* update SDK settings ([8d58885](https://github.com/WorqHat/worqhat-python-sdk/commit/8d5888563b3042cb684d9a4406a09edd2be22889))
+* update SDK settings ([a1ff3c3](https://github.com/WorqHat/worqhat-python-sdk/commit/a1ff3c388307c293932c8ef069ae9ad3a03c393c))
+* update SDK settings ([53e95ac](https://github.com/WorqHat/worqhat-python-sdk/commit/53e95acd14d9d4dd063c1c71a1ed0bcd9ab86e69))
+* update SDK settings ([f5a73c5](https://github.com/WorqHat/worqhat-python-sdk/commit/f5a73c54db1e7d7d865701c79b13034a08ef5341))
+* update SDK settings ([9ff0620](https://github.com/WorqHat/worqhat-python-sdk/commit/9ff062000f153819b5629a262395551a723b2382))
 * update SDK settings ([d605766](https://github.com/WorqHat/worqhat-python-sdk/commit/d605766da0d10451b716cbf715c96e6b4ccf90b9))
 * update SDK settings ([29497ca](https://github.com/WorqHat/worqhat-python-sdk/commit/29497ca3d7fc8232a9b0cc0fb70cb963c4624b33))
 * update SDK settings ([e386fb8](https://github.com/WorqHat/worqhat-python-sdk/commit/e386fb86761c1ef06bd99b5a85b2fd6710d17737))

{worqhat-3.1.0 → worqhat-3.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: worqhat
-Version: 3.1.0
+Version: 3.4.0
 Summary: The official Python library for the worqhat API
 Project-URL: Homepage, https://github.com/WorqHat/worqhat-python-sdk
 Project-URL: Repository, https://github.com/WorqHat/worqhat-python-sdk
@@ -46,7 +46,7 @@ It is generated with [Stainless](https://www.stainless.com/).
 
 ## Documentation
 
-The REST API documentation can be found on [docs.worqhat.com](https://docs.worqhat.com). The full API of this library can be found in [api.md](https://github.com/WorqHat/worqhat-python-sdk/tree/main/api.md).
+The REST API documentation can be found on [worqhat.com](https://worqhat.com/support). The full API of this library can be found in [api.md](https://github.com/WorqHat/worqhat-python-sdk/tree/main/api.md).
 
 ## Installation
 
@@ -67,8 +67,10 @@ client = Worqhat(
     api_key=os.environ.get("WORQHAT_API_KEY"),  # This is the default and can be omitted
 )
 
-response = client.retrieve_server_info()
-print(response.environment)
+response = client.db.execute_query(
+    query="REPLACE_ME",
+)
+print(response.data)
 ```
 
 While you can provide an `api_key` keyword argument,
@@ -91,8 +93,10 @@ client = AsyncWorqhat(
 
 
 async def main() -> None:
-    response = await client.retrieve_server_info()
-    print(response.environment)
+    response = await client.db.execute_query(
+        query="REPLACE_ME",
+    )
+    print(response.data)
 
 
 asyncio.run(main())
@@ -124,8 +128,10 @@ async def main() -> None:
         api_key="My API Key",
         http_client=DefaultAioHttpClient(),
     ) as client:
-        response = await client.retrieve_server_info()
-        print(response.environment)
+        response = await client.db.execute_query(
+            query="REPLACE_ME",
+        )
+        print(response.data)
 
 
 asyncio.run(main())
@@ -140,6 +146,24 @@ Nested request parameters are [TypedDicts](https://docs.python.org/3/library/typ
 
 Typed requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set `python.analysis.typeCheckingMode` to `basic`.
 
+## File uploads
+
+Request parameters that correspond to file uploads can be passed as `bytes`, or a [`PathLike`](https://docs.python.org/3/library/os.html#os.PathLike) instance or a tuple of `(filename, contents, media type)`.
+
+```python
+from pathlib import Path
+from worqhat import Worqhat
+
+client = Worqhat()
+
+client.flows.trigger_with_file(
+    flow_id="f825ab82-371f-40cb-9bed-b325531ead4a",
+    file=Path("/path/to/file"),
+)
+```
+
+The async client uses the exact same interface. If you pass a [`PathLike`](https://docs.python.org/3/library/os.html#os.PathLike) instance, the file contents will be read asynchronously automatically.
+
 ## Handling errors
 
 When the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `worqhat.APIConnectionError` is raised.
@@ -156,7 +180,9 @@ from worqhat import Worqhat
 client = Worqhat()
 
 try:
-    client.retrieve_server_info()
+    client.db.execute_query(
+        query="REPLACE_ME",
+    )
 except worqhat.APIConnectionError as e:
     print("The server could not be reached")
     print(e.__cause__)  # an underlying Exception, likely raised within httpx.
@@ -199,7 +225,9 @@ client = Worqhat(
 )
 
 # Or, configure per-request:
-client.with_options(max_retries=5).retrieve_server_info()
+client.with_options(max_retries=5).db.execute_query(
+    query="REPLACE_ME",
+)
 ```
 
 ### Timeouts
@@ -222,7 +250,9 @@ client = Worqhat(
 )
 
 # Override per-request:
-client.with_options(timeout=5.0).retrieve_server_info()
+client.with_options(timeout=5.0).db.execute_query(
+    query="REPLACE_ME",
+)
 ```
 
 On timeout, an `APITimeoutError` is thrown.
@@ -263,11 +293,13 @@ The "raw" Response object can be accessed by prefixing `.with_raw_response.` to
 from worqhat import Worqhat
 
 client = Worqhat()
-response = client.with_raw_response.retrieve_server_info()
+response = client.db.with_raw_response.execute_query(
+    query="REPLACE_ME",
+)
 print(response.headers.get('X-My-Header'))
 
-client = response.parse()  # get the object that `retrieve_server_info()` would have returned
-print(client.environment)
+db = response.parse()  # get the object that `db.execute_query()` would have returned
+print(db.data)
 ```
 
 These methods return an [`APIResponse`](https://github.com/WorqHat/worqhat-python-sdk/tree/main/src/worqhat/_response.py) object.
@@ -281,7 +313,9 @@ The above interface eagerly reads the full response body when you make the reque
 To stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.
 
 ```python
-with client.with_streaming_response.retrieve_server_info() as response:
+with client.db.with_streaming_response.execute_query(
+    query="REPLACE_ME",
+) as response:
     print(response.headers.get("X-My-Header"))
 
     for line in response.iter_lines():

{worqhat-3.1.0 → worqhat-3.4.0}/README.md

@@ -11,7 +11,7 @@ It is generated with [Stainless](https://www.stainless.com/).
 
 ## Documentation
 
-The REST API documentation can be found on [docs.worqhat.com](https://docs.worqhat.com). The full API of this library can be found in [api.md](api.md).
+The REST API documentation can be found on [worqhat.com](https://worqhat.com/support). The full API of this library can be found in [api.md](api.md).
 
 ## Installation
 
@@ -32,8 +32,10 @@ client = Worqhat(
     api_key=os.environ.get("WORQHAT_API_KEY"),  # This is the default and can be omitted
 )
 
-response = client.retrieve_server_info()
-print(response.environment)
+response = client.db.execute_query(
+    query="REPLACE_ME",
+)
+print(response.data)
 ```
 
 While you can provide an `api_key` keyword argument,
@@ -56,8 +58,10 @@ client = AsyncWorqhat(
 
 
 async def main() -> None:
-    response = await client.retrieve_server_info()
-    print(response.environment)
+    response = await client.db.execute_query(
+        query="REPLACE_ME",
+    )
+    print(response.data)
 
 
 asyncio.run(main())
@@ -89,8 +93,10 @@ async def main() -> None:
         api_key="My API Key",
         http_client=DefaultAioHttpClient(),
     ) as client:
-        response = await client.retrieve_server_info()
-        print(response.environment)
+        response = await client.db.execute_query(
+            query="REPLACE_ME",
+        )
+        print(response.data)
 
 
 asyncio.run(main())
@@ -105,6 +111,24 @@ Nested request parameters are [TypedDicts](https://docs.python.org/3/library/typ
 
 Typed requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set `python.analysis.typeCheckingMode` to `basic`.
 
+## File uploads
+
+Request parameters that correspond to file uploads can be passed as `bytes`, or a [`PathLike`](https://docs.python.org/3/library/os.html#os.PathLike) instance or a tuple of `(filename, contents, media type)`.
+
+```python
+from pathlib import Path
+from worqhat import Worqhat
+
+client = Worqhat()
+
+client.flows.trigger_with_file(
+    flow_id="f825ab82-371f-40cb-9bed-b325531ead4a",
+    file=Path("/path/to/file"),
+)
+```
+
+The async client uses the exact same interface. If you pass a [`PathLike`](https://docs.python.org/3/library/os.html#os.PathLike) instance, the file contents will be read asynchronously automatically.
+
 ## Handling errors
 
 When the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `worqhat.APIConnectionError` is raised.
@@ -121,7 +145,9 @@ from worqhat import Worqhat
 client = Worqhat()
 
 try:
-    client.retrieve_server_info()
+    client.db.execute_query(
+        query="REPLACE_ME",
+    )
 except worqhat.APIConnectionError as e:
     print("The server could not be reached")
     print(e.__cause__)  # an underlying Exception, likely raised within httpx.
@@ -164,7 +190,9 @@ client = Worqhat(
 )
 
 # Or, configure per-request:
-client.with_options(max_retries=5).retrieve_server_info()
+client.with_options(max_retries=5).db.execute_query(
+    query="REPLACE_ME",
+)
 ```
 
 ### Timeouts
@@ -187,7 +215,9 @@ client = Worqhat(
 )
 
 # Override per-request:
-client.with_options(timeout=5.0).retrieve_server_info()
+client.with_options(timeout=5.0).db.execute_query(
+    query="REPLACE_ME",
+)
 ```
 
 On timeout, an `APITimeoutError` is thrown.
@@ -228,11 +258,13 @@ The "raw" Response object can be accessed by prefixing `.with_raw_response.` to
 from worqhat import Worqhat
 
 client = Worqhat()
-response = client.with_raw_response.retrieve_server_info()
+response = client.db.with_raw_response.execute_query(
+    query="REPLACE_ME",
+)
 print(response.headers.get('X-My-Header'))
 
-client = response.parse()  # get the object that `retrieve_server_info()` would have returned
-print(client.environment)
+db = response.parse()  # get the object that `db.execute_query()` would have returned
+print(db.data)
 ```
 
 These methods return an [`APIResponse`](https://github.com/WorqHat/worqhat-python-sdk/tree/main/src/worqhat/_response.py) object.
@@ -246,7 +278,9 @@ The above interface eagerly reads the full response body when you make the reque
 To stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.
 
 ```python
-with client.with_streaming_response.retrieve_server_info() as response:
+with client.db.with_streaming_response.execute_query(
+    query="REPLACE_ME",
+) as response:
     print(response.headers.get("X-My-Header"))
 
     for line in response.iter_lines():

worqhat-3.4.0/api.md

@@ -0,0 +1,63 @@
+# Worqhat
+
+Types:
+
+```python
+from worqhat.types import GetServerInfoResponse
+```
+
+Methods:
+
+- <code title="get /">client.<a href="./src/worqhat/_client.py">get_server_info</a>() -> <a href="./src/worqhat/types/get_server_info_response.py">GetServerInfoResponse</a></code>
+
+# DB
+
+Types:
+
+```python
+from worqhat.types import (
+    DBDeleteRecordsResponse,
+    DBExecuteQueryResponse,
+    DBInsertRecordResponse,
+    DBProcessNlQueryResponse,
+    DBUpdateRecordsResponse,
+)
+```
+
+Methods:
+
+- <code title="delete /db/delete">client.db.<a href="./src/worqhat/resources/db.py">delete_records</a>(\*\*<a href="src/worqhat/types/db_delete_records_params.py">params</a>) -> <a href="./src/worqhat/types/db_delete_records_response.py">DBDeleteRecordsResponse</a></code>
+- <code title="post /db/query">client.db.<a href="./src/worqhat/resources/db.py">execute_query</a>(\*\*<a href="src/worqhat/types/db_execute_query_params.py">params</a>) -> <a href="./src/worqhat/types/db_execute_query_response.py">DBExecuteQueryResponse</a></code>
+- <code title="post /db/insert">client.db.<a href="./src/worqhat/resources/db.py">insert_record</a>(\*\*<a href="src/worqhat/types/db_insert_record_params.py">params</a>) -> <a href="./src/worqhat/types/db_insert_record_response.py">DBInsertRecordResponse</a></code>
+- <code title="post /db/nl-query">client.db.<a href="./src/worqhat/resources/db.py">process_nl_query</a>(\*\*<a href="src/worqhat/types/db_process_nl_query_params.py">params</a>) -> <a href="./src/worqhat/types/db_process_nl_query_response.py">DBProcessNlQueryResponse</a></code>
+- <code title="put /db/update">client.db.<a href="./src/worqhat/resources/db.py">update_records</a>(\*\*<a href="src/worqhat/types/db_update_records_params.py">params</a>) -> <a href="./src/worqhat/types/db_update_records_response.py">DBUpdateRecordsResponse</a></code>
+
+# Health
+
+Types:
+
+```python
+from worqhat.types import HealthCheckResponse
+```
+
+Methods:
+
+- <code title="get /health">client.health.<a href="./src/worqhat/resources/health.py">check</a>() -> <a href="./src/worqhat/types/health_check_response.py">HealthCheckResponse</a></code>
+
+# Flows
+
+Types:
+
+```python
+from worqhat.types import (
+    FlowGetMetricsResponse,
+    FlowTriggerWithFileResponse,
+    FlowTriggerWithPayloadResponse,
+)
+```
+
+Methods:
+
+- <code title="get /flows/metrics">client.flows.<a href="./src/worqhat/resources/flows.py">get_metrics</a>(\*\*<a href="src/worqhat/types/flow_get_metrics_params.py">params</a>) -> <a href="./src/worqhat/types/flow_get_metrics_response.py">FlowGetMetricsResponse</a></code>
+- <code title="post /flows/file/{flowId}">client.flows.<a href="./src/worqhat/resources/flows.py">trigger_with_file</a>(flow_id, \*\*<a href="src/worqhat/types/flow_trigger_with_file_params.py">params</a>) -> <a href="./src/worqhat/types/flow_trigger_with_file_response.py">FlowTriggerWithFileResponse</a></code>
+- <code title="post /flows/trigger/{flowId}">client.flows.<a href="./src/worqhat/resources/flows.py">trigger_with_payload</a>(flow_id, \*\*<a href="src/worqhat/types/flow_trigger_with_payload_params.py">params</a>) -> <a href="./src/worqhat/types/flow_trigger_with_payload_response.py">FlowTriggerWithPayloadResponse</a></code>

worqhat-3.4.0/bin/publish-pypi

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+set -eux
+mkdir -p dist
+rye build --clean
+rye publish --yes --token=$PYPI_TOKEN

{worqhat-3.1.0 → worqhat-3.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "worqhat"
-version = "3.1.0"
+version = "3.4.0"
 description = "The official Python library for the worqhat API"
 dynamic = ["readme"]
 license = "Apache-2.0"

worqhat-3.4.0/requirements-dev.lock

@@ -0,0 +1,135 @@
+# generated by rye
+# use `rye lock` or `rye sync` to update this lockfile
+#
+# last locked with the following flags:
+#   pre: false
+#   features: []
+#   all-features: true
+#   with-sources: false
+#   generate-hashes: false
+#   universal: false
+
+-e file:.
+aiohappyeyeballs==2.6.1
+    # via aiohttp
+aiohttp==3.12.8
+    # via httpx-aiohttp
+    # via worqhat
+aiosignal==1.3.2
+    # via aiohttp
+annotated-types==0.6.0
+    # via pydantic
+anyio==4.4.0
+    # via httpx
+    # via worqhat
+argcomplete==3.1.2
+    # via nox
+async-timeout==5.0.1
+    # via aiohttp
+attrs==25.3.0
+    # via aiohttp
+certifi==2023.7.22
+    # via httpcore
+    # via httpx
+colorlog==6.7.0
+    # via nox
+dirty-equals==0.6.0
+distlib==0.3.7
+    # via virtualenv
+distro==1.8.0
+    # via worqhat
+exceptiongroup==1.2.2
+    # via anyio
+    # via pytest
+execnet==2.1.1
+    # via pytest-xdist
+filelock==3.12.4
+    # via virtualenv
+frozenlist==1.6.2
+    # via aiohttp
+    # via aiosignal
+h11==0.16.0
+    # via httpcore
+httpcore==1.0.9
+    # via httpx
+httpx==0.28.1
+    # via httpx-aiohttp
+    # via respx
+    # via worqhat
+httpx-aiohttp==0.1.8
+    # via worqhat
+idna==3.4
+    # via anyio
+    # via httpx
+    # via yarl
+importlib-metadata==7.0.0
+iniconfig==2.0.0
+    # via pytest
+markdown-it-py==3.0.0
+    # via rich
+mdurl==0.1.2
+    # via markdown-it-py
+multidict==6.4.4
+    # via aiohttp
+    # via yarl
+mypy==1.14.1
+mypy-extensions==1.0.0
+    # via mypy
+nest-asyncio==1.6.0
+nodeenv==1.8.0
+    # via pyright
+nox==2023.4.22
+packaging==23.2
+    # via nox
+    # via pytest
+platformdirs==3.11.0
+    # via virtualenv
+pluggy==1.5.0
+    # via pytest
+propcache==0.3.1
+    # via aiohttp
+    # via yarl
+pydantic==2.10.3
+    # via worqhat
+pydantic-core==2.27.1
+    # via pydantic
+pygments==2.18.0
+    # via rich
+pyright==1.1.399
+pytest==8.3.3
+    # via pytest-asyncio
+    # via pytest-xdist
+pytest-asyncio==0.24.0
+pytest-xdist==3.7.0
+python-dateutil==2.8.2
+    # via time-machine
+pytz==2023.3.post1
+    # via dirty-equals
+respx==0.22.0
+rich==13.7.1
+ruff==0.9.4
+setuptools==68.2.2
+    # via nodeenv
+six==1.16.0
+    # via python-dateutil
+sniffio==1.3.0
+    # via anyio
+    # via worqhat
+time-machine==2.9.0
+tomli==2.0.2
+    # via mypy
+    # via pytest
+typing-extensions==4.12.2
+    # via anyio
+    # via multidict
+    # via mypy
+    # via pydantic
+    # via pydantic-core
+    # via pyright
+    # via worqhat
+virtualenv==20.24.5
+    # via nox
+yarl==1.20.0
+    # via aiohttp
+zipp==3.17.0
+    # via importlib-metadata

{worqhat-3.1.0 → worqhat-3.4.0}/src/worqhat/_base_client.py

@@ -532,7 +532,10 @@ class BaseClient(Generic[_HttpxClientT, _DefaultStreamT]):
         is_body_allowed = options.method.lower() != "get"
 
         if is_body_allowed:
-            kwargs["json"] = json_data if is_given(json_data) else None
+            if isinstance(json_data, bytes):
+                kwargs["content"] = json_data
+            else:
+                kwargs["json"] = json_data if is_given(json_data) else None
             kwargs["files"] = files
         else:
             headers.pop("Content-Type", None)