groundx 2.6.0__tar.gz → 2.6.3__tar.gz

{groundx-2.6.0 → groundx-2.6.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: groundx
-Version: 2.6.0
+Version: 2.6.3
 Summary: 
 License: MIT
 Requires-Python: >=3.8,<4.0

{groundx-2.6.0 → groundx-2.6.3}/pyproject.toml

@@ -3,7 +3,7 @@ name = "groundx"
 
 [tool.poetry]
 name = "groundx"
-version = "2.6.0"
+version = "2.6.3"
 description = ""
 readme = "README.md"
 authors = []

{groundx-2.6.0 → groundx-2.6.3}/src/groundx/__init__.py

@@ -72,12 +72,12 @@ from .types import (
     WorkflowsResponse,
 )
 from .errors import BadRequestError, UnauthorizedError
-from . import buckets, customer, documents, groups, health, search, workflow
+from . import buckets, customer, documents, groups, health, search, workflows
 from .environment import GroundXEnvironment
 from .ingest import AsyncGroundX, GroundX
 from .search import SearchContentRequestId
 from .version import __version__
-from .workflow import WorkflowGetRequestId
+from .workflows import WorkflowsGetRequestId
 
 __all__ = [
     "AsyncGroundX",
@@ -139,7 +139,6 @@ __all__ = [
     "WorkflowEngine",
     "WorkflowEngineReasoningEffort",
     "WorkflowEngineService",
-    "WorkflowGetRequestId",
     "WorkflowPrompt",
     "WorkflowPromptGroup",
     "WorkflowPromptRole",
@@ -153,6 +152,7 @@ __all__ = [
     "WorkflowStepsSearchQuery",
     "WorkflowStepsSectInstruct",
     "WorkflowStepsSectSummary",
+    "WorkflowsGetRequestId",
     "WorkflowsResponse",
     "__version__",
     "buckets",
@@ -161,5 +161,5 @@ __all__ = [
     "groups",
     "health",
     "search",
-    "workflow",
+    "workflows",
 ]

{groundx-2.6.0 → groundx-2.6.3}/src/groundx/client.py

@@ -11,7 +11,7 @@ from .environment import GroundXEnvironment
 from .groups.client import AsyncGroupsClient, GroupsClient
 from .health.client import AsyncHealthClient, HealthClient
 from .search.client import AsyncSearchClient, SearchClient
-from .workflow.client import AsyncWorkflowClient, WorkflowClient
+from .workflows.client import AsyncWorkflowsClient, WorkflowsClient
 
 
 class GroundXBase:
@@ -78,7 +78,7 @@ class GroundXBase:
         self.search = SearchClient(client_wrapper=self._client_wrapper)
         self.buckets = BucketsClient(client_wrapper=self._client_wrapper)
         self.groups = GroupsClient(client_wrapper=self._client_wrapper)
-        self.workflow = WorkflowClient(client_wrapper=self._client_wrapper)
+        self.workflows = WorkflowsClient(client_wrapper=self._client_wrapper)
         self.customer = CustomerClient(client_wrapper=self._client_wrapper)
         self.health = HealthClient(client_wrapper=self._client_wrapper)
 
@@ -147,7 +147,7 @@ class AsyncGroundXBase:
         self.search = AsyncSearchClient(client_wrapper=self._client_wrapper)
         self.buckets = AsyncBucketsClient(client_wrapper=self._client_wrapper)
         self.groups = AsyncGroupsClient(client_wrapper=self._client_wrapper)
-        self.workflow = AsyncWorkflowClient(client_wrapper=self._client_wrapper)
+        self.workflows = AsyncWorkflowsClient(client_wrapper=self._client_wrapper)
         self.customer = AsyncCustomerClient(client_wrapper=self._client_wrapper)
         self.health = AsyncHealthClient(client_wrapper=self._client_wrapper)
 

{groundx-2.6.0 → groundx-2.6.3}/src/groundx/core/client_wrapper.py

@@ -14,10 +14,10 @@ class BaseClientWrapper:
 
     def get_headers(self) -> typing.Dict[str, str]:
         headers: typing.Dict[str, str] = {
-            "User-Agent": "groundx/2.6.0",
+            "User-Agent": "groundx/2.6.3",
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "groundx",
-            "X-Fern-SDK-Version": "2.6.0",
+            "X-Fern-SDK-Version": "2.6.3",
         }
         headers["X-API-Key"] = self.api_key
         return headers

{groundx-2.6.0/src/groundx/workflow → groundx-2.6.3/src/groundx/workflows}/__init__.py

@@ -2,6 +2,6 @@
 
 # isort: skip_file
 
-from .types import WorkflowGetRequestId
+from .types import WorkflowsGetRequestId
 
-__all__ = ["WorkflowGetRequestId"]
+__all__ = ["WorkflowsGetRequestId"]

{groundx-2.6.0/src/groundx/workflow → groundx-2.6.3/src/groundx/workflows}/client.py

@@ -8,25 +8,25 @@ from ..types.message_response import MessageResponse
 from ..types.workflow_response import WorkflowResponse
 from ..types.workflow_steps import WorkflowSteps
 from ..types.workflows_response import WorkflowsResponse
-from .raw_client import AsyncRawWorkflowClient, RawWorkflowClient
-from .types.workflow_get_request_id import WorkflowGetRequestId
+from .raw_client import AsyncRawWorkflowsClient, RawWorkflowsClient
+from .types.workflows_get_request_id import WorkflowsGetRequestId
 
 # this is used as the default value for optional parameters
 OMIT = typing.cast(typing.Any, ...)
 
 
-class WorkflowClient:
+class WorkflowsClient:
     def __init__(self, *, client_wrapper: SyncClientWrapper):
-        self._raw_client = RawWorkflowClient(client_wrapper=client_wrapper)
+        self._raw_client = RawWorkflowsClient(client_wrapper=client_wrapper)
 
     @property
-    def with_raw_response(self) -> RawWorkflowClient:
+    def with_raw_response(self) -> RawWorkflowsClient:
         """
         Retrieves a raw implementation of this client that returns raw responses.
 
         Returns
         -------
-        RawWorkflowClient
+        RawWorkflowsClient
         """
         return self._raw_client
 
@@ -51,7 +51,7 @@ class WorkflowClient:
         client = GroundX(
             api_key="YOUR_API_KEY",
         )
-        client.workflow.list()
+        client.workflows.list()
         """
         _response = self._raw_client.list(request_options=request_options)
         return _response.data
@@ -88,12 +88,12 @@ class WorkflowClient:
         client = GroundX(
             api_key="YOUR_API_KEY",
         )
-        client.workflow.create()
+        client.workflows.create()
         """
         _response = self._raw_client.create(name=name, steps=steps, request_options=request_options)
         return _response.data
 
-    def relationship_add_to_account(
+    def add_to_account(
         self, *, workflow_id: str, request_options: typing.Optional[RequestOptions] = None
     ) -> MessageResponse:
         """
@@ -119,18 +119,14 @@ class WorkflowClient:
         client = GroundX(
             api_key="YOUR_API_KEY",
         )
-        client.workflow.relationship_add_to_account(
+        client.workflows.add_to_account(
             workflow_id="workflowId",
         )
         """
-        _response = self._raw_client.relationship_add_to_account(
-            workflow_id=workflow_id, request_options=request_options
-        )
+        _response = self._raw_client.add_to_account(workflow_id=workflow_id, request_options=request_options)
         return _response.data
 
-    def relationship_remove_from_account(
-        self, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> MessageResponse:
+    def remove_from_account(self, *, request_options: typing.Optional[RequestOptions] = None) -> MessageResponse:
         """
         Removes the assigned workflow from the customer account.
 
@@ -151,12 +147,12 @@ class WorkflowClient:
         client = GroundX(
             api_key="YOUR_API_KEY",
         )
-        client.workflow.relationship_remove_from_account()
+        client.workflows.remove_from_account()
         """
-        _response = self._raw_client.relationship_remove_from_account(request_options=request_options)
+        _response = self._raw_client.remove_from_account(request_options=request_options)
         return _response.data
 
-    def relationship_add_to_id(
+    def add_to_id(
         self, id: int, *, workflow_id: str, request_options: typing.Optional[RequestOptions] = None
     ) -> MessageResponse:
         """
@@ -185,19 +181,15 @@ class WorkflowClient:
         client = GroundX(
             api_key="YOUR_API_KEY",
         )
-        client.workflow.relationship_add_to_id(
+        client.workflows.add_to_id(
             id=1,
             workflow_id="workflowId",
         )
         """
-        _response = self._raw_client.relationship_add_to_id(
-            id, workflow_id=workflow_id, request_options=request_options
-        )
+        _response = self._raw_client.add_to_id(id, workflow_id=workflow_id, request_options=request_options)
         return _response.data
 
-    def relationship_remove_from_id(
-        self, id: int, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> MessageResponse:
+    def remove_from_id(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> MessageResponse:
         """
         Removes the assigned workflow from the customer account.
 
@@ -221,22 +213,22 @@ class WorkflowClient:
         client = GroundX(
             api_key="YOUR_API_KEY",
         )
-        client.workflow.relationship_remove_from_id(
+        client.workflows.remove_from_id(
             id=1,
         )
         """
-        _response = self._raw_client.relationship_remove_from_id(id, request_options=request_options)
+        _response = self._raw_client.remove_from_id(id, request_options=request_options)
         return _response.data
 
     def get(
-        self, id: WorkflowGetRequestId, *, request_options: typing.Optional[RequestOptions] = None
+        self, id: WorkflowsGetRequestId, *, request_options: typing.Optional[RequestOptions] = None
     ) -> WorkflowResponse:
         """
         look up a specific workflow by groupId, bucketId, or workflowId.
 
         Parameters
         ----------
-        id : WorkflowGetRequestId
+        id : WorkflowsGetRequestId
             The id of the group, bucket, or workflow to look up.
 
         request_options : typing.Optional[RequestOptions]
@@ -254,7 +246,7 @@ class WorkflowClient:
         client = GroundX(
             api_key="YOUR_API_KEY",
         )
-        client.workflow.get(
+        client.workflows.get(
             id=1,
         )
         """
@@ -301,7 +293,7 @@ class WorkflowClient:
         client = GroundX(
             api_key="YOUR_API_KEY",
         )
-        client.workflow.update(
+        client.workflows.update(
             id="id",
             workflow_id="workflowId",
         )
@@ -335,7 +327,7 @@ class WorkflowClient:
         client = GroundX(
             api_key="YOUR_API_KEY",
         )
-        client.workflow.delete(
+        client.workflows.delete(
             id="id",
         )
         """
@@ -343,18 +335,18 @@ class WorkflowClient:
         return _response.data
 
 
-class AsyncWorkflowClient:
+class AsyncWorkflowsClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
-        self._raw_client = AsyncRawWorkflowClient(client_wrapper=client_wrapper)
+        self._raw_client = AsyncRawWorkflowsClient(client_wrapper=client_wrapper)
 
     @property
-    def with_raw_response(self) -> AsyncRawWorkflowClient:
+    def with_raw_response(self) -> AsyncRawWorkflowsClient:
         """
         Retrieves a raw implementation of this client that returns raw responses.
 
         Returns
         -------
-        AsyncRawWorkflowClient
+        AsyncRawWorkflowsClient
         """
         return self._raw_client
 
@@ -384,7 +376,7 @@ class AsyncWorkflowClient:
 
 
         async def main() -> None:
-            await client.workflow.list()
+            await client.workflows.list()
 
 
         asyncio.run(main())
@@ -429,7 +421,7 @@ class AsyncWorkflowClient:
 
 
         async def main() -> None:
-            await client.workflow.create()
+            await client.workflows.create()
 
 
         asyncio.run(main())
@@ -437,7 +429,7 @@ class AsyncWorkflowClient:
         _response = await self._raw_client.create(name=name, steps=steps, request_options=request_options)
         return _response.data
 
-    async def relationship_add_to_account(
+    async def add_to_account(
         self, *, workflow_id: str, request_options: typing.Optional[RequestOptions] = None
     ) -> MessageResponse:
         """
@@ -468,21 +460,17 @@ class AsyncWorkflowClient:
 
 
         async def main() -> None:
-            await client.workflow.relationship_add_to_account(
+            await client.workflows.add_to_account(
                 workflow_id="workflowId",
             )
 
 
         asyncio.run(main())
         """
-        _response = await self._raw_client.relationship_add_to_account(
-            workflow_id=workflow_id, request_options=request_options
-        )
+        _response = await self._raw_client.add_to_account(workflow_id=workflow_id, request_options=request_options)
         return _response.data
 
-    async def relationship_remove_from_account(
-        self, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> MessageResponse:
+    async def remove_from_account(self, *, request_options: typing.Optional[RequestOptions] = None) -> MessageResponse:
         """
         Removes the assigned workflow from the customer account.
 
@@ -508,15 +496,15 @@ class AsyncWorkflowClient:
 
 
         async def main() -> None:
-            await client.workflow.relationship_remove_from_account()
+            await client.workflows.remove_from_account()
 
 
         asyncio.run(main())
         """
-        _response = await self._raw_client.relationship_remove_from_account(request_options=request_options)
+        _response = await self._raw_client.remove_from_account(request_options=request_options)
         return _response.data
 
-    async def relationship_add_to_id(
+    async def add_to_id(
         self, id: int, *, workflow_id: str, request_options: typing.Optional[RequestOptions] = None
     ) -> MessageResponse:
         """
@@ -550,7 +538,7 @@ class AsyncWorkflowClient:
 
 
         async def main() -> None:
-            await client.workflow.relationship_add_to_id(
+            await client.workflows.add_to_id(
                 id=1,
                 workflow_id="workflowId",
             )
@@ -558,12 +546,10 @@ class AsyncWorkflowClient:
 
         asyncio.run(main())
         """
-        _response = await self._raw_client.relationship_add_to_id(
-            id, workflow_id=workflow_id, request_options=request_options
-        )
+        _response = await self._raw_client.add_to_id(id, workflow_id=workflow_id, request_options=request_options)
         return _response.data
 
-    async def relationship_remove_from_id(
+    async def remove_from_id(
         self, id: int, *, request_options: typing.Optional[RequestOptions] = None
     ) -> MessageResponse:
         """
@@ -594,25 +580,25 @@ class AsyncWorkflowClient:
 
 
         async def main() -> None:
-            await client.workflow.relationship_remove_from_id(
+            await client.workflows.remove_from_id(
                 id=1,
             )
 
 
         asyncio.run(main())
         """
-        _response = await self._raw_client.relationship_remove_from_id(id, request_options=request_options)
+        _response = await self._raw_client.remove_from_id(id, request_options=request_options)
         return _response.data
 
     async def get(
-        self, id: WorkflowGetRequestId, *, request_options: typing.Optional[RequestOptions] = None
+        self, id: WorkflowsGetRequestId, *, request_options: typing.Optional[RequestOptions] = None
     ) -> WorkflowResponse:
         """
         look up a specific workflow by groupId, bucketId, or workflowId.
 
         Parameters
         ----------
-        id : WorkflowGetRequestId
+        id : WorkflowsGetRequestId
             The id of the group, bucket, or workflow to look up.
 
         request_options : typing.Optional[RequestOptions]
@@ -635,7 +621,7 @@ class AsyncWorkflowClient:
 
 
         async def main() -> None:
-            await client.workflow.get(
+            await client.workflows.get(
                 id=1,
             )
 
@@ -690,7 +676,7 @@ class AsyncWorkflowClient:
 
 
         async def main() -> None:
-            await client.workflow.update(
+            await client.workflows.update(
                 id="id",
                 workflow_id="workflowId",
             )
@@ -732,7 +718,7 @@ class AsyncWorkflowClient:
 
 
         async def main() -> None:
-            await client.workflow.delete(
+            await client.workflows.delete(
                 id="id",
             )
 

{groundx-2.6.0/src/groundx/workflow → groundx-2.6.3/src/groundx/workflows}/raw_client.py

@@ -14,13 +14,13 @@ from ..types.message_response import MessageResponse
 from ..types.workflow_response import WorkflowResponse
 from ..types.workflow_steps import WorkflowSteps
 from ..types.workflows_response import WorkflowsResponse
-from .types.workflow_get_request_id import WorkflowGetRequestId
+from .types.workflows_get_request_id import WorkflowsGetRequestId
 
 # this is used as the default value for optional parameters
 OMIT = typing.cast(typing.Any, ...)
 
 
-class RawWorkflowClient:
+class RawWorkflowsClient:
     def __init__(self, *, client_wrapper: SyncClientWrapper):
         self._client_wrapper = client_wrapper
 
@@ -113,7 +113,7 @@ class RawWorkflowClient:
             raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
         raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
 
-    def relationship_add_to_account(
+    def add_to_account(
         self, *, workflow_id: str, request_options: typing.Optional[RequestOptions] = None
     ) -> HttpResponse[MessageResponse]:
         """
@@ -159,7 +159,7 @@ class RawWorkflowClient:
             raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
         raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
 
-    def relationship_remove_from_account(
+    def remove_from_account(
         self, *, request_options: typing.Optional[RequestOptions] = None
     ) -> HttpResponse[MessageResponse]:
         """
@@ -195,7 +195,7 @@ class RawWorkflowClient:
             raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
         raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
 
-    def relationship_add_to_id(
+    def add_to_id(
         self, id: int, *, workflow_id: str, request_options: typing.Optional[RequestOptions] = None
     ) -> HttpResponse[MessageResponse]:
         """
@@ -244,7 +244,7 @@ class RawWorkflowClient:
             raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
         raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
 
-    def relationship_remove_from_id(
+    def remove_from_id(
         self, id: int, *, request_options: typing.Optional[RequestOptions] = None
     ) -> HttpResponse[MessageResponse]:
         """
@@ -284,14 +284,14 @@ class RawWorkflowClient:
         raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
 
     def get(
-        self, id: WorkflowGetRequestId, *, request_options: typing.Optional[RequestOptions] = None
+        self, id: WorkflowsGetRequestId, *, request_options: typing.Optional[RequestOptions] = None
     ) -> HttpResponse[WorkflowResponse]:
         """
         look up a specific workflow by groupId, bucketId, or workflowId.
 
         Parameters
         ----------
-        id : WorkflowGetRequestId
+        id : WorkflowsGetRequestId
             The id of the group, bucket, or workflow to look up.
 
         request_options : typing.Optional[RequestOptions]
@@ -426,7 +426,7 @@ class RawWorkflowClient:
         raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
 
 
-class AsyncRawWorkflowClient:
+class AsyncRawWorkflowsClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
         self._client_wrapper = client_wrapper
 
@@ -521,7 +521,7 @@ class AsyncRawWorkflowClient:
             raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
         raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
 
-    async def relationship_add_to_account(
+    async def add_to_account(
         self, *, workflow_id: str, request_options: typing.Optional[RequestOptions] = None
     ) -> AsyncHttpResponse[MessageResponse]:
         """
@@ -567,7 +567,7 @@ class AsyncRawWorkflowClient:
             raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
         raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
 
-    async def relationship_remove_from_account(
+    async def remove_from_account(
         self, *, request_options: typing.Optional[RequestOptions] = None
     ) -> AsyncHttpResponse[MessageResponse]:
         """
@@ -603,7 +603,7 @@ class AsyncRawWorkflowClient:
             raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
         raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
 
-    async def relationship_add_to_id(
+    async def add_to_id(
         self, id: int, *, workflow_id: str, request_options: typing.Optional[RequestOptions] = None
     ) -> AsyncHttpResponse[MessageResponse]:
         """
@@ -652,7 +652,7 @@ class AsyncRawWorkflowClient:
             raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
         raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
 
-    async def relationship_remove_from_id(
+    async def remove_from_id(
         self, id: int, *, request_options: typing.Optional[RequestOptions] = None
     ) -> AsyncHttpResponse[MessageResponse]:
         """
@@ -692,14 +692,14 @@ class AsyncRawWorkflowClient:
         raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
 
     async def get(
-        self, id: WorkflowGetRequestId, *, request_options: typing.Optional[RequestOptions] = None
+        self, id: WorkflowsGetRequestId, *, request_options: typing.Optional[RequestOptions] = None
     ) -> AsyncHttpResponse[WorkflowResponse]:
         """
         look up a specific workflow by groupId, bucketId, or workflowId.
 
         Parameters
         ----------
-        id : WorkflowGetRequestId
+        id : WorkflowsGetRequestId
             The id of the group, bucket, or workflow to look up.
 
         request_options : typing.Optional[RequestOptions]

groundx-2.6.3/src/groundx/workflows/types/__init__.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+from .workflows_get_request_id import WorkflowsGetRequestId
+
+__all__ = ["WorkflowsGetRequestId"]

groundx-2.6.0/src/groundx/workflow/types/workflow_get_request_id.py → groundx-2.6.3/src/groundx/workflows/types/workflows_get_request_id.py

@@ -2,4 +2,4 @@
 
 import typing
 
-WorkflowGetRequestId = typing.Union[int, str]
+WorkflowsGetRequestId = typing.Union[int, str]

groundx-2.6.0/src/groundx/workflow/types/__init__.py

@@ -1,7 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-# isort: skip_file
-
-from .workflow_get_request_id import WorkflowGetRequestId
-
-__all__ = ["WorkflowGetRequestId"]