worqhat 3.1.0__py3-none-any.whl → 3.4.0__py3-none-any.whl

{worqhat-3.1.0.dist-info → worqhat-3.4.0.dist-info}/METADATA

@@ -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.4.0.dist-info/RECORD

@@ -0,0 +1,53 @@
+worqhat/__init__.py,sha256=NXlcxKw_bHh9zK2KgmvBdq24kz1g8XpXEGEZTEzOqjk,2587
+worqhat/_base_client.py,sha256=1daYytjl3Svekdj0cxAW5DtghyOupUBvEp6gllE6avk,67036
+worqhat/_client.py,sha256=b3PFx-cxWshWXpjJKXQh0Qv0QjTDnlc8m4fV339NI9Q,18182
+worqhat/_compat.py,sha256=VWemUKbj6DDkQ-O4baSpHVLJafotzeXmCQGJugfVTIw,6580
+worqhat/_constants.py,sha256=S14PFzyN9-I31wiV7SmIlL5Ga0MLHxdvegInGdXH7tM,462
+worqhat/_exceptions.py,sha256=n2QtRwhErTAw2JJQ8Vt95ZlTeJvve2qXF8B1Z6M_7Ao,3222
+worqhat/_files.py,sha256=Bmgx2fwiLeMSXBhC1tUenHcA1jqisBYZ5vPx9JwCc_w,3618
+worqhat/_models.py,sha256=KvjsMfb88XZlFUKVoOxr8OyDj47MhoH2OKqWNEbBhk4,30010
+worqhat/_qs.py,sha256=AOkSz4rHtK4YI3ZU_kzea-zpwBUgEY8WniGmTPyEimc,4846
+worqhat/_resource.py,sha256=2r0Ilj0AtogNG1TdsG6biEPWD5Ihgf1hOE51PwMEpyQ,1106
+worqhat/_response.py,sha256=NBeCvMH3I_Zr6-Gp_8aE-S7TtNphvnw_gTlK53-lew0,28794
+worqhat/_streaming.py,sha256=h3n2sOPN_iuD2DUno9BKZt0wT_F7GRZHcotRI5yuI0s,10104
+worqhat/_types.py,sha256=RLnhzVhf9Dvl-6kTVf8TKfUOc0O9QR6J1A0se5vLcXA,6198
+worqhat/_version.py,sha256=_5R1spKfllfAFZxnCBu1Bv5yeujmQhQsTQdCOLIOgBI,159
+worqhat/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+worqhat/_utils/__init__.py,sha256=PNZ_QJuzZEgyYXqkO1HVhGkj5IU9bglVUcw7H-Knjzw,2062
+worqhat/_utils/_logs.py,sha256=cb3jsbICK0cXrlqMRi4y96MiJuqk5_rQy3ujWtoZTJU,777
+worqhat/_utils/_proxy.py,sha256=aglnj2yBTDyGX9Akk2crZHrl10oqRmceUy2Zp008XEs,1975
+worqhat/_utils/_reflection.py,sha256=ZmGkIgT_PuwedyNBrrKGbxoWtkpytJNU1uU4QHnmEMU,1364
+worqhat/_utils/_resources_proxy.py,sha256=KNhJsT2AQfFi4M_mmRtS0WAOH1Mq1ys8fLBhZfTKK-o,594
+worqhat/_utils/_streams.py,sha256=SMC90diFFecpEg_zgDRVbdR3hSEIgVVij4taD-noMLM,289
+worqhat/_utils/_sync.py,sha256=TpGLrrhRNWTJtODNE6Fup3_k7zrWm1j2RlirzBwre-0,2862
+worqhat/_utils/_transform.py,sha256=n7kskEWz6o__aoNvhFoGVyDoalNe6mJwp-g7BWkdj88,15617
+worqhat/_utils/_typing.py,sha256=D0DbbNu8GnYQTSICnTSHDGsYXj8TcAKyhejb0XcnjtY,4602
+worqhat/_utils/_utils.py,sha256=ts4CiiuNpFiGB6YMdkQRh2SZvYvsl7mAF-JWHCcLDf4,12312
+worqhat/lib/.keep,sha256=wuNrz-5SXo3jJaJOJgz4vFHM41YH_g20F5cRQo0vLes,224
+worqhat/resources/__init__.py,sha256=obTcrlI18jA4Pdccd9PQSXI7ZVOpjjEMY-oQJMrvcdY,1387
+worqhat/resources/db.py,sha256=OM-HoXMaW8GFWwKJ5GXXY-BkwZaHbToh47QGrNk5Tb4,21503
+worqhat/resources/flows.py,sha256=tHPctWECqV3oZGnHpF2mLESlJLXQSbWHpoONNC_U_A0,17514
+worqhat/resources/health.py,sha256=Pfe7CiktH5BezkPmbEZsLhGqnl9MmQkMbt6DUaIbWUw,5127
+worqhat/types/__init__.py,sha256=0eTtenEe0WsTWHV0JQ_AtxgpQqOKaAYxtwK6uRI38SA,1754
+worqhat/types/db_delete_records_params.py,sha256=-NMisgux-vKvC59wOcF6HqYIvq33yFJJwT7uX5iywNI,382
+worqhat/types/db_delete_records_response.py,sha256=zYQKUyewsmgDKY55CWywtO03EaMEO03Oc2JXDjRHtew,417
+worqhat/types/db_execute_query_params.py,sha256=6JYtxSiFIYRJkCqxf-WheiVdPHynqOBxLE1Jtj3pPJ4,319
+worqhat/types/db_execute_query_response.py,sha256=dd2ffeB-qkeTjXes6qtoLY_Z95-72AJ-KV5ZGc6Oq1s,549
+worqhat/types/db_insert_record_params.py,sha256=s31eu1ELw-WTmC-ekBYOlS69R31FezPdIPGrBgl1hTQ,377
+worqhat/types/db_insert_record_response.py,sha256=062aPrGmMzD63qbQS-jA2a6pRubzyEZSE_MgFqAkr9I,334
+worqhat/types/db_process_nl_query_params.py,sha256=w8ILeHhTuqmQEs2k3J_G5_DHG_KrAyxX6sQY0HDppMI,395
+worqhat/types/db_process_nl_query_response.py,sha256=sChHgVlQ9fzFDLwcycX2oZhkmpb-3wCm_YFXRvDLZQU,415
+worqhat/types/db_update_records_params.py,sha256=-bVb7Dw5zYV-Gmgqzv6M16Ky9fAdBaXvjZjbCr7GOWc,430
+worqhat/types/db_update_records_response.py,sha256=OLaAvsGA8wm_7XTg4GCXGjWgfpVfv5ufNp2gGG12gkI,417
+worqhat/types/flow_get_metrics_params.py,sha256=x4SgBnhjUDIabDVd3f3_wVGldHSLelUSSM_AoxpglTs,768
+worqhat/types/flow_get_metrics_response.py,sha256=xk4-y22nz_54QydhCRFYT-wONKaoSmjJSr-bT88r-b4,1287
+worqhat/types/flow_trigger_with_file_params.py,sha256=E5u-840gLHNpM5DIpx6is_usrMgSiEu_OXZuS6-7D_A,414
+worqhat/types/flow_trigger_with_file_response.py,sha256=xa3qZSBwa8eJddqlGJrwd9WO-hPw1k9NJr3Yrr2EUzk,433
+worqhat/types/flow_trigger_with_payload_params.py,sha256=ydt-UkcKgRk2JDS538_IH5afr_gZxUf9OXy-BgjFhoM,341
+worqhat/types/flow_trigger_with_payload_response.py,sha256=XT-6VEfTbpM3o098AATogw9s-X60gsd18b4T_xOiW60,479
+worqhat/types/get_server_info_response.py,sha256=Ev88Yr-DGVx00hluVKMnY4xq-VluFvcQ6z08XZTPcCE,332
+worqhat/types/health_check_response.py,sha256=29tvzgqsy6wVfFwVunK5ouzSYeZGEUnQQuQpAQGsoxI,885
+worqhat-3.4.0.dist-info/METADATA,sha256=rqEzeBo4J3PhSVABwIMAMc7iauL8NXFoh6LlbFsyyTs,14325
+worqhat-3.4.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+worqhat-3.4.0.dist-info/licenses/LICENSE,sha256=UwMftLIOitTJWtJ9bowByxdt9ZSFqmmb43oQosW5xiU,11337
+worqhat-3.4.0.dist-info/RECORD,,

worqhat-3.1.0.dist-info/RECORD

@@ -1,38 +0,0 @@
-worqhat/__init__.py,sha256=NXlcxKw_bHh9zK2KgmvBdq24kz1g8XpXEGEZTEzOqjk,2587
-worqhat/_base_client.py,sha256=tPQTKbWMDP3s0OiQuHMO3lAM5taEIz1rEOgbR_GTNoo,66923
-worqhat/_client.py,sha256=xymCNN1MgTbmNGgYGSBe3V8ZYuB47BlSDyZOF2vIO5U,17874
-worqhat/_compat.py,sha256=VWemUKbj6DDkQ-O4baSpHVLJafotzeXmCQGJugfVTIw,6580
-worqhat/_constants.py,sha256=S14PFzyN9-I31wiV7SmIlL5Ga0MLHxdvegInGdXH7tM,462
-worqhat/_exceptions.py,sha256=n2QtRwhErTAw2JJQ8Vt95ZlTeJvve2qXF8B1Z6M_7Ao,3222
-worqhat/_files.py,sha256=mf4dOgL4b0ryyZlbqLhggD3GVgDf6XxdGFAgce01ugE,3549
-worqhat/_models.py,sha256=KvjsMfb88XZlFUKVoOxr8OyDj47MhoH2OKqWNEbBhk4,30010
-worqhat/_qs.py,sha256=AOkSz4rHtK4YI3ZU_kzea-zpwBUgEY8WniGmTPyEimc,4846
-worqhat/_resource.py,sha256=2r0Ilj0AtogNG1TdsG6biEPWD5Ihgf1hOE51PwMEpyQ,1106
-worqhat/_response.py,sha256=NBeCvMH3I_Zr6-Gp_8aE-S7TtNphvnw_gTlK53-lew0,28794
-worqhat/_streaming.py,sha256=h3n2sOPN_iuD2DUno9BKZt0wT_F7GRZHcotRI5yuI0s,10104
-worqhat/_types.py,sha256=RLnhzVhf9Dvl-6kTVf8TKfUOc0O9QR6J1A0se5vLcXA,6198
-worqhat/_version.py,sha256=nf-tOoE6_ztTDueSgnXmjQR7o7uaeIrEjg0hii0srGA,159
-worqhat/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-worqhat/_utils/__init__.py,sha256=PNZ_QJuzZEgyYXqkO1HVhGkj5IU9bglVUcw7H-Knjzw,2062
-worqhat/_utils/_logs.py,sha256=cb3jsbICK0cXrlqMRi4y96MiJuqk5_rQy3ujWtoZTJU,777
-worqhat/_utils/_proxy.py,sha256=aglnj2yBTDyGX9Akk2crZHrl10oqRmceUy2Zp008XEs,1975
-worqhat/_utils/_reflection.py,sha256=ZmGkIgT_PuwedyNBrrKGbxoWtkpytJNU1uU4QHnmEMU,1364
-worqhat/_utils/_resources_proxy.py,sha256=KNhJsT2AQfFi4M_mmRtS0WAOH1Mq1ys8fLBhZfTKK-o,594
-worqhat/_utils/_streams.py,sha256=SMC90diFFecpEg_zgDRVbdR3hSEIgVVij4taD-noMLM,289
-worqhat/_utils/_sync.py,sha256=TpGLrrhRNWTJtODNE6Fup3_k7zrWm1j2RlirzBwre-0,2862
-worqhat/_utils/_transform.py,sha256=n7kskEWz6o__aoNvhFoGVyDoalNe6mJwp-g7BWkdj88,15617
-worqhat/_utils/_typing.py,sha256=D0DbbNu8GnYQTSICnTSHDGsYXj8TcAKyhejb0XcnjtY,4602
-worqhat/_utils/_utils.py,sha256=ts4CiiuNpFiGB6YMdkQRh2SZvYvsl7mAF-JWHCcLDf4,12312
-worqhat/lib/.keep,sha256=wuNrz-5SXo3jJaJOJgz4vFHM41YH_g20F5cRQo0vLes,224
-worqhat/resources/__init__.py,sha256=-XQmzr7q0bJW7cL4aopqosNOysUCxrJ0-pttbRVqL3A,989
-worqhat/resources/flows.py,sha256=jCzmxhZ8diuKubQaHE_mCnC1GYy7fhP66cvNHBUReUI,8211
-worqhat/resources/health.py,sha256=Pfe7CiktH5BezkPmbEZsLhGqnl9MmQkMbt6DUaIbWUw,5127
-worqhat/types/__init__.py,sha256=iV5rCndpqaAoydEG1QaUns5GfUrL7dXEUud2XFFWN-g,501
-worqhat/types/flow_retrieve_metrics_params.py,sha256=QMdN5LYYNSOXMBWLVLV0vMFLXIyvUVXNnLzjVFu_gTc,778
-worqhat/types/flow_retrieve_metrics_response.py,sha256=GajGYlbav9SVM0jF8RGzaHICtt6OIDlfid1sIP1oY0Q,1297
-worqhat/types/health_check_response.py,sha256=29tvzgqsy6wVfFwVunK5ouzSYeZGEUnQQuQpAQGsoxI,885
-worqhat/types/retrieve_server_info_response.py,sha256=9NDQ1MOKfU02tTlMcigQbjgUogqzrjmhmPir-77ftFY,342
-worqhat-3.1.0.dist-info/METADATA,sha256=ZRmy6MijBGF-AqosN6WhfjQtUbE-BT-52dtcNEu4Onk,13531
-worqhat-3.1.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-worqhat-3.1.0.dist-info/licenses/LICENSE,sha256=UwMftLIOitTJWtJ9bowByxdt9ZSFqmmb43oQosW5xiU,11337
-worqhat-3.1.0.dist-info/RECORD,,