PyPI - contextbase-base-client - Versions diffs - 0.5.0__py3-none-any.whl - Mend

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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (79) hide show

base_client/.fern/metadata.json +13 -0
base_client/CONTRIBUTING.md +125 -0
base_client/README.md +176 -0
base_client/__init__.py +159 -0
base_client/_default_clients.py +30 -0
base_client/bases/__init__.py +34 -0
base_client/bases/client.py +256 -0
base_client/bases/raw_client.py +365 -0
base_client/bases/types/__init__.py +34 -0
base_client/bases/types/list_bases_response.py +20 -0
base_client/binding_plan/__init__.py +4 -0
base_client/binding_plan/client.py +108 -0
base_client/binding_plan/raw_client.py +128 -0
base_client/bindings/__init__.py +34 -0
base_client/bindings/client.py +242 -0
base_client/bindings/raw_client.py +326 -0
base_client/bindings/types/__init__.py +34 -0
base_client/bindings/types/list_bindings_response.py +20 -0
base_client/client.py +252 -0
base_client/core/__init__.py +127 -0
base_client/core/api_error.py +23 -0
base_client/core/client_wrapper.py +102 -0
base_client/core/datetime_utils.py +70 -0
base_client/core/file.py +67 -0
base_client/core/force_multipart.py +18 -0
base_client/core/http_client.py +839 -0
base_client/core/http_response.py +59 -0
base_client/core/http_sse/__init__.py +42 -0
base_client/core/http_sse/_api.py +170 -0
base_client/core/http_sse/_decoders.py +61 -0
base_client/core/http_sse/_exceptions.py +7 -0
base_client/core/http_sse/_models.py +17 -0
base_client/core/jsonable_encoder.py +120 -0
base_client/core/logging.py +107 -0
base_client/core/parse_error.py +36 -0
base_client/core/pydantic_utilities.py +508 -0
base_client/core/query_encoder.py +58 -0
base_client/core/remove_none_from_dict.py +11 -0
base_client/core/request_options.py +35 -0
base_client/core/serialization.py +347 -0
base_client/dsn/__init__.py +4 -0
base_client/dsn/client.py +104 -0
base_client/dsn/raw_client.py +128 -0
base_client/errors/__init__.py +38 -0
base_client/errors/bad_request_error.py +11 -0
base_client/errors/forbidden_error.py +11 -0
base_client/reference.md +591 -0
base_client/sync_state/__init__.py +34 -0
base_client/sync_state/client.py +206 -0
base_client/sync_state/raw_client.py +280 -0
base_client/sync_state/types/__init__.py +34 -0
base_client/sync_state/types/sync_state_input_bindings_value.py +23 -0
base_client/tests/conftest.py +21 -0
base_client/tests/test_aiohttp_autodetect.py +113 -0
base_client/types/__init__.py +126 -0
base_client/types/api_key_auth.py +19 -0
base_client/types/authenticated_account_ref.py +20 -0
base_client/types/base.py +23 -0
base_client/types/binding.py +29 -0
base_client/types/binding_auth.py +72 -0
base_client/types/binding_auth_input.py +77 -0
base_client/types/binding_auth_input_api_key.py +19 -0
base_client/types/binding_auth_input_authenticated_account.py +20 -0
base_client/types/binding_auth_input_client_credentials.py +20 -0
base_client/types/binding_auth_input_none.py +17 -0
base_client/types/binding_auth_none.py +17 -0
base_client/types/binding_models.py +23 -0
base_client/types/binding_state.py +24 -0
base_client/types/binding_state_response.py +21 -0
base_client/types/client_credentials_auth.py +20 -0
base_client/types/dagster_all_plan_binding.py +27 -0
base_client/types/dagster_all_plan_binding_mode.py +5 -0
base_client/types/dagster_binding_plan_all.py +23 -0
base_client/types/dsn_response.py +19 -0
base_client/types/error.py +19 -0
base_client/types/run_status.py +10 -0
contextbase_base_client-0.5.0.dist-info/METADATA +10 -0
contextbase_base_client-0.5.0.dist-info/RECORD +79 -0
contextbase_base_client-0.5.0.dist-info/WHEEL +4 -0

base_client/reference.md ADDED Viewed

@@ -0,0 +1,591 @@
+# Reference
+## Bases
+<details><summary><code>client.bases.<a href="src/base_client/bases/client.py">list_bases</a>() -> ListBasesResponse</code></summary>
+<dl>
+<dd>
+#### 🔌 Usage
+<dl>
+<dd>
+<dl>
+<dd>
+```python
+from base_client import BaseAPIClient
+client = BaseAPIClient(
+    base_url="https://yourhost.com/path/to/api",
+)
+client.bases.list_bases()
+```
+</dd>
+</dl>
+</dd>
+</dl>
+#### ⚙️ Parameters
+<dl>
+<dd>
+<dl>
+<dd>
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+</dd>
+</dl>
+</dd>
+</dl>
+</dd>
+</dl>
+</details>
+<details><summary><code>client.bases.<a href="src/base_client/bases/client.py">create_base</a>(...) -> Base</code></summary>
+<dl>
+<dd>
+#### 🔌 Usage
+<dl>
+<dd>
+<dl>
+<dd>
+```python
+from base_client import BaseAPIClient
+client = BaseAPIClient(
+    base_url="https://yourhost.com/path/to/api",
+)
+client.bases.create_base(
+    dsn_secret="dsn_secret",
+    name="name",
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+#### ⚙️ Parameters
+<dl>
+<dd>
+<dl>
+<dd>
+**dsn_secret:** `str`
+</dd>
+</dl>
+<dl>
+<dd>
+**name:** `str`
+</dd>
+</dl>
+<dl>
+<dd>
+**owner_user_id:** `typing.Optional[str]`
+</dd>
+</dl>
+<dl>
+<dd>
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+</dd>
+</dl>
+</dd>
+</dl>
+</dd>
+</dl>
+</details>
+<details><summary><code>client.bases.<a href="src/base_client/bases/client.py">get_base</a>(...) -> Base</code></summary>
+<dl>
+<dd>
+#### 🔌 Usage
+<dl>
+<dd>
+<dl>
+<dd>
+```python
+from base_client import BaseAPIClient
+client = BaseAPIClient(
+    base_url="https://yourhost.com/path/to/api",
+)
+client.bases.get_base(
+    base_id="base_id",
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+#### ⚙️ Parameters
+<dl>
+<dd>
+<dl>
+<dd>
+**base_id:** `str`
+</dd>
+</dl>
+<dl>
+<dd>
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+</dd>
+</dl>
+</dd>
+</dl>
+</dd>
+</dl>
+</details>
+## BindingPlan
+<details><summary><code>client.binding_plan.<a href="src/base_client/binding_plan/client.py">get_binding_plan</a>(...) -> DagsterBindingPlanAll</code></summary>
+<dl>
+<dd>
+#### 🔌 Usage
+<dl>
+<dd>
+<dl>
+<dd>
+```python
+from base_client import BaseAPIClient
+client = BaseAPIClient(
+    base_url="https://yourhost.com/path/to/api",
+)
+client.binding_plan.get_binding_plan(
+    base_id="base_id",
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+#### ⚙️ Parameters
+<dl>
+<dd>
+<dl>
+<dd>
+**base_id:** `str`
+</dd>
+</dl>
+<dl>
+<dd>
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+</dd>
+</dl>
+</dd>
+</dl>
+</dd>
+</dl>
+</details>
+## Bindings
+<details><summary><code>client.bindings.<a href="src/base_client/bindings/client.py">list_bindings</a>(...) -> ListBindingsResponse</code></summary>
+<dl>
+<dd>
+#### 🔌 Usage
+<dl>
+<dd>
+<dl>
+<dd>
+```python
+from base_client import BaseAPIClient
+client = BaseAPIClient(
+    base_url="https://yourhost.com/path/to/api",
+)
+client.bindings.list_bindings(
+    base_id="base_id",
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+#### ⚙️ Parameters
+<dl>
+<dd>
+<dl>
+<dd>
+**base_id:** `str`
+</dd>
+</dl>
+<dl>
+<dd>
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+</dd>
+</dl>
+</dd>
+</dl>
+</dd>
+</dl>
+</details>
+<details><summary><code>client.bindings.<a href="src/base_client/bindings/client.py">create_binding</a>(...) -> Binding</code></summary>
+<dl>
+<dd>
+#### 🔌 Usage
+<dl>
+<dd>
+<dl>
+<dd>
+```python
+from base_client import BaseAPIClient, BindingAuthInput_ApiKey
+client = BaseAPIClient(
+    base_url="https://yourhost.com/path/to/api",
+)
+client.bindings.create_binding(
+    base_id="base_id",
+    auth=BindingAuthInput_ApiKey(
+        api_key_secret="api_key_secret",
+    ),
+    plugin_id="plugin_id",
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+#### ⚙️ Parameters
+<dl>
+<dd>
+<dl>
+<dd>
+**base_id:** `str`
+</dd>
+</dl>
+<dl>
+<dd>
+**auth:** `BindingAuthInput`
+</dd>
+</dl>
+<dl>
+<dd>
+**plugin_id:** `str`
+</dd>
+</dl>
+<dl>
+<dd>
+**config:** `typing.Optional[typing.Dict[str, typing.Any]]`
+</dd>
+</dl>
+<dl>
+<dd>
+**enabled:** `typing.Optional[bool]`
+</dd>
+</dl>
+<dl>
+<dd>
+**models:** `typing.Optional[BindingModels]`
+</dd>
+</dl>
+<dl>
+<dd>
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+</dd>
+</dl>
+</dd>
+</dl>
+</dd>
+</dl>
+</details>
+## Dsn
+<details><summary><code>client.dsn.<a href="src/base_client/dsn/client.py">get_dsn</a>(...) -> DsnResponse</code></summary>
+<dl>
+<dd>
+#### 🔌 Usage
+<dl>
+<dd>
+<dl>
+<dd>
+```python
+from base_client import BaseAPIClient
+client = BaseAPIClient(
+    base_url="https://yourhost.com/path/to/api",
+)
+client.dsn.get_dsn(
+    base_id="base_id",
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+#### ⚙️ Parameters
+<dl>
+<dd>
+<dl>
+<dd>
+**base_id:** `str`
+</dd>
+</dl>
+<dl>
+<dd>
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+</dd>
+</dl>
+</dd>
+</dl>
+</dd>
+</dl>
+</details>
+## SyncState
+<details><summary><code>client.sync_state.<a href="src/base_client/sync_state/client.py">get_sync_state</a>(...) -> BindingStateResponse</code></summary>
+<dl>
+<dd>
+#### 🔌 Usage
+<dl>
+<dd>
+<dl>
+<dd>
+```python
+from base_client import BaseAPIClient
+client = BaseAPIClient(
+    base_url="https://yourhost.com/path/to/api",
+)
+client.sync_state.get_sync_state(
+    base_id="base_id",
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+#### ⚙️ Parameters
+<dl>
+<dd>
+<dl>
+<dd>
+**base_id:** `str`
+</dd>
+</dl>
+<dl>
+<dd>
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+</dd>
+</dl>
+</dd>
+</dl>
+</dd>
+</dl>
+</details>
+<details><summary><code>client.sync_state.<a href="src/base_client/sync_state/client.py">report_sync_state</a>(...)</code></summary>
+<dl>
+<dd>
+#### 🔌 Usage
+<dl>
+<dd>
+<dl>
+<dd>
+```python
+from base_client import BaseAPIClient
+from base_client.sync_state import SyncStateInputBindingsValue
+client = BaseAPIClient(
+    base_url="https://yourhost.com/path/to/api",
+)
+client.sync_state.report_sync_state(
+    base_id="base_id",
+    bindings={
+        "key": SyncStateInputBindingsValue()
+    },
+    version=1.1,
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+#### ⚙️ Parameters
+<dl>
+<dd>
+<dl>
+<dd>
+**base_id:** `str`
+</dd>
+</dl>
+<dl>
+<dd>
+**bindings:** `typing.Dict[str, SyncStateInputBindingsValue]`
+</dd>
+</dl>
+<dl>
+<dd>
+**version:** `float`
+</dd>
+</dl>
+<dl>
+<dd>
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+</dd>
+</dl>
+</dd>
+</dl>
+</dd>
+</dl>
+</details>

base_client/sync_state/__init__.py ADDED Viewed

@@ -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 .types import SyncStateInputBindingsValue
+_dynamic_imports: typing.Dict[str, str] = {"SyncStateInputBindingsValue": ".types"}
+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__ = ["SyncStateInputBindingsValue"]