groundx 2.0.15__py3-none-any.whl → 2.7.7__py3-none-any.whl

groundx/client.py

@@ -1,25 +1,20 @@
 # This file was auto-generated by Fern from our API Definition.
 
 import typing
-from .environment import GroundXEnvironment
+
 import httpx
-from .core.client_wrapper import SyncClientWrapper
-from .documents.client import DocumentsClient
-from .search.client import SearchClient
-from .buckets.client import BucketsClient
-from .groups.client import GroupsClient
-from .customer.client import CustomerClient
-from .health.client import HealthClient
-from .core.client_wrapper import AsyncClientWrapper
-from .documents.client import AsyncDocumentsClient
-from .search.client import AsyncSearchClient
-from .buckets.client import AsyncBucketsClient
-from .groups.client import AsyncGroupsClient
-from .customer.client import AsyncCustomerClient
-from .health.client import AsyncHealthClient
-
-
-class GroundX:
+from .buckets.client import AsyncBucketsClient, BucketsClient
+from .core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from .customer.client import AsyncCustomerClient, CustomerClient
+from .documents.client import AsyncDocumentsClient, DocumentsClient
+from .environment import GroundXEnvironment
+from .groups.client import AsyncGroupsClient, GroupsClient
+from .health.client import AsyncHealthClient, HealthClient
+from .search.client import AsyncSearchClient, SearchClient
+from .workflows.client import AsyncWorkflowsClient, WorkflowsClient
+
+
+class GroundXBase:
     """
     Use this class to access the different functions within the SDK. You can instantiate any number of clients with different configuration that will propagate to these functions.
 
@@ -66,7 +61,9 @@ class GroundX:
         follow_redirects: typing.Optional[bool] = True,
         httpx_client: typing.Optional[httpx.Client] = None,
     ):
-        _defaulted_timeout = timeout if timeout is not None else 60 if httpx_client is None else None
+        _defaulted_timeout = (
+            timeout if timeout is not None else 60 if httpx_client is None else httpx_client.timeout.read
+        )
         self._client_wrapper = SyncClientWrapper(
             base_url=_get_base_url(base_url=base_url, environment=environment),
             api_key=api_key,
@@ -81,11 +78,12 @@ class GroundX:
         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.workflows = WorkflowsClient(client_wrapper=self._client_wrapper)
         self.customer = CustomerClient(client_wrapper=self._client_wrapper)
         self.health = HealthClient(client_wrapper=self._client_wrapper)
 
 
-class AsyncGroundX:
+class AsyncGroundXBase:
     """
     Use this class to access the different functions within the SDK. You can instantiate any number of clients with different configuration that will propagate to these functions.
 
@@ -132,7 +130,9 @@ class AsyncGroundX:
         follow_redirects: typing.Optional[bool] = True,
         httpx_client: typing.Optional[httpx.AsyncClient] = None,
     ):
-        _defaulted_timeout = timeout if timeout is not None else 60 if httpx_client is None else None
+        _defaulted_timeout = (
+            timeout if timeout is not None else 60 if httpx_client is None else httpx_client.timeout.read
+        )
         self._client_wrapper = AsyncClientWrapper(
             base_url=_get_base_url(base_url=base_url, environment=environment),
             api_key=api_key,
@@ -147,6 +147,7 @@ class AsyncGroundX:
         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.workflows = AsyncWorkflowsClient(client_wrapper=self._client_wrapper)
         self.customer = AsyncCustomerClient(client_wrapper=self._client_wrapper)
         self.health = AsyncHealthClient(client_wrapper=self._client_wrapper)
 

groundx/core/__init__.py

@@ -1,10 +1,13 @@
 # This file was auto-generated by Fern from our API Definition.
 
+# isort: skip_file
+
 from .api_error import ApiError
 from .client_wrapper import AsyncClientWrapper, BaseClientWrapper, SyncClientWrapper
 from .datetime_utils import serialize_datetime
 from .file import File, convert_file_dict_to_httpx_tuples, with_content_type
 from .http_client import AsyncHttpClient, HttpClient
+from .http_response import AsyncHttpResponse, HttpResponse
 from .jsonable_encoder import jsonable_encoder
 from .pydantic_utilities import (
     IS_PYDANTIC_V2,
@@ -24,10 +27,12 @@ __all__ = [
     "ApiError",
     "AsyncClientWrapper",
     "AsyncHttpClient",
+    "AsyncHttpResponse",
     "BaseClientWrapper",
     "FieldMetadata",
     "File",
     "HttpClient",
+    "HttpResponse",
     "IS_PYDANTIC_V2",
     "RequestOptions",
     "SyncClientWrapper",

groundx/core/api_error.py

@@ -1,15 +1,23 @@
 # This file was auto-generated by Fern from our API Definition.
 
-import typing
+from typing import Any, Dict, Optional
 
 
 class ApiError(Exception):
-    status_code: typing.Optional[int]
-    body: typing.Any
+    headers: Optional[Dict[str, str]]
+    status_code: Optional[int]
+    body: Any
 
-    def __init__(self, *, status_code: typing.Optional[int] = None, body: typing.Any = None):
+    def __init__(
+        self,
+        *,
+        headers: Optional[Dict[str, str]] = None,
+        status_code: Optional[int] = None,
+        body: Any = None,
+    ) -> None:
+        self.headers = headers
         self.status_code = status_code
         self.body = body
 
     def __str__(self) -> str:
-        return f"status_code: {self.status_code}, body: {self.body}"
+        return f"headers: {self.headers}, status_code: {self.status_code}, body: {self.body}"

groundx/core/client_wrapper.py

@@ -1,9 +1,9 @@
 # This file was auto-generated by Fern from our API Definition.
 
 import typing
+
 import httpx
-from .http_client import HttpClient
-from .http_client import AsyncHttpClient
+from .http_client import AsyncHttpClient, HttpClient
 
 
 class BaseClientWrapper:
@@ -14,9 +14,10 @@ class BaseClientWrapper:
 
     def get_headers(self) -> typing.Dict[str, str]:
         headers: typing.Dict[str, str] = {
+            "User-Agent": "groundx/2.7.7",
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "groundx",
-            "X-Fern-SDK-Version": "2.0.15",
+            "X-Fern-SDK-Version": "2.7.7",
         }
         headers["X-API-Key"] = self.api_key
         return headers

groundx/core/force_multipart.py

@@ -0,0 +1,16 @@
+# This file was auto-generated by Fern from our API Definition.
+
+
+class ForceMultipartDict(dict):
+    """
+    A dictionary subclass that always evaluates to True in boolean contexts.
+
+    This is used to force multipart/form-data encoding in HTTP requests even when
+    the dictionary is empty, which would normally evaluate to False.
+    """
+
+    def __bool__(self):
+        return True
+
+
+FORCE_MULTIPART = ForceMultipartDict()

groundx/core/http_client.py

@@ -2,7 +2,6 @@
 
 import asyncio
 import email.utils
-import json
 import re
 import time
 import typing
@@ -11,12 +10,13 @@ from contextlib import asynccontextmanager, contextmanager
 from random import random
 
 import httpx
-
 from .file import File, convert_file_dict_to_httpx_tuples
+from .force_multipart import FORCE_MULTIPART
 from .jsonable_encoder import jsonable_encoder
 from .query_encoder import encode_query
 from .remove_none_from_dict import remove_none_from_dict
 from .request_options import RequestOptions
+from httpx._types import RequestFiles
 
 INITIAL_RETRY_DELAY_SECONDS = 0.5
 MAX_RETRY_DELAY_SECONDS = 10
@@ -85,8 +85,8 @@ def _retry_timeout(response: httpx.Response, retries: int) -> float:
 
 
 def _should_retry(response: httpx.Response) -> bool:
-    retriable_400s = [429, 408, 409]
-    return response.status_code >= 500 or response.status_code in retriable_400s
+    retryable_400s = [429, 408, 409]
+    return response.status_code >= 500 or response.status_code in retryable_400s
 
 
 def remove_omit_from_dict(
@@ -180,11 +180,17 @@ class HttpClient:
         json: typing.Optional[typing.Any] = None,
         data: typing.Optional[typing.Any] = None,
         content: typing.Optional[typing.Union[bytes, typing.Iterator[bytes], typing.AsyncIterator[bytes]]] = None,
-        files: typing.Optional[typing.Dict[str, typing.Optional[typing.Union[File, typing.List[File]]]]] = None,
+        files: typing.Optional[
+            typing.Union[
+                typing.Dict[str, typing.Optional[typing.Union[File, typing.List[File]]]],
+                typing.List[typing.Tuple[str, File]],
+            ]
+        ] = None,
         headers: typing.Optional[typing.Dict[str, typing.Any]] = None,
         request_options: typing.Optional[RequestOptions] = None,
-        retries: int = 0,
+        retries: int = 2,
         omit: typing.Optional[typing.Any] = None,
+        force_multipart: typing.Optional[bool] = None,
     ) -> httpx.Response:
         base_url = self.get_base_url(base_url)
         timeout = (
@@ -195,6 +201,15 @@ class HttpClient:
 
         json_body, data_body = get_request_body(json=json, data=data, request_options=request_options, omit=omit)
 
+        request_files: typing.Optional[RequestFiles] = (
+            convert_file_dict_to_httpx_tuples(remove_omit_from_dict(remove_none_from_dict(files), omit))
+            if (files is not None and files is not omit and isinstance(files, dict))
+            else None
+        )
+
+        if (request_files is None or len(request_files) == 0) and force_multipart:
+            request_files = FORCE_MULTIPART
+
         response = self.httpx_client.request(
             method=method,
             url=urllib.parse.urljoin(f"{base_url}/", path),
@@ -227,11 +242,7 @@ class HttpClient:
             json=json_body,
             data=data_body,
             content=content,
-            files=(
-                convert_file_dict_to_httpx_tuples(remove_omit_from_dict(remove_none_from_dict(files), omit))
-                if (files is not None and files is not omit)
-                else None
-            ),
+            files=request_files,
             timeout=timeout,
         )
 
@@ -266,11 +277,17 @@ class HttpClient:
         json: typing.Optional[typing.Any] = None,
         data: typing.Optional[typing.Any] = None,
         content: typing.Optional[typing.Union[bytes, typing.Iterator[bytes], typing.AsyncIterator[bytes]]] = None,
-        files: typing.Optional[typing.Dict[str, typing.Optional[typing.Union[File, typing.List[File]]]]] = None,
+        files: typing.Optional[
+            typing.Union[
+                typing.Dict[str, typing.Optional[typing.Union[File, typing.List[File]]]],
+                typing.List[typing.Tuple[str, File]],
+            ]
+        ] = None,
         headers: typing.Optional[typing.Dict[str, typing.Any]] = None,
         request_options: typing.Optional[RequestOptions] = None,
-        retries: int = 0,
+        retries: int = 2,
         omit: typing.Optional[typing.Any] = None,
+        force_multipart: typing.Optional[bool] = None,
     ) -> typing.Iterator[httpx.Response]:
         base_url = self.get_base_url(base_url)
         timeout = (
@@ -279,6 +296,15 @@ class HttpClient:
             else self.base_timeout()
         )
 
+        request_files: typing.Optional[RequestFiles] = (
+            convert_file_dict_to_httpx_tuples(remove_omit_from_dict(remove_none_from_dict(files), omit))
+            if (files is not None and files is not omit and isinstance(files, dict))
+            else None
+        )
+
+        if (request_files is None or len(request_files) == 0) and force_multipart:
+            request_files = FORCE_MULTIPART
+
         json_body, data_body = get_request_body(json=json, data=data, request_options=request_options, omit=omit)
 
         with self.httpx_client.stream(
@@ -313,11 +339,7 @@ class HttpClient:
             json=json_body,
             data=data_body,
             content=content,
-            files=(
-                convert_file_dict_to_httpx_tuples(remove_omit_from_dict(remove_none_from_dict(files), omit))
-                if (files is not None and files is not omit)
-                else None
-            ),
+            files=request_files,
             timeout=timeout,
         ) as stream:
             yield stream
@@ -356,11 +378,17 @@ class AsyncHttpClient:
         json: typing.Optional[typing.Any] = None,
         data: typing.Optional[typing.Any] = None,
         content: typing.Optional[typing.Union[bytes, typing.Iterator[bytes], typing.AsyncIterator[bytes]]] = None,
-        files: typing.Optional[typing.Dict[str, typing.Optional[typing.Union[File, typing.List[File]]]]] = None,
+        files: typing.Optional[
+            typing.Union[
+                typing.Dict[str, typing.Optional[typing.Union[File, typing.List[File]]]],
+                typing.List[typing.Tuple[str, File]],
+            ]
+        ] = None,
         headers: typing.Optional[typing.Dict[str, typing.Any]] = None,
         request_options: typing.Optional[RequestOptions] = None,
-        retries: int = 0,
+        retries: int = 2,
         omit: typing.Optional[typing.Any] = None,
+        force_multipart: typing.Optional[bool] = None,
     ) -> httpx.Response:
         base_url = self.get_base_url(base_url)
         timeout = (
@@ -369,6 +397,15 @@ class AsyncHttpClient:
             else self.base_timeout()
         )
 
+        request_files: typing.Optional[RequestFiles] = (
+            convert_file_dict_to_httpx_tuples(remove_omit_from_dict(remove_none_from_dict(files), omit))
+            if (files is not None and files is not omit and isinstance(files, dict))
+            else None
+        )
+
+        if (request_files is None or len(request_files) == 0) and force_multipart:
+            request_files = FORCE_MULTIPART
+
         json_body, data_body = get_request_body(json=json, data=data, request_options=request_options, omit=omit)
 
         # Add the input to each of these and do None-safety checks
@@ -404,11 +441,7 @@ class AsyncHttpClient:
             json=json_body,
             data=data_body,
             content=content,
-            files=(
-                convert_file_dict_to_httpx_tuples(remove_omit_from_dict(remove_none_from_dict(files), omit))
-                if files is not None
-                else None
-            ),
+            files=request_files,
             timeout=timeout,
         )
 
@@ -442,11 +475,17 @@ class AsyncHttpClient:
         json: typing.Optional[typing.Any] = None,
         data: typing.Optional[typing.Any] = None,
         content: typing.Optional[typing.Union[bytes, typing.Iterator[bytes], typing.AsyncIterator[bytes]]] = None,
-        files: typing.Optional[typing.Dict[str, typing.Optional[typing.Union[File, typing.List[File]]]]] = None,
+        files: typing.Optional[
+            typing.Union[
+                typing.Dict[str, typing.Optional[typing.Union[File, typing.List[File]]]],
+                typing.List[typing.Tuple[str, File]],
+            ]
+        ] = None,
         headers: typing.Optional[typing.Dict[str, typing.Any]] = None,
         request_options: typing.Optional[RequestOptions] = None,
-        retries: int = 0,
+        retries: int = 2,
         omit: typing.Optional[typing.Any] = None,
+        force_multipart: typing.Optional[bool] = None,
     ) -> typing.AsyncIterator[httpx.Response]:
         base_url = self.get_base_url(base_url)
         timeout = (
@@ -455,6 +494,15 @@ class AsyncHttpClient:
             else self.base_timeout()
         )
 
+        request_files: typing.Optional[RequestFiles] = (
+            convert_file_dict_to_httpx_tuples(remove_omit_from_dict(remove_none_from_dict(files), omit))
+            if (files is not None and files is not omit and isinstance(files, dict))
+            else None
+        )
+
+        if (request_files is None or len(request_files) == 0) and force_multipart:
+            request_files = FORCE_MULTIPART
+
         json_body, data_body = get_request_body(json=json, data=data, request_options=request_options, omit=omit)
 
         async with self.httpx_client.stream(
@@ -489,11 +537,7 @@ class AsyncHttpClient:
             json=json_body,
             data=data_body,
             content=content,
-            files=(
-                convert_file_dict_to_httpx_tuples(remove_omit_from_dict(remove_none_from_dict(files), omit))
-                if files is not None
-                else None
-            ),
+            files=request_files,
             timeout=timeout,
         ) as stream:
             yield stream

groundx/core/http_response.py

@@ -0,0 +1,55 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from typing import Dict, Generic, TypeVar
+
+import httpx
+
+T = TypeVar("T")
+"""Generic to represent the underlying type of the data wrapped by the HTTP response."""
+
+
+class BaseHttpResponse:
+    """Minimalist HTTP response wrapper that exposes response headers."""
+
+    _response: httpx.Response
+
+    def __init__(self, response: httpx.Response):
+        self._response = response
+
+    @property
+    def headers(self) -> Dict[str, str]:
+        return dict(self._response.headers)
+
+
+class HttpResponse(Generic[T], BaseHttpResponse):
+    """HTTP response wrapper that exposes response headers and data."""
+
+    _data: T
+
+    def __init__(self, response: httpx.Response, data: T):
+        super().__init__(response)
+        self._data = data
+
+    @property
+    def data(self) -> T:
+        return self._data
+
+    def close(self) -> None:
+        self._response.close()
+
+
+class AsyncHttpResponse(Generic[T], BaseHttpResponse):
+    """HTTP response wrapper that exposes response headers and data."""
+
+    _data: T
+
+    def __init__(self, response: httpx.Response, data: T):
+        super().__init__(response)
+        self._data = data
+
+    @property
+    def data(self) -> T:
+        return self._data
+
+    async def close(self) -> None:
+        await self._response.aclose()

groundx/core/jsonable_encoder.py

@@ -17,7 +17,6 @@ from types import GeneratorType
 from typing import Any, Callable, Dict, List, Optional, Set, Union
 
 import pydantic
-
 from .datetime_utils import serialize_datetime
 from .pydantic_utilities import (
     IS_PYDANTIC_V2,