contextbase-base-client 0.5.0__py3-none-any.whl

base_client/bindings/raw_client.py

@@ -0,0 +1,326 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from json.decoder import JSONDecodeError
+
+from ..core.api_error import ApiError
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.http_response import AsyncHttpResponse, HttpResponse
+from ..core.jsonable_encoder import encode_path_param
+from ..core.parse_error import ParsingError
+from ..core.pydantic_utilities import parse_obj_as
+from ..core.request_options import RequestOptions
+from ..core.serialization import convert_and_respect_annotation_metadata
+from ..errors.bad_request_error import BadRequestError
+from ..errors.forbidden_error import ForbiddenError
+from ..types.binding import Binding
+from ..types.binding_auth_input import BindingAuthInput
+from ..types.binding_models import BindingModels
+from ..types.error import Error
+from .types.list_bindings_response import ListBindingsResponse
+from pydantic import ValidationError
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class RawBindingsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def list_bindings(
+        self, base_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> HttpResponse[ListBindingsResponse]:
+        """
+        Parameters
+        ----------
+        base_id : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[ListBindingsResponse]
+            Bindings for the base.
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"base/bases/{encode_path_param(base_id)}/bindings",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    ListBindingsResponse,
+                    parse_obj_as(
+                        type_=ListBindingsResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Error,
+                        parse_obj_as(
+                            type_=Error,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    def create_binding(
+        self,
+        base_id: str,
+        *,
+        auth: BindingAuthInput,
+        plugin_id: str,
+        config: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
+        enabled: typing.Optional[bool] = OMIT,
+        models: typing.Optional[BindingModels] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> HttpResponse[Binding]:
+        """
+        Parameters
+        ----------
+        base_id : str
+
+        auth : BindingAuthInput
+
+        plugin_id : str
+
+        config : typing.Optional[typing.Dict[str, typing.Any]]
+
+        enabled : typing.Optional[bool]
+
+        models : typing.Optional[BindingModels]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[Binding]
+            The created binding.
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"base/bases/{encode_path_param(base_id)}/bindings",
+            method="POST",
+            json={
+                "auth": convert_and_respect_annotation_metadata(
+                    object_=auth, annotation=BindingAuthInput, direction="write"
+                ),
+                "config": config,
+                "enabled": enabled,
+                "models": convert_and_respect_annotation_metadata(
+                    object_=models, annotation=typing.Optional[BindingModels], direction="write"
+                ),
+                "plugin_id": plugin_id,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    Binding,
+                    parse_obj_as(
+                        type_=Binding,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Error,
+                        parse_obj_as(
+                            type_=Error,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Error,
+                        parse_obj_as(
+                            type_=Error,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+
+class AsyncRawBindingsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def list_bindings(
+        self, base_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> AsyncHttpResponse[ListBindingsResponse]:
+        """
+        Parameters
+        ----------
+        base_id : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[ListBindingsResponse]
+            Bindings for the base.
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"base/bases/{encode_path_param(base_id)}/bindings",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    ListBindingsResponse,
+                    parse_obj_as(
+                        type_=ListBindingsResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Error,
+                        parse_obj_as(
+                            type_=Error,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    async def create_binding(
+        self,
+        base_id: str,
+        *,
+        auth: BindingAuthInput,
+        plugin_id: str,
+        config: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
+        enabled: typing.Optional[bool] = OMIT,
+        models: typing.Optional[BindingModels] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncHttpResponse[Binding]:
+        """
+        Parameters
+        ----------
+        base_id : str
+
+        auth : BindingAuthInput
+
+        plugin_id : str
+
+        config : typing.Optional[typing.Dict[str, typing.Any]]
+
+        enabled : typing.Optional[bool]
+
+        models : typing.Optional[BindingModels]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[Binding]
+            The created binding.
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"base/bases/{encode_path_param(base_id)}/bindings",
+            method="POST",
+            json={
+                "auth": convert_and_respect_annotation_metadata(
+                    object_=auth, annotation=BindingAuthInput, direction="write"
+                ),
+                "config": config,
+                "enabled": enabled,
+                "models": convert_and_respect_annotation_metadata(
+                    object_=models, annotation=typing.Optional[BindingModels], direction="write"
+                ),
+                "plugin_id": plugin_id,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    Binding,
+                    parse_obj_as(
+                        type_=Binding,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Error,
+                        parse_obj_as(
+                            type_=Error,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Error,
+                        parse_obj_as(
+                            type_=Error,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)

base_client/bindings/types/__init__.py

@@ -0,0 +1,34 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+import typing
+from importlib import import_module
+
+if typing.TYPE_CHECKING:
+    from .list_bindings_response import ListBindingsResponse
+_dynamic_imports: typing.Dict[str, str] = {"ListBindingsResponse": ".list_bindings_response"}
+
+
+def __getattr__(attr_name: str) -> typing.Any:
+    module_name = _dynamic_imports.get(attr_name)
+    if module_name is None:
+        raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}")
+    try:
+        module = import_module(module_name, __package__)
+        if module_name == f".{attr_name}":
+            return module
+        else:
+            return getattr(module, attr_name)
+    except ImportError as e:
+        raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e
+    except AttributeError as e:
+        raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e
+
+
+def __dir__():
+    lazy_attrs = list(_dynamic_imports.keys())
+    return sorted(lazy_attrs)
+
+
+__all__ = ["ListBindingsResponse"]

base_client/bindings/types/list_bindings_response.py

@@ -0,0 +1,20 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ...types.binding import Binding
+
+
+class ListBindingsResponse(UniversalBaseModel):
+    bindings: typing.List[Binding]
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

base_client/client.py

@@ -0,0 +1,252 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+
+import typing
+
+import httpx
+from .core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from .core.logging import LogConfig, Logger
+
+if typing.TYPE_CHECKING:
+    from .bases.client import AsyncBasesClient, BasesClient
+    from .binding_plan.client import AsyncBindingPlanClient, BindingPlanClient
+    from .bindings.client import AsyncBindingsClient, BindingsClient
+    from .dsn.client import AsyncDsnClient, DsnClient
+    from .sync_state.client import AsyncSyncStateClient, SyncStateClient
+
+
+class BaseAPIClient:
+    """
+    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.
+
+    Parameters
+    ----------
+    base_url : str
+        The base url to use for requests from the client.
+
+    headers : typing.Optional[typing.Dict[str, str]]
+        Additional headers to send with every request.
+
+    timeout : typing.Optional[float]
+        The timeout to be used, in seconds, for requests. By default the timeout is 60 seconds, unless a custom httpx client is used, in which case this default is not enforced.
+
+    max_retries : typing.Optional[int]
+        The default maximum number of retries for failed requests. Defaults to 2. Per-request `max_retries` in `request_options` takes precedence over this value.
+
+    follow_redirects : typing.Optional[bool]
+        Whether the default httpx client follows redirects or not, this is irrelevant if a custom httpx client is passed in.
+
+    httpx_client : typing.Optional[httpx.Client]
+        The httpx client to use for making requests, a preconfigured client is used by default, however this is useful should you want to pass in any custom httpx configuration.
+
+    logging : typing.Optional[typing.Union[LogConfig, Logger]]
+        Configure logging for the SDK. Accepts a LogConfig dict with 'level' (debug/info/warn/error), 'logger' (custom logger implementation), and 'silent' (boolean, defaults to True) fields. You can also pass a pre-configured Logger instance.
+
+    Examples
+    --------
+    from base_client import BaseAPIClient
+
+    client = BaseAPIClient(
+        base_url="https://yourhost.com/path/to/api",
+    )
+    """
+
+    def __init__(
+        self,
+        *,
+        base_url: str,
+        headers: typing.Optional[typing.Dict[str, str]] = None,
+        timeout: typing.Optional[float] = None,
+        max_retries: typing.Optional[int] = None,
+        follow_redirects: typing.Optional[bool] = True,
+        httpx_client: typing.Optional[httpx.Client] = None,
+        logging: typing.Optional[typing.Union[LogConfig, Logger]] = None,
+    ):
+        _defaulted_timeout = (
+            timeout if timeout is not None else 60 if httpx_client is None else httpx_client.timeout.read
+        )
+        _defaulted_max_retries = max_retries if max_retries is not None else 2
+        self._client_wrapper = SyncClientWrapper(
+            base_url=base_url,
+            headers=headers,
+            httpx_client=httpx_client
+            if httpx_client is not None
+            else httpx.Client(timeout=_defaulted_timeout, follow_redirects=follow_redirects)
+            if follow_redirects is not None
+            else httpx.Client(timeout=_defaulted_timeout),
+            timeout=_defaulted_timeout,
+            max_retries=_defaulted_max_retries,
+            logging=logging,
+        )
+        self._bases: typing.Optional[BasesClient] = None
+        self._binding_plan: typing.Optional[BindingPlanClient] = None
+        self._bindings: typing.Optional[BindingsClient] = None
+        self._dsn: typing.Optional[DsnClient] = None
+        self._sync_state: typing.Optional[SyncStateClient] = None
+
+    @property
+    def bases(self):
+        if self._bases is None:
+            from .bases.client import BasesClient  # noqa: E402
+
+            self._bases = BasesClient(client_wrapper=self._client_wrapper)
+        return self._bases
+
+    @property
+    def binding_plan(self):
+        if self._binding_plan is None:
+            from .binding_plan.client import BindingPlanClient  # noqa: E402
+
+            self._binding_plan = BindingPlanClient(client_wrapper=self._client_wrapper)
+        return self._binding_plan
+
+    @property
+    def bindings(self):
+        if self._bindings is None:
+            from .bindings.client import BindingsClient  # noqa: E402
+
+            self._bindings = BindingsClient(client_wrapper=self._client_wrapper)
+        return self._bindings
+
+    @property
+    def dsn(self):
+        if self._dsn is None:
+            from .dsn.client import DsnClient  # noqa: E402
+
+            self._dsn = DsnClient(client_wrapper=self._client_wrapper)
+        return self._dsn
+
+    @property
+    def sync_state(self):
+        if self._sync_state is None:
+            from .sync_state.client import SyncStateClient  # noqa: E402
+
+            self._sync_state = SyncStateClient(client_wrapper=self._client_wrapper)
+        return self._sync_state
+
+
+def _make_default_async_client(
+    timeout: typing.Optional[float],
+    follow_redirects: typing.Optional[bool],
+) -> httpx.AsyncClient:
+    try:
+        import httpx_aiohttp  # type: ignore[import-not-found]
+    except ImportError:
+        pass
+    else:
+        if follow_redirects is not None:
+            return httpx_aiohttp.HttpxAiohttpClient(timeout=timeout, follow_redirects=follow_redirects)
+        return httpx_aiohttp.HttpxAiohttpClient(timeout=timeout)
+
+    if follow_redirects is not None:
+        return httpx.AsyncClient(timeout=timeout, follow_redirects=follow_redirects)
+    return httpx.AsyncClient(timeout=timeout)
+
+
+class AsyncBaseAPIClient:
+    """
+    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.
+
+    Parameters
+    ----------
+    base_url : str
+        The base url to use for requests from the client.
+
+    headers : typing.Optional[typing.Dict[str, str]]
+        Additional headers to send with every request.
+
+    timeout : typing.Optional[float]
+        The timeout to be used, in seconds, for requests. By default the timeout is 60 seconds, unless a custom httpx client is used, in which case this default is not enforced.
+
+    max_retries : typing.Optional[int]
+        The default maximum number of retries for failed requests. Defaults to 2. Per-request `max_retries` in `request_options` takes precedence over this value.
+
+    follow_redirects : typing.Optional[bool]
+        Whether the default httpx client follows redirects or not, this is irrelevant if a custom httpx client is passed in.
+
+    httpx_client : typing.Optional[httpx.AsyncClient]
+        The httpx client to use for making requests, a preconfigured client is used by default, however this is useful should you want to pass in any custom httpx configuration.
+
+    logging : typing.Optional[typing.Union[LogConfig, Logger]]
+        Configure logging for the SDK. Accepts a LogConfig dict with 'level' (debug/info/warn/error), 'logger' (custom logger implementation), and 'silent' (boolean, defaults to True) fields. You can also pass a pre-configured Logger instance.
+
+    Examples
+    --------
+    from base_client import AsyncBaseAPIClient
+
+    client = AsyncBaseAPIClient(
+        base_url="https://yourhost.com/path/to/api",
+    )
+    """
+
+    def __init__(
+        self,
+        *,
+        base_url: str,
+        headers: typing.Optional[typing.Dict[str, str]] = None,
+        timeout: typing.Optional[float] = None,
+        max_retries: typing.Optional[int] = None,
+        follow_redirects: typing.Optional[bool] = True,
+        httpx_client: typing.Optional[httpx.AsyncClient] = None,
+        logging: typing.Optional[typing.Union[LogConfig, Logger]] = None,
+    ):
+        _defaulted_timeout = (
+            timeout if timeout is not None else 60 if httpx_client is None else httpx_client.timeout.read
+        )
+        _defaulted_max_retries = max_retries if max_retries is not None else 2
+        self._client_wrapper = AsyncClientWrapper(
+            base_url=base_url,
+            headers=headers,
+            httpx_client=httpx_client
+            if httpx_client is not None
+            else _make_default_async_client(timeout=_defaulted_timeout, follow_redirects=follow_redirects),
+            timeout=_defaulted_timeout,
+            max_retries=_defaulted_max_retries,
+            logging=logging,
+        )
+        self._bases: typing.Optional[AsyncBasesClient] = None
+        self._binding_plan: typing.Optional[AsyncBindingPlanClient] = None
+        self._bindings: typing.Optional[AsyncBindingsClient] = None
+        self._dsn: typing.Optional[AsyncDsnClient] = None
+        self._sync_state: typing.Optional[AsyncSyncStateClient] = None
+
+    @property
+    def bases(self):
+        if self._bases is None:
+            from .bases.client import AsyncBasesClient  # noqa: E402
+
+            self._bases = AsyncBasesClient(client_wrapper=self._client_wrapper)
+        return self._bases
+
+    @property
+    def binding_plan(self):
+        if self._binding_plan is None:
+            from .binding_plan.client import AsyncBindingPlanClient  # noqa: E402
+
+            self._binding_plan = AsyncBindingPlanClient(client_wrapper=self._client_wrapper)
+        return self._binding_plan
+
+    @property
+    def bindings(self):
+        if self._bindings is None:
+            from .bindings.client import AsyncBindingsClient  # noqa: E402
+
+            self._bindings = AsyncBindingsClient(client_wrapper=self._client_wrapper)
+        return self._bindings
+
+    @property
+    def dsn(self):
+        if self._dsn is None:
+            from .dsn.client import AsyncDsnClient  # noqa: E402
+
+            self._dsn = AsyncDsnClient(client_wrapper=self._client_wrapper)
+        return self._dsn
+
+    @property
+    def sync_state(self):
+        if self._sync_state is None:
+            from .sync_state.client import AsyncSyncStateClient  # noqa: E402
+
+            self._sync_state = AsyncSyncStateClient(client_wrapper=self._client_wrapper)
+        return self._sync_state