diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
new file mode 100644
index 0000000..5ce2ae1
--- /dev/null
+++ b/.github/CODEOWNERS
@@ -0,0 +1 @@
+* @SchematicHQ/devtools
diff --git a/CLAUDE.md b/CLAUDE.md
new file mode 100644
index 0000000..1c1f594
--- /dev/null
+++ b/CLAUDE.md
@@ -0,0 +1,88 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Overview
+
+This repository contains the Schematic Python SDK, which provides a convenient interface to the Schematic API for Python applications. The library includes type definitions for all request and response fields, and offers both synchronous and asynchronous clients powered by httpx.
+
+## Environment Setup
+
+```bash
+# Install dependencies using Poetry
+poetry install
+
+# Or install via pip
+pip install schematichq
+```
+
+## Development Commands
+
+### Building and Testing
+
+```bash
+# Run all tests
+poetry run pytest
+
+# Run a specific test file
+poetry run pytest tests/custom/test_client.py
+
+# Run tests with specific markers (e.g. asyncio)
+poetry run pytest -m asyncio
+
+# Run tests with more verbose output
+poetry run pytest -v
+```
+
+### Code Quality
+
+```bash
+# Type checking
+poetry run mypy src
+
+# Run linter
+poetry run ruff check src
+```
+
+## Project Structure
+
+- `src/schematic/` - Main SDK code
+ - `client.py` - Main client entry point, provides Schematic and AsyncSchematic classes
+ - `base_client.py` - Base client implementation
+ - `event_buffer.py` - Buffer for events with retry logic
+ - `cache.py` - Local cache implementation for flag checks
+ - `core/` - Core functionality like HTTP client, API error handling
+ - `webhook_utils/` - Utilities for webhook verification
+ - Various services organized by API section (companies, events, features, etc.)
+
+## Key Components
+
+### Clients
+
+The SDK provides two main client classes:
+
+1. `Schematic` - Synchronous client
+2. `AsyncSchematic` - Asynchronous client
+
+Both clients have the same interface but the async client returns awaitable objects.
+
+### Event Buffer
+
+The SDK implements an event buffer for batching events before sending them to the API. Events are automatically flushed periodically or when the buffer is full. The event buffer includes retry logic with exponential backoff.
+
+### Configuration
+
+Clients can be configured with:
+
+- Custom HTTP clients
+- Flag defaults for offline/fallback mode
+- Cache settings
+- Timeout settings
+- Retry settings
+
+### Webhook Verification
+
+The SDK provides utilities for verifying webhook signatures from Schematic to ensure security:
+
+- `verify_webhook_signature` - For web request verification
+- `verify_signature` - For manual signature verification
diff --git a/poetry.lock b/poetry.lock
index 98ff907..c8e7e14 100644
--- a/poetry.lock
+++ b/poetry.lock
@@ -60,15 +60,18 @@ files = [
[[package]]
name = "exceptiongroup"
-version = "1.2.2"
+version = "1.3.0"
description = "Backport of PEP 654 (exception groups)"
optional = false
python-versions = ">=3.7"
files = [
- {file = "exceptiongroup-1.2.2-py3-none-any.whl", hash = "sha256:3111b9d131c238bec2f8f516e123e14ba243563fb135d3fe885990585aa7795b"},
- {file = "exceptiongroup-1.2.2.tar.gz", hash = "sha256:47c2edf7c6738fafb49fd34290706d1a1a2f4d1c6df275526b62cbb4aa5393cc"},
+ {file = "exceptiongroup-1.3.0-py3-none-any.whl", hash = "sha256:4d111e6e0c13d0644cad6ddaa7ed0261a0b36971f6d23e7ec9b4b9097da78a10"},
+ {file = "exceptiongroup-1.3.0.tar.gz", hash = "sha256:b241f5885f560bc56a59ee63ca4c6a8bfa46ae4ad651af316d4e81817bb9fd88"},
]
+[package.dependencies]
+typing-extensions = {version = ">=4.6.0", markers = "python_version < \"3.13\""}
+
[package.extras]
test = ["pytest (>=6)"]
diff --git a/pyproject.toml b/pyproject.toml
index 945db2a..6336db8 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -3,7 +3,7 @@ name = "schematichq"
[tool.poetry]
name = "schematichq"
-version = "1.0.8"
+version = "1.0.9"
description = ""
readme = "README.md"
authors = []
diff --git a/reference.md b/reference.md
deleted file mode 100644
index ba9546c..0000000
--- a/reference.md
+++ /dev/null
@@ -1,12539 +0,0 @@
-# Reference
-## accounts
-client.accounts.list_api_keys(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.accounts.list_api_keys(require_environment=True, )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**require_environment:** `bool`
-
-
-
-
-
--
-
-**environment_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.accounts.create_api_key(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.accounts.create_api_key(name='name', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**name:** `str`
-
-
-
-
-
--
-
-**description:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**environment_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.accounts.get_api_key(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.accounts.get_api_key(api_key_id='api_key_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**api_key_id:** `str` — api_key_id
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.accounts.update_api_key(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.accounts.update_api_key(api_key_id='api_key_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**api_key_id:** `str` — api_key_id
-
-
-
-
-
--
-
-**description:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**name:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.accounts.delete_api_key(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.accounts.delete_api_key(api_key_id='api_key_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**api_key_id:** `str` — api_key_id
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.accounts.count_api_keys(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.accounts.count_api_keys(require_environment=True, )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**require_environment:** `bool`
-
-
-
-
-
--
-
-**environment_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.accounts.list_api_requests(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.accounts.list_api_requests()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**q:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_type:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**environment_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.accounts.get_api_request(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.accounts.get_api_request(api_request_id='api_request_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**api_request_id:** `str` — api_request_id
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.accounts.count_api_requests(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.accounts.count_api_requests()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**q:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_type:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**environment_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.accounts.list_environments(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.accounts.list_environments()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]`
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.accounts.create_environment(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.accounts.create_environment(environment_type="development", name='name', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**environment_type:** `CreateEnvironmentRequestBodyEnvironmentType`
-
-
-
-
-
--
-
-**name:** `str`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.accounts.get_environment(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.accounts.get_environment(environment_id='environment_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**environment_id:** `str` — environment_id
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.accounts.update_environment(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.accounts.update_environment(environment_id='environment_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**environment_id:** `str` — environment_id
-
-
-
-
-
--
-
-**environment_type:** `typing.Optional[UpdateEnvironmentRequestBodyEnvironmentType]`
-
-
-
-
-
--
-
-**name:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.accounts.delete_environment(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.accounts.delete_environment(environment_id='environment_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**environment_id:** `str` — environment_id
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.features.count_audience_companies(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-from schematic import CreateOrUpdateConditionGroupRequestBody
-from schematic import CreateOrUpdateConditionRequestBody
-client = Schematic(api_key="YOUR_API_KEY", )
-client.features.count_audience_companies(condition_groups=[CreateOrUpdateConditionGroupRequestBody(conditions=[CreateOrUpdateConditionRequestBody(condition_type="company", operator="eq", resource_ids=['resource_ids'], )], )], conditions=[CreateOrUpdateConditionRequestBody(condition_type="company", operator="eq", resource_ids=['resource_ids'], )], )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**condition_groups:** `typing.Sequence[CreateOrUpdateConditionGroupRequestBody]`
-
-
-
-
-
--
-
-**conditions:** `typing.Sequence[CreateOrUpdateConditionRequestBody]`
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**q:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.features.count_audience_users(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-from schematic import CreateOrUpdateConditionGroupRequestBody
-from schematic import CreateOrUpdateConditionRequestBody
-client = Schematic(api_key="YOUR_API_KEY", )
-client.features.count_audience_users(condition_groups=[CreateOrUpdateConditionGroupRequestBody(conditions=[CreateOrUpdateConditionRequestBody(condition_type="company", operator="eq", resource_ids=['resource_ids'], )], )], conditions=[CreateOrUpdateConditionRequestBody(condition_type="company", operator="eq", resource_ids=['resource_ids'], )], )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**condition_groups:** `typing.Sequence[CreateOrUpdateConditionGroupRequestBody]`
-
-
-
-
-
--
-
-**conditions:** `typing.Sequence[CreateOrUpdateConditionRequestBody]`
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**q:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.features.list_audience_companies(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-from schematic import CreateOrUpdateConditionGroupRequestBody
-from schematic import CreateOrUpdateConditionRequestBody
-client = Schematic(api_key="YOUR_API_KEY", )
-client.features.list_audience_companies(condition_groups=[CreateOrUpdateConditionGroupRequestBody(conditions=[CreateOrUpdateConditionRequestBody(condition_type="company", operator="eq", resource_ids=['resource_ids'], )], )], conditions=[CreateOrUpdateConditionRequestBody(condition_type="company", operator="eq", resource_ids=['resource_ids'], )], )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**condition_groups:** `typing.Sequence[CreateOrUpdateConditionGroupRequestBody]`
-
-
-
-
-
--
-
-**conditions:** `typing.Sequence[CreateOrUpdateConditionRequestBody]`
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**q:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.features.list_audience_users(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-from schematic import CreateOrUpdateConditionGroupRequestBody
-from schematic import CreateOrUpdateConditionRequestBody
-client = Schematic(api_key="YOUR_API_KEY", )
-client.features.list_audience_users(condition_groups=[CreateOrUpdateConditionGroupRequestBody(conditions=[CreateOrUpdateConditionRequestBody(condition_type="company", operator="eq", resource_ids=['resource_ids'], )], )], conditions=[CreateOrUpdateConditionRequestBody(condition_type="company", operator="eq", resource_ids=['resource_ids'], )], )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**condition_groups:** `typing.Sequence[CreateOrUpdateConditionGroupRequestBody]`
-
-
-
-
-
--
-
-**conditions:** `typing.Sequence[CreateOrUpdateConditionRequestBody]`
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**q:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.features.list_features(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.features.list_features()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]`
-
-
-
-
-
--
-
-**q:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**without_company_override_for:** `typing.Optional[str]` — Filter out features that already have a company override for the specified company ID
-
-
-
-
-
--
-
-**without_plan_entitlement_for:** `typing.Optional[str]` — Filter out features that already have a plan entitlement for the specified plan ID
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.features.create_feature(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.features.create_feature(description='description', feature_type="boolean", name='name', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**description:** `str`
-
-
-
-
-
--
-
-**feature_type:** `CreateFeatureRequestBodyFeatureType`
-
-
-
-
-
--
-
-**name:** `str`
-
-
-
-
-
--
-
-**event_subtype:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**flag:** `typing.Optional[CreateOrUpdateFlagRequestBody]`
-
-
-
-
-
--
-
-**icon:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**lifecycle_phase:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**maintainer_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**plural_name:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**singular_name:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**trait_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.features.get_feature(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.features.get_feature(feature_id='feature_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**feature_id:** `str` — feature_id
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.features.update_feature(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.features.update_feature(feature_id='feature_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**feature_id:** `str` — feature_id
-
-
-
-
-
--
-
-**description:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**event_subtype:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**feature_type:** `typing.Optional[UpdateFeatureRequestBodyFeatureType]`
-
-
-
-
-
--
-
-**flag:** `typing.Optional[CreateOrUpdateFlagRequestBody]`
-
-
-
-
-
--
-
-**icon:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**lifecycle_phase:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**maintainer_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**name:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**plural_name:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**singular_name:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**trait_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.features.delete_feature(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.features.delete_feature(feature_id='feature_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**feature_id:** `str` — feature_id
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.features.count_features(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.features.count_features()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]`
-
-
-
-
-
--
-
-**q:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**without_company_override_for:** `typing.Optional[str]` — Filter out features that already have a company override for the specified company ID
-
-
-
-
-
--
-
-**without_plan_entitlement_for:** `typing.Optional[str]` — Filter out features that already have a plan entitlement for the specified plan ID
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.features.list_flags(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.features.list_flags()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**feature_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]`
-
-
-
-
-
--
-
-**q:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.features.create_flag(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.features.create_flag(default_value=True, description='description', flag_type='flag_type', key='key', name='name', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**default_value:** `bool`
-
-
-
-
-
--
-
-**description:** `str`
-
-
-
-
-
--
-
-**flag_type:** `str`
-
-
-
-
-
--
-
-**key:** `str`
-
-
-
-
-
--
-
-**name:** `str`
-
-
-
-
-
--
-
-**feature_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**maintainer_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.features.get_flag(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.features.get_flag(flag_id='flag_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**flag_id:** `str` — flag_id
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.features.update_flag(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.features.update_flag(flag_id='flag_id', default_value=True, description='description', flag_type='flag_type', key='key', name='name', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**flag_id:** `str` — flag_id
-
-
-
-
-
--
-
-**default_value:** `bool`
-
-
-
-
-
--
-
-**description:** `str`
-
-
-
-
-
--
-
-**flag_type:** `str`
-
-
-
-
-
--
-
-**key:** `str`
-
-
-
-
-
--
-
-**name:** `str`
-
-
-
-
-
--
-
-**feature_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**maintainer_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.features.delete_flag(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.features.delete_flag(flag_id='flag_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**flag_id:** `str` — flag_id
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.features.update_flag_rules(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-from schematic import CreateOrUpdateRuleRequestBody
-from schematic import CreateOrUpdateConditionGroupRequestBody
-from schematic import CreateOrUpdateConditionRequestBody
-client = Schematic(api_key="YOUR_API_KEY", )
-client.features.update_flag_rules(flag_id='flag_id', rules=[CreateOrUpdateRuleRequestBody(condition_groups=[CreateOrUpdateConditionGroupRequestBody(conditions=[CreateOrUpdateConditionRequestBody(condition_type="company", operator="eq", resource_ids=['resource_ids'], )], )], conditions=[CreateOrUpdateConditionRequestBody(condition_type="company", operator="eq", resource_ids=['resource_ids'], )], name='name', priority=1, value=True, )], )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**flag_id:** `str` — flag_id
-
-
-
-
-
--
-
-**rules:** `typing.Sequence[CreateOrUpdateRuleRequestBody]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.features.check_flag(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.features.check_flag(key='key', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**key:** `str` — key
-
-
-
-
-
--
-
-**company:** `typing.Optional[typing.Dict[str, str]]`
-
-
-
-
-
--
-
-**user:** `typing.Optional[typing.Dict[str, str]]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.features.check_flags(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.features.check_flags()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**company:** `typing.Optional[typing.Dict[str, str]]`
-
-
-
-
-
--
-
-**user:** `typing.Optional[typing.Dict[str, str]]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.features.count_flags(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.features.count_flags()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**feature_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]`
-
-
-
-
-
--
-
-**q:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.billing.list_coupons(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.billing.list_coupons()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**is_active:** `typing.Optional[bool]`
-
-
-
-
-
--
-
-**q:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.billing.upsert_billing_coupon(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.billing.upsert_billing_coupon(amount_off=1, duration='duration', duration_in_months=1, external_id='external_id', max_redemptions=1, name='name', percent_off=1.1, times_redeemed=1, )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**amount_off:** `int`
-
-
-
-
-
--
-
-**duration:** `str`
-
-
-
-
-
--
-
-**duration_in_months:** `int`
-
-
-
-
-
--
-
-**external_id:** `str`
-
-
-
-
-
--
-
-**max_redemptions:** `int`
-
-
-
-
-
--
-
-**name:** `str`
-
-
-
-
-
--
-
-**percent_off:** `float`
-
-
-
-
-
--
-
-**times_redeemed:** `int`
-
-
-
-
-
--
-
-**currency:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.billing.upsert_billing_customer(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.billing.upsert_billing_customer(email='email', external_id='external_id', failed_to_import=True, meta={'key': 'value'}, name='name', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**email:** `str`
-
-
-
-
-
--
-
-**external_id:** `str`
-
-
-
-
-
--
-
-**failed_to_import:** `bool`
-
-
-
-
-
--
-
-**meta:** `typing.Dict[str, str]`
-
-
-
-
-
--
-
-**name:** `str`
-
-
-
-
-
--
-
-**company_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**default_payment_method_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.billing.list_customers_with_subscriptions(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.billing.list_customers_with_subscriptions()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**company_ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]`
-
-
-
-
-
--
-
-**name:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**failed_to_import:** `typing.Optional[bool]`
-
-
-
-
-
--
-
-**q:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.billing.count_customers(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.billing.count_customers()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**company_ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]`
-
-
-
-
-
--
-
-**name:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**failed_to_import:** `typing.Optional[bool]`
-
-
-
-
-
--
-
-**q:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.billing.list_invoices(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.billing.list_invoices(customer_external_id='customer_external_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**customer_external_id:** `str`
-
-
-
-
-
--
-
-**company_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**subscription_external_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.billing.upsert_invoice(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.billing.upsert_invoice(amount_due=1, amount_paid=1, amount_remaining=1, collection_method='collection_method', currency='currency', customer_external_id='customer_external_id', subtotal=1, )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**amount_due:** `int`
-
-
-
-
-
--
-
-**amount_paid:** `int`
-
-
-
-
-
--
-
-**amount_remaining:** `int`
-
-
-
-
-
--
-
-**collection_method:** `str`
-
-
-
-
-
--
-
-**currency:** `str`
-
-
-
-
-
--
-
-**customer_external_id:** `str`
-
-
-
-
-
--
-
-**subtotal:** `int`
-
-
-
-
-
--
-
-**due_date:** `typing.Optional[dt.datetime]`
-
-
-
-
-
--
-
-**external_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**payment_method_external_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**subscription_external_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**url:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.billing.list_meters(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.billing.list_meters()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**display_name:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.billing.upsert_billing_meter(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.billing.upsert_billing_meter(display_name='display_name', event_name='event_name', event_payload_key='event_payload_key', external_id='external_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**display_name:** `str`
-
-
-
-
-
--
-
-**event_name:** `str`
-
-
-
-
-
--
-
-**event_payload_key:** `str`
-
-
-
-
-
--
-
-**external_id:** `str`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.billing.list_payment_methods(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.billing.list_payment_methods(customer_external_id='customer_external_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**customer_external_id:** `str`
-
-
-
-
-
--
-
-**company_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.billing.upsert_payment_method(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.billing.upsert_payment_method(customer_external_id='customer_external_id', external_id='external_id', payment_method_type='payment_method_type', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**customer_external_id:** `str`
-
-
-
-
-
--
-
-**external_id:** `str`
-
-
-
-
-
--
-
-**payment_method_type:** `str`
-
-
-
-
-
--
-
-**account_last_4:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**account_name:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**bank_name:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**billing_email:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**billing_name:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**card_brand:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**card_exp_month:** `typing.Optional[int]`
-
-
-
-
-
--
-
-**card_exp_year:** `typing.Optional[int]`
-
-
-
-
-
--
-
-**card_last_4:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.billing.search_billing_prices(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.billing.search_billing_prices()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]`
-
-
-
-
-
--
-
-**q:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**interval:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**usage_type:** `typing.Optional[SearchBillingPricesRequestUsageType]`
-
-
-
-
-
--
-
-**price:** `typing.Optional[int]`
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.billing.upsert_billing_price(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-from schematic import CreateBillingPriceTierRequestBody
-client = Schematic(api_key="YOUR_API_KEY", )
-client.billing.upsert_billing_price(billing_scheme="per_unit", currency='currency', external_account_id='external_account_id', interval='interval', is_active=True, price=1, price_external_id='price_external_id', price_tiers=[CreateBillingPriceTierRequestBody(price_external_id='price_external_id', )], product_external_id='product_external_id', usage_type="licensed", )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**billing_scheme:** `CreateBillingPriceRequestBodyBillingScheme`
-
-
-
-
-
--
-
-**currency:** `str`
-
-
-
-
-
--
-
-**external_account_id:** `str`
-
-
-
-
-
--
-
-**interval:** `str`
-
-
-
-
-
--
-
-**is_active:** `bool`
-
-
-
-
-
--
-
-**price:** `int`
-
-
-
-
-
--
-
-**price_external_id:** `str`
-
-
-
-
-
--
-
-**price_tiers:** `typing.Sequence[CreateBillingPriceTierRequestBody]`
-
-
-
-
-
--
-
-**product_external_id:** `str`
-
-
-
-
-
--
-
-**usage_type:** `CreateBillingPriceRequestBodyUsageType`
-
-
-
-
-
--
-
-**meter_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**package_size:** `typing.Optional[int]`
-
-
-
-
-
--
-
-**price_decimal:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**tier_mode:** `typing.Optional[CreateBillingPriceRequestBodyTierMode]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.billing.delete_billing_product(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.billing.delete_billing_product(billing_id='billing_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**billing_id:** `str` — billing_id
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.billing.list_product_prices(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.billing.list_product_prices()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]`
-
-
-
-
-
--
-
-**name:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**q:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**price_usage_type:** `typing.Optional[ListProductPricesRequestPriceUsageType]`
-
-
-
-
-
--
-
-**without_linked_to_plan:** `typing.Optional[bool]` — Filter products that are not linked to any plan
-
-
-
-
-
--
-
-**with_one_time_charges:** `typing.Optional[bool]` — Filter products that are one time charges
-
-
-
-
-
--
-
-**with_zero_price:** `typing.Optional[bool]` — Filter products that have zero price for free subscription type
-
-
-
-
-
--
-
-**with_prices_only:** `typing.Optional[bool]` — Filter products that have prices
-
-
-
-
-
--
-
-**is_active:** `typing.Optional[bool]` — Filter products that are active
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.billing.delete_product_price(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.billing.delete_product_price(billing_id='billing_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**billing_id:** `str` — billing_id
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.billing.upsert_billing_product(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.billing.upsert_billing_product(external_id='external_id', name='name', price=1.1, )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**external_id:** `str`
-
-
-
-
-
--
-
-**name:** `str`
-
-
-
-
-
--
-
-**price:** `float`
-
-
-
-
-
--
-
-**is_active:** `typing.Optional[bool]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.billing.list_billing_products(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.billing.list_billing_products()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]`
-
-
-
-
-
--
-
-**name:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**q:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**price_usage_type:** `typing.Optional[ListBillingProductsRequestPriceUsageType]`
-
-
-
-
-
--
-
-**without_linked_to_plan:** `typing.Optional[bool]` — Filter products that are not linked to any plan
-
-
-
-
-
--
-
-**with_one_time_charges:** `typing.Optional[bool]` — Filter products that are one time charges
-
-
-
-
-
--
-
-**with_zero_price:** `typing.Optional[bool]` — Filter products that have zero price for free subscription type
-
-
-
-
-
--
-
-**with_prices_only:** `typing.Optional[bool]` — Filter products that have prices
-
-
-
-
-
--
-
-**is_active:** `typing.Optional[bool]` — Filter products that are active
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.billing.count_billing_products(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.billing.count_billing_products()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]`
-
-
-
-
-
--
-
-**name:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**q:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**price_usage_type:** `typing.Optional[CountBillingProductsRequestPriceUsageType]`
-
-
-
-
-
--
-
-**without_linked_to_plan:** `typing.Optional[bool]` — Filter products that are not linked to any plan
-
-
-
-
-
--
-
-**with_one_time_charges:** `typing.Optional[bool]` — Filter products that are one time charges
-
-
-
-
-
--
-
-**with_zero_price:** `typing.Optional[bool]` — Filter products that have zero price for free subscription type
-
-
-
-
-
--
-
-**with_prices_only:** `typing.Optional[bool]` — Filter products that have prices
-
-
-
-
-
--
-
-**is_active:** `typing.Optional[bool]` — Filter products that are active
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.billing.upsert_billing_subscription(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-from schematic import BillingSubscriptionDiscount
-import datetime
-from schematic import BillingProductPricing
-client = Schematic(api_key="YOUR_API_KEY", )
-client.billing.upsert_billing_subscription(cancel_at_period_end=True, currency='currency', customer_external_id='customer_external_id', discounts=[BillingSubscriptionDiscount(coupon_external_id='coupon_external_id', external_id='external_id', is_active=True, started_at=datetime.datetime.fromisoformat("2024-01-15 09:30:00+00:00", ), )], expired_at=datetime.datetime.fromisoformat("2024-01-15 09:30:00+00:00", ), product_external_ids=[BillingProductPricing(currency='currency', interval='interval', price=1, price_external_id='price_external_id', product_external_id='product_external_id', quantity=1, usage_type="licensed", )], subscription_external_id='subscription_external_id', total_price=1, )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**cancel_at_period_end:** `bool`
-
-
-
-
-
--
-
-**currency:** `str`
-
-
-
-
-
--
-
-**customer_external_id:** `str`
-
-
-
-
-
--
-
-**discounts:** `typing.Sequence[BillingSubscriptionDiscount]`
-
-
-
-
-
--
-
-**expired_at:** `dt.datetime`
-
-
-
-
-
--
-
-**product_external_ids:** `typing.Sequence[BillingProductPricing]`
-
-
-
-
-
--
-
-**subscription_external_id:** `str`
-
-
-
-
-
--
-
-**total_price:** `int`
-
-
-
-
-
--
-
-**cancel_at:** `typing.Optional[int]`
-
-
-
-
-
--
-
-**default_payment_method_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**interval:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**metadata:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]`
-
-
-
-
-
--
-
-**period_end:** `typing.Optional[int]`
-
-
-
-
-
--
-
-**period_start:** `typing.Optional[int]`
-
-
-
-
-
--
-
-**status:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**trial_end:** `typing.Optional[int]`
-
-
-
-
-
--
-
-**trial_end_setting:** `typing.Optional[CreateBillingSubscriptionsRequestBodyTrialEndSetting]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.checkout.internal(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-from schematic import UpdateAddOnRequestBody
-from schematic import UpdatePayInAdvanceRequestBody
-client = Schematic(api_key="YOUR_API_KEY", )
-client.checkout.internal(add_on_ids=[UpdateAddOnRequestBody(add_on_id='add_on_id', price_id='price_id', )], company_id='company_id', new_plan_id='new_plan_id', new_price_id='new_price_id', pay_in_advance=[UpdatePayInAdvanceRequestBody(price_id='price_id', quantity=1, )], )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**add_on_ids:** `typing.Sequence[UpdateAddOnRequestBody]`
-
-
-
-
-
--
-
-**company_id:** `str`
-
-
-
-
-
--
-
-**new_plan_id:** `str`
-
-
-
-
-
--
-
-**new_price_id:** `str`
-
-
-
-
-
--
-
-**pay_in_advance:** `typing.Sequence[UpdatePayInAdvanceRequestBody]`
-
-
-
-
-
--
-
-**coupon_external_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**payment_method_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**promo_code:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.checkout.get_checkout_data(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.checkout.get_checkout_data(company_id='company_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**company_id:** `str`
-
-
-
-
-
--
-
-**selected_plan_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.checkout.preview_checkout_internal(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-from schematic import UpdateAddOnRequestBody
-from schematic import UpdatePayInAdvanceRequestBody
-client = Schematic(api_key="YOUR_API_KEY", )
-client.checkout.preview_checkout_internal(add_on_ids=[UpdateAddOnRequestBody(add_on_id='add_on_id', price_id='price_id', )], company_id='company_id', new_plan_id='new_plan_id', new_price_id='new_price_id', pay_in_advance=[UpdatePayInAdvanceRequestBody(price_id='price_id', quantity=1, )], )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**add_on_ids:** `typing.Sequence[UpdateAddOnRequestBody]`
-
-
-
-
-
--
-
-**company_id:** `str`
-
-
-
-
-
--
-
-**new_plan_id:** `str`
-
-
-
-
-
--
-
-**new_price_id:** `str`
-
-
-
-
-
--
-
-**pay_in_advance:** `typing.Sequence[UpdatePayInAdvanceRequestBody]`
-
-
-
-
-
--
-
-**coupon_external_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**payment_method_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**promo_code:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.checkout.update_customer_subscription_trial_end(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.checkout.update_customer_subscription_trial_end(subscription_id='subscription_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**subscription_id:** `str` — subscription_id
-
-
-
-
-
--
-
-**trial_end:** `typing.Optional[dt.datetime]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.companies.list_companies(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.companies.list_companies()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — Filter companies by multiple company IDs (starts with comp_)
-
-
-
-
-
--
-
-**plan_id:** `typing.Optional[str]` — Filter companies by plan ID (starts with plan_)
-
-
-
-
-
--
-
-**q:** `typing.Optional[str]` — Search for companies by name, keys or string traits
-
-
-
-
-
--
-
-**without_feature_override_for:** `typing.Optional[str]` — Filter out companies that already have a company override for the specified feature ID
-
-
-
-
-
--
-
-**without_plan:** `typing.Optional[bool]` — Filter out companies that have a plan
-
-
-
-
-
--
-
-**with_subscription:** `typing.Optional[bool]` — Filter companies that have a subscription
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.companies.upsert_company(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.companies.upsert_company(keys={'key': 'value'}, )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**keys:** `typing.Dict[str, str]` — See [Key Management](https://docs.schematichq.com/developer_resources/key_management) for more information
-
-
-
-
-
--
-
-**id:** `typing.Optional[str]` — If you know the Schematic ID, you can use that here instead of keys
-
-
-
-
-
--
-
-**last_seen_at:** `typing.Optional[dt.datetime]`
-
-
-
-
-
--
-
-**name:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**traits:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A map of trait names to trait values
-
-
-
-
-
--
-
-**update_only:** `typing.Optional[bool]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.companies.get_company(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.companies.get_company(company_id='company_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**company_id:** `str` — company_id
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.companies.delete_company(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.companies.delete_company(company_id='company_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**company_id:** `str` — company_id
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.companies.count_companies(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.companies.count_companies()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — Filter companies by multiple company IDs (starts with comp_)
-
-
-
-
-
--
-
-**plan_id:** `typing.Optional[str]` — Filter companies by plan ID (starts with plan_)
-
-
-
-
-
--
-
-**q:** `typing.Optional[str]` — Search for companies by name, keys or string traits
-
-
-
-
-
--
-
-**without_feature_override_for:** `typing.Optional[str]` — Filter out companies that already have a company override for the specified feature ID
-
-
-
-
-
--
-
-**without_plan:** `typing.Optional[bool]` — Filter out companies that have a plan
-
-
-
-
-
--
-
-**with_subscription:** `typing.Optional[bool]` — Filter companies that have a subscription
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.companies.create_company(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.companies.create_company(keys={'key': 'value'}, )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**keys:** `typing.Dict[str, str]` — See [Key Management](https://docs.schematichq.com/developer_resources/key_management) for more information
-
-
-
-
-
--
-
-**id:** `typing.Optional[str]` — If you know the Schematic ID, you can use that here instead of keys
-
-
-
-
-
--
-
-**last_seen_at:** `typing.Optional[dt.datetime]`
-
-
-
-
-
--
-
-**name:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**traits:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A map of trait names to trait values
-
-
-
-
-
--
-
-**update_only:** `typing.Optional[bool]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.companies.delete_company_by_keys(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.companies.delete_company_by_keys(keys={'key': 'value'}, )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**keys:** `typing.Dict[str, str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.companies.lookup_company(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.companies.lookup_company(keys={'keys': 'keys'}, )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**keys:** `typing.Dict[str, str]` — Key/value pairs
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.companies.get_active_deals(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.companies.get_active_deals(company_id='company_id', deal_stage='deal_stage', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**company_id:** `str`
-
-
-
-
-
--
-
-**deal_stage:** `str`
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.companies.list_company_memberships(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.companies.list_company_memberships()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**company_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**user_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.companies.get_or_create_company_membership(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.companies.get_or_create_company_membership(company_id='company_id', user_id='user_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**company_id:** `str`
-
-
-
-
-
--
-
-**user_id:** `str`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.companies.delete_company_membership(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.companies.delete_company_membership(company_membership_id='company_membership_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**company_membership_id:** `str` — company_membership_id
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.companies.get_active_company_subscription(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.companies.get_active_company_subscription()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**company_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**company_ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]`
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.companies.upsert_company_trait(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.companies.upsert_company_trait(keys={'key': 'value'}, trait='trait', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**keys:** `typing.Dict[str, str]` — Key/value pairs to identify a company or user
-
-
-
-
-
--
-
-**trait:** `str` — Name of the trait to update
-
-
-
-
-
--
-
-**incr:** `typing.Optional[int]` — Amount to increment the trait by (positive or negative)
-
-
-
-
-
--
-
-**set_:** `typing.Optional[str]` — Value to set the trait to
-
-
-
-
-
--
-
-**update_only:** `typing.Optional[bool]` — Unless this is set, the company or user will be created if it does not already exist
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.companies.list_entity_key_definitions(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.companies.list_entity_key_definitions()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**entity_type:** `typing.Optional[ListEntityKeyDefinitionsRequestEntityType]`
-
-
-
-
-
--
-
-**ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]`
-
-
-
-
-
--
-
-**q:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.companies.count_entity_key_definitions(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.companies.count_entity_key_definitions()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**entity_type:** `typing.Optional[CountEntityKeyDefinitionsRequestEntityType]`
-
-
-
-
-
--
-
-**ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]`
-
-
-
-
-
--
-
-**q:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.companies.list_entity_trait_definitions(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.companies.list_entity_trait_definitions()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**entity_type:** `typing.Optional[ListEntityTraitDefinitionsRequestEntityType]`
-
-
-
-
-
--
-
-**ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]`
-
-
-
-
-
--
-
-**q:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**trait_type:** `typing.Optional[ListEntityTraitDefinitionsRequestTraitType]`
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.companies.get_or_create_entity_trait_definition(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.companies.get_or_create_entity_trait_definition(entity_type="company", hierarchy=['hierarchy'], trait_type="boolean", )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**entity_type:** `CreateEntityTraitDefinitionRequestBodyEntityType`
-
-
-
-
-
--
-
-**hierarchy:** `typing.Sequence[str]`
-
-
-
-
-
--
-
-**trait_type:** `CreateEntityTraitDefinitionRequestBodyTraitType`
-
-
-
-
-
--
-
-**display_name:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.companies.get_entity_trait_definition(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.companies.get_entity_trait_definition(entity_trait_definition_id='entity_trait_definition_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**entity_trait_definition_id:** `str` — entity_trait_definition_id
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.companies.update_entity_trait_definition(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.companies.update_entity_trait_definition(entity_trait_definition_id='entity_trait_definition_id', trait_type="boolean", )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**entity_trait_definition_id:** `str` — entity_trait_definition_id
-
-
-
-
-
--
-
-**trait_type:** `UpdateEntityTraitDefinitionRequestBodyTraitType`
-
-
-
-
-
--
-
-**display_name:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.companies.count_entity_trait_definitions(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.companies.count_entity_trait_definitions()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**entity_type:** `typing.Optional[CountEntityTraitDefinitionsRequestEntityType]`
-
-
-
-
-
--
-
-**ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]`
-
-
-
-
-
--
-
-**q:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**trait_type:** `typing.Optional[CountEntityTraitDefinitionsRequestTraitType]`
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.companies.get_entity_trait_values(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.companies.get_entity_trait_values(definition_id='definition_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**definition_id:** `str`
-
-
-
-
-
--
-
-**q:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.companies.upsert_user_trait(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.companies.upsert_user_trait(keys={'key': 'value'}, trait='trait', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**keys:** `typing.Dict[str, str]` — Key/value pairs to identify a company or user
-
-
-
-
-
--
-
-**trait:** `str` — Name of the trait to update
-
-
-
-
-
--
-
-**incr:** `typing.Optional[int]` — Amount to increment the trait by (positive or negative)
-
-
-
-
-
--
-
-**set_:** `typing.Optional[str]` — Value to set the trait to
-
-
-
-
-
--
-
-**update_only:** `typing.Optional[bool]` — Unless this is set, the company or user will be created if it does not already exist
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.companies.list_users(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.companies.list_users()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**company_id:** `typing.Optional[str]` — Filter users by company ID (starts with comp_)
-
-
-
-
-
--
-
-**ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — Filter users by multiple user IDs (starts with user_)
-
-
-
-
-
--
-
-**plan_id:** `typing.Optional[str]` — Filter users by plan ID (starts with plan_)
-
-
-
-
-
--
-
-**q:** `typing.Optional[str]` — Search for users by name, keys or string traits
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.companies.upsert_user(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.companies.upsert_user(companies=[{'key': 'value'}], company={'key': 'value'}, keys={'key': 'value'}, )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**companies:** `typing.Sequence[typing.Dict[str, str]]` — Optionally specify companies using array of key/value pairs
-
-
-
-
-
--
-
-**company:** `typing.Dict[str, str]` — Add user to this company. Takes priority over companies. For exhaustive list of companies, use companies
-
-
-
-
-
--
-
-**keys:** `typing.Dict[str, str]` — See [Key Management](https://docs.schematichq.com/developer_resources/key_management) for more information
-
-
-
-
-
--
-
-**company_id:** `typing.Optional[str]` — Add user to this company. Takes priority over company_ids. For exhaustive list of companies, use company_ids
-
-
-
-
-
--
-
-**company_ids:** `typing.Optional[typing.Sequence[str]]` — Optionally specify companies using Schematic company ID
-
-
-
-
-
--
-
-**id:** `typing.Optional[str]` — If you know the Schematic ID, you can use that here instead of keys
-
-
-
-
-
--
-
-**last_seen_at:** `typing.Optional[dt.datetime]`
-
-
-
-
-
--
-
-**name:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**traits:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A map of trait names to trait values
-
-
-
-
-
--
-
-**update_only:** `typing.Optional[bool]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.companies.get_user(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.companies.get_user(user_id='user_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**user_id:** `str` — user_id
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.companies.delete_user(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.companies.delete_user(user_id='user_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**user_id:** `str` — user_id
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.companies.count_users(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.companies.count_users()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**company_id:** `typing.Optional[str]` — Filter users by company ID (starts with comp_)
-
-
-
-
-
--
-
-**ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — Filter users by multiple user IDs (starts with user_)
-
-
-
-
-
--
-
-**plan_id:** `typing.Optional[str]` — Filter users by plan ID (starts with plan_)
-
-
-
-
-
--
-
-**q:** `typing.Optional[str]` — Search for users by name, keys or string traits
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.companies.create_user(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.companies.create_user(companies=[{'key': 'value'}], company={'key': 'value'}, keys={'key': 'value'}, )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**companies:** `typing.Sequence[typing.Dict[str, str]]` — Optionally specify companies using array of key/value pairs
-
-
-
-
-
--
-
-**company:** `typing.Dict[str, str]` — Add user to this company. Takes priority over companies. For exhaustive list of companies, use companies
-
-
-
-
-
--
-
-**keys:** `typing.Dict[str, str]` — See [Key Management](https://docs.schematichq.com/developer_resources/key_management) for more information
-
-
-
-
-
--
-
-**company_id:** `typing.Optional[str]` — Add user to this company. Takes priority over company_ids. For exhaustive list of companies, use company_ids
-
-
-
-
-
--
-
-**company_ids:** `typing.Optional[typing.Sequence[str]]` — Optionally specify companies using Schematic company ID
-
-
-
-
-
--
-
-**id:** `typing.Optional[str]` — If you know the Schematic ID, you can use that here instead of keys
-
-
-
-
-
--
-
-**last_seen_at:** `typing.Optional[dt.datetime]`
-
-
-
-
-
--
-
-**name:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**traits:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A map of trait names to trait values
-
-
-
-
-
--
-
-**update_only:** `typing.Optional[bool]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.companies.delete_user_by_keys(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.companies.delete_user_by_keys(keys={'key': 'value'}, )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**keys:** `typing.Dict[str, str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.companies.lookup_user(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.companies.lookup_user(keys={'keys': 'keys'}, )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**keys:** `typing.Dict[str, str]` — Key/value pairs
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.entitlements.list_company_overrides(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.entitlements.list_company_overrides()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**company_id:** `typing.Optional[str]` — Filter company overrides by a single company ID (starting with comp_)
-
-
-
-
-
--
-
-**company_ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — Filter company overrides by multiple company IDs (starting with comp_)
-
-
-
-
-
--
-
-**feature_id:** `typing.Optional[str]` — Filter company overrides by a single feature ID (starting with feat_)
-
-
-
-
-
--
-
-**feature_ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — Filter company overrides by multiple feature IDs (starting with feat_)
-
-
-
-
-
--
-
-**ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — Filter company overrides by multiple company override IDs (starting with cmov_)
-
-
-
-
-
--
-
-**without_expired:** `typing.Optional[bool]` — Filter company overrides by whether they have not expired
-
-
-
-
-
--
-
-**q:** `typing.Optional[str]` — Search for company overrides by feature or company name
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.entitlements.create_company_override(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.entitlements.create_company_override(company_id='company_id', feature_id='feature_id', value_type="boolean", )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**company_id:** `str`
-
-
-
-
-
--
-
-**feature_id:** `str`
-
-
-
-
-
--
-
-**value_type:** `CreateCompanyOverrideRequestBodyValueType`
-
-
-
-
-
--
-
-**expiration_date:** `typing.Optional[dt.datetime]`
-
-
-
-
-
--
-
-**metric_period:** `typing.Optional[CreateCompanyOverrideRequestBodyMetricPeriod]`
-
-
-
-
-
--
-
-**metric_period_month_reset:** `typing.Optional[CreateCompanyOverrideRequestBodyMetricPeriodMonthReset]`
-
-
-
-
-
--
-
-**value_bool:** `typing.Optional[bool]`
-
-
-
-
-
--
-
-**value_numeric:** `typing.Optional[int]`
-
-
-
-
-
--
-
-**value_trait_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.entitlements.get_company_override(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.entitlements.get_company_override(company_override_id='company_override_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**company_override_id:** `str` — company_override_id
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.entitlements.update_company_override(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.entitlements.update_company_override(company_override_id='company_override_id', value_type="boolean", )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**company_override_id:** `str` — company_override_id
-
-
-
-
-
--
-
-**value_type:** `UpdateCompanyOverrideRequestBodyValueType`
-
-
-
-
-
--
-
-**expiration_date:** `typing.Optional[dt.datetime]`
-
-
-
-
-
--
-
-**metric_period:** `typing.Optional[UpdateCompanyOverrideRequestBodyMetricPeriod]`
-
-
-
-
-
--
-
-**metric_period_month_reset:** `typing.Optional[UpdateCompanyOverrideRequestBodyMetricPeriodMonthReset]`
-
-
-
-
-
--
-
-**value_bool:** `typing.Optional[bool]`
-
-
-
-
-
--
-
-**value_numeric:** `typing.Optional[int]`
-
-
-
-
-
--
-
-**value_trait_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.entitlements.delete_company_override(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.entitlements.delete_company_override(company_override_id='company_override_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**company_override_id:** `str` — company_override_id
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.entitlements.count_company_overrides(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.entitlements.count_company_overrides()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**company_id:** `typing.Optional[str]` — Filter company overrides by a single company ID (starting with comp_)
-
-
-
-
-
--
-
-**company_ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — Filter company overrides by multiple company IDs (starting with comp_)
-
-
-
-
-
--
-
-**feature_id:** `typing.Optional[str]` — Filter company overrides by a single feature ID (starting with feat_)
-
-
-
-
-
--
-
-**feature_ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — Filter company overrides by multiple feature IDs (starting with feat_)
-
-
-
-
-
--
-
-**ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — Filter company overrides by multiple company override IDs (starting with cmov_)
-
-
-
-
-
--
-
-**without_expired:** `typing.Optional[bool]` — Filter company overrides by whether they have not expired
-
-
-
-
-
--
-
-**q:** `typing.Optional[str]` — Search for company overrides by feature or company name
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.entitlements.list_feature_companies(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.entitlements.list_feature_companies(feature_id='feature_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**feature_id:** `str`
-
-
-
-
-
--
-
-**q:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.entitlements.count_feature_companies(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.entitlements.count_feature_companies(feature_id='feature_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**feature_id:** `str`
-
-
-
-
-
--
-
-**q:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.entitlements.list_feature_usage(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.entitlements.list_feature_usage()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**company_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**company_keys:** `typing.Optional[typing.Dict[str, str]]`
-
-
-
-
-
--
-
-**feature_ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]`
-
-
-
-
-
--
-
-**q:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**without_negative_entitlements:** `typing.Optional[bool]`
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.entitlements.count_feature_usage(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.entitlements.count_feature_usage()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**company_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**company_keys:** `typing.Optional[typing.Dict[str, str]]`
-
-
-
-
-
--
-
-**feature_ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]`
-
-
-
-
-
--
-
-**q:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**without_negative_entitlements:** `typing.Optional[bool]`
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.entitlements.list_feature_users(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.entitlements.list_feature_users(feature_id='feature_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**feature_id:** `str`
-
-
-
-
-
--
-
-**q:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.entitlements.count_feature_users(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.entitlements.count_feature_users(feature_id='feature_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**feature_id:** `str`
-
-
-
-
-
--
-
-**q:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.entitlements.list_plan_entitlements(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.entitlements.list_plan_entitlements()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**feature_id:** `typing.Optional[str]` — Filter plan entitlements by a single feature ID (starting with feat_)
-
-
-
-
-
--
-
-**feature_ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — Filter plan entitlements by multiple feature IDs (starting with feat_)
-
-
-
-
-
--
-
-**ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — Filter plan entitlements by multiple plan entitlement IDs (starting with pltl_)
-
-
-
-
-
--
-
-**plan_id:** `typing.Optional[str]` — Filter plan entitlements by a single plan ID (starting with plan_)
-
-
-
-
-
--
-
-**plan_ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — Filter plan entitlements by multiple plan IDs (starting with plan_)
-
-
-
-
-
--
-
-**q:** `typing.Optional[str]` — Search for plan entitlements by feature or company name
-
-
-
-
-
--
-
-**with_metered_products:** `typing.Optional[bool]` — Filter plan entitlements only with metered products
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.entitlements.create_plan_entitlement(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.entitlements.create_plan_entitlement(feature_id='feature_id', plan_id='plan_id', value_type="boolean", )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**feature_id:** `str`
-
-
-
-
-
--
-
-**plan_id:** `str`
-
-
-
-
-
--
-
-**value_type:** `CreatePlanEntitlementRequestBodyValueType`
-
-
-
-
-
--
-
-**currency:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**metric_period:** `typing.Optional[CreatePlanEntitlementRequestBodyMetricPeriod]`
-
-
-
-
-
--
-
-**metric_period_month_reset:** `typing.Optional[CreatePlanEntitlementRequestBodyMetricPeriodMonthReset]`
-
-
-
-
-
--
-
-**monthly_metered_price_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**monthly_unit_price:** `typing.Optional[int]`
-
-
-
-
-
--
-
-**monthly_unit_price_decimal:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**overage_billing_product_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**price_behavior:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**soft_limit:** `typing.Optional[int]`
-
-
-
-
-
--
-
-**value_bool:** `typing.Optional[bool]`
-
-
-
-
-
--
-
-**value_numeric:** `typing.Optional[int]`
-
-
-
-
-
--
-
-**value_trait_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**yearly_metered_price_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**yearly_unit_price:** `typing.Optional[int]`
-
-
-
-
-
--
-
-**yearly_unit_price_decimal:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.entitlements.get_plan_entitlement(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.entitlements.get_plan_entitlement(plan_entitlement_id='plan_entitlement_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**plan_entitlement_id:** `str` — plan_entitlement_id
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.entitlements.update_plan_entitlement(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.entitlements.update_plan_entitlement(plan_entitlement_id='plan_entitlement_id', value_type="boolean", )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**plan_entitlement_id:** `str` — plan_entitlement_id
-
-
-
-
-
--
-
-**value_type:** `UpdatePlanEntitlementRequestBodyValueType`
-
-
-
-
-
--
-
-**currency:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**metric_period:** `typing.Optional[UpdatePlanEntitlementRequestBodyMetricPeriod]`
-
-
-
-
-
--
-
-**metric_period_month_reset:** `typing.Optional[UpdatePlanEntitlementRequestBodyMetricPeriodMonthReset]`
-
-
-
-
-
--
-
-**monthly_metered_price_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**monthly_unit_price:** `typing.Optional[int]`
-
-
-
-
-
--
-
-**monthly_unit_price_decimal:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**overage_billing_product_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**price_behavior:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**soft_limit:** `typing.Optional[int]`
-
-
-
-
-
--
-
-**value_bool:** `typing.Optional[bool]`
-
-
-
-
-
--
-
-**value_numeric:** `typing.Optional[int]`
-
-
-
-
-
--
-
-**value_trait_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**yearly_metered_price_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**yearly_unit_price:** `typing.Optional[int]`
-
-
-
-
-
--
-
-**yearly_unit_price_decimal:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.entitlements.delete_plan_entitlement(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.entitlements.delete_plan_entitlement(plan_entitlement_id='plan_entitlement_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**plan_entitlement_id:** `str` — plan_entitlement_id
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.entitlements.count_plan_entitlements(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.entitlements.count_plan_entitlements()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**feature_id:** `typing.Optional[str]` — Filter plan entitlements by a single feature ID (starting with feat_)
-
-
-
-
-
--
-
-**feature_ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — Filter plan entitlements by multiple feature IDs (starting with feat_)
-
-
-
-
-
--
-
-**ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — Filter plan entitlements by multiple plan entitlement IDs (starting with pltl_)
-
-
-
-
-
--
-
-**plan_id:** `typing.Optional[str]` — Filter plan entitlements by a single plan ID (starting with plan_)
-
-
-
-
-
--
-
-**plan_ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — Filter plan entitlements by multiple plan IDs (starting with plan_)
-
-
-
-
-
--
-
-**q:** `typing.Optional[str]` — Search for plan entitlements by feature or company name
-
-
-
-
-
--
-
-**with_metered_products:** `typing.Optional[bool]` — Filter plan entitlements only with metered products
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.entitlements.get_feature_usage_by_company(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.entitlements.get_feature_usage_by_company(keys={'keys': 'keys'}, )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**keys:** `typing.Dict[str, str]` — Key/value pairs
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.plans.update_company_plans(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.plans.update_company_plans(company_plan_id='company_plan_id', add_on_ids=['add_on_ids'], )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**company_plan_id:** `str` — company_plan_id
-
-
-
-
-
--
-
-**add_on_ids:** `typing.Sequence[str]`
-
-
-
-
-
--
-
-**base_plan_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.plans.get_audience(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.plans.get_audience(plan_audience_id='plan_audience_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**plan_audience_id:** `str` — plan_audience_id
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.plans.update_audience(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-from schematic import CreateOrUpdateConditionGroupRequestBody
-from schematic import CreateOrUpdateConditionRequestBody
-client = Schematic(api_key="YOUR_API_KEY", )
-client.plans.update_audience(plan_audience_id='plan_audience_id', condition_groups=[CreateOrUpdateConditionGroupRequestBody(conditions=[CreateOrUpdateConditionRequestBody(condition_type="company", operator="eq", resource_ids=['resource_ids'], )], )], conditions=[CreateOrUpdateConditionRequestBody(condition_type="company", operator="eq", resource_ids=['resource_ids'], )], )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**plan_audience_id:** `str` — plan_audience_id
-
-
-
-
-
--
-
-**condition_groups:** `typing.Sequence[CreateOrUpdateConditionGroupRequestBody]`
-
-
-
-
-
--
-
-**conditions:** `typing.Sequence[CreateOrUpdateConditionRequestBody]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.plans.delete_audience(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.plans.delete_audience(plan_audience_id='plan_audience_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**plan_audience_id:** `str` — plan_audience_id
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.plans.list_plan_traits(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.plans.list_plan_traits()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]`
-
-
-
-
-
--
-
-**plan_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**trait_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.plans.create_plan_trait(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.plans.create_plan_trait(plan_id='plan_id', trait_id='trait_id', trait_value='trait_value', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**plan_id:** `str`
-
-
-
-
-
--
-
-**trait_id:** `str`
-
-
-
-
-
--
-
-**trait_value:** `str`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.plans.get_plan_trait(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.plans.get_plan_trait(plan_trait_id='plan_trait_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**plan_trait_id:** `str` — plan_trait_id
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.plans.update_plan_trait(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.plans.update_plan_trait(plan_trait_id='plan_trait_id', plan_id='plan_id', trait_value='trait_value', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**plan_trait_id:** `str` — plan_trait_id
-
-
-
-
-
--
-
-**plan_id:** `str`
-
-
-
-
-
--
-
-**trait_value:** `str`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.plans.delete_plan_trait(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.plans.delete_plan_trait(plan_trait_id='plan_trait_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**plan_trait_id:** `str` — plan_trait_id
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.plans.count_plan_traits(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.plans.count_plan_traits()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]`
-
-
-
-
-
--
-
-**plan_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**trait_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.plans.list_plans(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.plans.list_plans()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**company_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**has_product_id:** `typing.Optional[bool]` — Filter out plans that do not have a billing product ID
-
-
-
-
-
--
-
-**ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]`
-
-
-
-
-
--
-
-**plan_type:** `typing.Optional[ListPlansRequestPlanType]` — Filter by plan type
-
-
-
-
-
--
-
-**q:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**without_entitlement_for:** `typing.Optional[str]` — Filter out plans that already have a plan entitlement for the specified feature ID
-
-
-
-
-
--
-
-**without_product_id:** `typing.Optional[bool]` — Filter out plans that have a billing product ID
-
-
-
-
-
--
-
-**without_paid_product_id:** `typing.Optional[bool]` — Filter out plans that have a paid billing product ID
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.plans.create_plan(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.plans.create_plan(description='description', name='name', plan_type="plan", )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**description:** `str`
-
-
-
-
-
--
-
-**name:** `str`
-
-
-
-
-
--
-
-**plan_type:** `CreatePlanRequestBodyPlanType`
-
-
-
-
-
--
-
-**icon:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.plans.get_plan(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.plans.get_plan(plan_id='plan_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**plan_id:** `str` — plan_id
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.plans.update_plan(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.plans.update_plan(plan_id='plan_id', name='name', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**plan_id:** `str` — plan_id
-
-
-
-
-
--
-
-**name:** `str`
-
-
-
-
-
--
-
-**description:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**icon:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.plans.delete_plan(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.plans.delete_plan(plan_id='plan_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**plan_id:** `str` — plan_id
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.plans.upsert_billing_product_plan(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.plans.upsert_billing_product_plan(plan_id='plan_id', is_free_plan=True, is_trialable=True, )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**plan_id:** `str` — plan_id
-
-
-
-
-
--
-
-**is_free_plan:** `bool`
-
-
-
-
-
--
-
-**is_trialable:** `bool`
-
-
-
-
-
--
-
-**billing_product_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**charge_type:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**monthly_price_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**one_time_price_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**trial_days:** `typing.Optional[int]`
-
-
-
-
-
--
-
-**yearly_price_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.plans.count_plans(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.plans.count_plans()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**company_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**has_product_id:** `typing.Optional[bool]` — Filter out plans that do not have a billing product ID
-
-
-
-
-
--
-
-**ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]`
-
-
-
-
-
--
-
-**plan_type:** `typing.Optional[CountPlansRequestPlanType]` — Filter by plan type
-
-
-
-
-
--
-
-**q:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**without_entitlement_for:** `typing.Optional[str]` — Filter out plans that already have a plan entitlement for the specified feature ID
-
-
-
-
-
--
-
-**without_product_id:** `typing.Optional[bool]` — Filter out plans that have a billing product ID
-
-
-
-
-
--
-
-**without_paid_product_id:** `typing.Optional[bool]` — Filter out plans that have a paid billing product ID
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.components.list_components(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.components.list_components()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**q:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.components.create_component(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.components.create_component(entity_type="entitlement", name='name', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**entity_type:** `CreateComponentRequestBodyEntityType`
-
-
-
-
-
--
-
-**name:** `str`
-
-
-
-
-
--
-
-**ast:** `typing.Optional[typing.Dict[str, float]]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.components.get_component(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.components.get_component(component_id='component_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**component_id:** `str` — component_id
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.components.update_component(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.components.update_component(component_id='component_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**component_id:** `str` — component_id
-
-
-
-
-
--
-
-**ast:** `typing.Optional[typing.Dict[str, float]]`
-
-
-
-
-
--
-
-**entity_type:** `typing.Optional[UpdateComponentRequestBodyEntityType]`
-
-
-
-
-
--
-
-**name:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**state:** `typing.Optional[UpdateComponentRequestBodyState]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.components.delete_component(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.components.delete_component(component_id='component_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**component_id:** `str` — component_id
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.components.count_components(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.components.count_components()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**q:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.components.preview_component_data(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.components.preview_component_data()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**company_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**component_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.crm.upsert_deal_line_item_association(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.crm.upsert_deal_line_item_association(deal_external_id='deal_external_id', line_item_external_id='line_item_external_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**deal_external_id:** `str`
-
-
-
-
-
--
-
-**line_item_external_id:** `str`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.crm.upsert_line_item(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.crm.upsert_line_item(amount='amount', interval='interval', line_item_external_id='line_item_external_id', product_external_id='product_external_id', quantity=1, )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**amount:** `str`
-
-
-
-
-
--
-
-**interval:** `str`
-
-
-
-
-
--
-
-**line_item_external_id:** `str`
-
-
-
-
-
--
-
-**product_external_id:** `str`
-
-
-
-
-
--
-
-**quantity:** `int`
-
-
-
-
-
--
-
-**discount_percentage:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**term_month:** `typing.Optional[int]`
-
-
-
-
-
--
-
-**total_discount:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.crm.upsert_crm_deal(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.crm.upsert_crm_deal(crm_company_key='crm_company_key', crm_type='crm_type', deal_external_id='deal_external_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**crm_company_key:** `str`
-
-
-
-
-
--
-
-**crm_type:** `str`
-
-
-
-
-
--
-
-**deal_external_id:** `str`
-
-
-
-
-
--
-
-**arr:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**crm_company_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**crm_product_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**deal_name:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**deal_stage:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**mrr:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.crm.list_crm_products(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.crm.list_crm_products()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]`
-
-
-
-
-
--
-
-**name:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.crm.upsert_crm_product(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.crm.upsert_crm_product(currency='currency', description='description', external_id='external_id', interval='interval', name='name', price='price', quantity=1, sku='sku', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**currency:** `str`
-
-
-
-
-
--
-
-**description:** `str`
-
-
-
-
-
--
-
-**external_id:** `str`
-
-
-
-
-
--
-
-**interval:** `str`
-
-
-
-
-
--
-
-**name:** `str`
-
-
-
-
-
--
-
-**price:** `str`
-
-
-
-
-
--
-
-**quantity:** `int`
-
-
-
-
-
--
-
-**sku:** `str`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.dataexports.create_data_export(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.dataexports.create_data_export(metadata='metadata', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**metadata:** `str`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.events.create_event_batch(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-from schematic import CreateEventRequestBody
-client = Schematic(api_key="YOUR_API_KEY", )
-client.events.create_event_batch(events=[CreateEventRequestBody(event_type="identify", )], )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**events:** `typing.Sequence[CreateEventRequestBody]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.events.get_event_summaries(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.events.get_event_summaries()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**q:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**event_subtypes:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]`
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.events.list_events(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.events.list_events()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**company_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**event_subtype:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**event_types:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]`
-
-
-
-
-
--
-
-**flag_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**user_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.events.create_event(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.events.create_event(event_type="identify", )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**event_type:** `CreateEventRequestBodyEventType` — Either 'identify' or 'track'
-
-
-
-
-
--
-
-**body:** `typing.Optional[EventBody]`
-
-
-
-
-
--
-
-**sent_at:** `typing.Optional[dt.datetime]` — Optionally provide a timestamp at which the event was sent to Schematic
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.events.get_event(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.events.get_event(event_id='event_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**event_id:** `str` — event_id
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.events.get_segment_integration_status()
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.events.get_segment_integration_status()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.plangroups.get_plan_group()
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.plangroups.get_plan_group()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.plangroups.create_plan_group(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-from schematic import OrderedPlansInGroup
-client = Schematic(api_key="YOUR_API_KEY", )
-client.plangroups.create_plan_group(add_on_ids=['add_on_ids'], ordered_plans=[OrderedPlansInGroup(plan_id='plan_id', )], )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**add_on_ids:** `typing.Sequence[str]`
-
-
-
-
-
--
-
-**ordered_plans:** `typing.Sequence[OrderedPlansInGroup]`
-
-
-
-
-
--
-
-**custom_plan_config:** `typing.Optional[CustomPlanConfig]`
-
-
-
-
-
--
-
-**custom_plan_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**default_plan_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**trial_days:** `typing.Optional[int]`
-
-
-
-
-
--
-
-**trial_payment_method_required:** `typing.Optional[bool]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.plangroups.update_plan_group(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-from schematic import OrderedPlansInGroup
-client = Schematic(api_key="YOUR_API_KEY", )
-client.plangroups.update_plan_group(plan_group_id='plan_group_id', add_on_ids=['add_on_ids'], ordered_plans=[OrderedPlansInGroup(plan_id='plan_id', )], )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**plan_group_id:** `str` — plan_group_id
-
-
-
-
-
--
-
-**add_on_ids:** `typing.Sequence[str]`
-
-
-
-
-
--
-
-**ordered_plans:** `typing.Sequence[OrderedPlansInGroup]`
-
-
-
-
-
--
-
-**custom_plan_config:** `typing.Optional[CustomPlanConfig]`
-
-
-
-
-
--
-
-**custom_plan_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**default_plan_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**trial_days:** `typing.Optional[int]`
-
-
-
-
-
--
-
-**trial_payment_method_required:** `typing.Optional[bool]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.accesstokens.issue_temporary_access_token(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.accesstokens.issue_temporary_access_token(lookup={'key': 'value'}, resource_type='resource_type', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**lookup:** `typing.Dict[str, str]`
-
-
-
-
-
--
-
-**resource_type:** `str`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.webhooks.list_webhook_events(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.webhooks.list_webhook_events()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]`
-
-
-
-
-
--
-
-**q:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**webhook_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.webhooks.get_webhook_event(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.webhooks.get_webhook_event(webhook_event_id='webhook_event_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**webhook_event_id:** `str` — webhook_event_id
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.webhooks.count_webhook_events(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.webhooks.count_webhook_events()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]`
-
-
-
-
-
--
-
-**q:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**webhook_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.webhooks.list_webhooks(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.webhooks.list_webhooks()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**q:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.webhooks.create_webhook(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.webhooks.create_webhook(name='name', request_types=["company.updated"], url='url', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**name:** `str`
-
-
-
-
-
--
-
-**request_types:** `typing.Sequence[CreateWebhookRequestBodyRequestTypesItem]`
-
-
-
-
-
--
-
-**url:** `str`
-
-
-
-
-
--
-
-**entitlement_trigger_configs:** `typing.Optional[typing.Sequence[EntitlementTriggerConfig]]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.webhooks.get_webhook(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.webhooks.get_webhook(webhook_id='webhook_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**webhook_id:** `str` — webhook_id
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.webhooks.update_webhook(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.webhooks.update_webhook(webhook_id='webhook_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**webhook_id:** `str` — webhook_id
-
-
-
-
-
--
-
-**entitlement_trigger_configs:** `typing.Optional[typing.Sequence[EntitlementTriggerConfig]]`
-
-
-
-
-
--
-
-**name:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_types:** `typing.Optional[typing.Sequence[UpdateWebhookRequestBodyRequestTypesItem]]`
-
-
-
-
-
--
-
-**status:** `typing.Optional[UpdateWebhookRequestBodyStatus]`
-
-
-
-
-
--
-
-**url:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.webhooks.delete_webhook(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.webhooks.delete_webhook(webhook_id='webhook_id', )
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**webhook_id:** `str` — webhook_id
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.webhooks.count_webhooks(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from schematic import Schematic
-client = Schematic(api_key="YOUR_API_KEY", )
-client.webhooks.count_webhooks()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**q:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Page limit (default 100)
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Page offset (default 0)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-