boltix 0.0.1__py3-none-any.whl

boltix/README.md

@@ -0,0 +1,190 @@
+# Boltix Python Library
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=Boltix%2FPython)
+[![pypi](https://img.shields.io/pypi/v/boltix)](https://pypi.python.org/pypi/boltix)
+
+The Boltix Python library provides convenient access to the Boltix APIs from Python.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Reference](#reference)
+- [Usage](#usage)
+- [Environments](#environments)
+- [Async Client](#async-client)
+- [Exception Handling](#exception-handling)
+- [Advanced](#advanced)
+  - [Access Raw Response Data](#access-raw-response-data)
+  - [Retries](#retries)
+  - [Timeouts](#timeouts)
+  - [Custom Client](#custom-client)
+- [Contributing](#contributing)
+
+## Installation
+
+```sh
+pip install boltix
+```
+
+## Reference
+
+A full reference for this library is available [here](./reference.md).
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```python
+from boltix import BoltixApi
+
+client = BoltixApi(
+    token="<token>",
+)
+
+client.identity.create_account(
+    email="email",
+    password="password",
+)
+```
+
+## Environments
+
+This SDK allows you to configure different environments for API requests.
+
+```python
+from boltix import BoltixApi
+from boltix.environment import BoltixApiEnvironment
+
+client = BoltixApi(
+    environment=BoltixApiEnvironment.PRODUCTION,
+)
+```
+
+## Async Client
+
+The SDK also exports an `async` client so that you can make non-blocking calls to our API. Note that if you are constructing an Async httpx client class to pass into this client, use `httpx.AsyncClient()` instead of `httpx.Client()` (e.g. for the `httpx_client` parameter of this client).
+
+```python
+import asyncio
+
+from boltix import AsyncBoltixApi
+
+client = AsyncBoltixApi(
+    token="<token>",
+)
+
+
+async def main() -> None:
+    await client.identity.create_account(
+        email="email",
+        password="password",
+    )
+
+
+asyncio.run(main())
+```
+
+## Exception Handling
+
+When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
+will be thrown.
+
+```python
+from boltix.core.api_error import ApiError
+
+try:
+    client.identity.create_account(...)
+except ApiError as e:
+    print(e.status_code)
+    print(e.body)
+```
+
+## Advanced
+
+### Access Raw Response Data
+
+The SDK provides access to raw response data, including headers, through the `.with_raw_response` property.
+The `.with_raw_response` property returns a "raw" client that can be used to access the `.headers` and `.data` attributes.
+
+```python
+from boltix import BoltixApi
+
+client = BoltixApi(...)
+response = client.identity.with_raw_response.create_account(...)
+print(response.headers)  # access the response headers
+print(response.status_code)  # access the response status code
+print(response.data)  # access the underlying object
+```
+
+### Retries
+
+The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
+as the request is deemed retryable and the number of retry attempts has not grown larger than the configured
+retry limit (default: 2).
+
+Which status codes are retried depends on the `retryStatusCodes` generator configuration:
+
+**`legacy`** (current default): retries on
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [409](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/409) (Conflict)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status#server_error_responses) (All server errors, including 500)
+
+**`recommended`**: retries on
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [409](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/409) (Conflict)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [502](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/502) (Bad Gateway)
+- [503](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/503) (Service Unavailable)
+- [504](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/504) (Gateway Timeout)
+
+Use the `max_retries` request option to configure this behavior.
+
+```python
+client.identity.create_account(..., request_options={
+    "max_retries": 1
+})
+```
+
+### Timeouts
+
+The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.
+
+```python
+from boltix import BoltixApi
+
+client = BoltixApi(..., timeout=20.0)
+
+# Override timeout for a specific method
+client.identity.create_account(..., request_options={
+    "timeout_in_seconds": 1
+})
+```
+
+### Custom Client
+
+You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies
+and transports.
+
+```python
+import httpx
+from boltix import BoltixApi
+
+client = BoltixApi(
+    ...,
+    httpx_client=httpx.Client(
+        proxy="http://my.test.proxy.example.com",
+        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
+    ),
+)
+```
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically.
+Additions made directly to this library would have to be moved over to our generation code,
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!

boltix/__init__.py

@@ -0,0 +1,347 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+import typing
+from importlib import import_module
+
+if typing.TYPE_CHECKING:
+    from .types import (
+        ActionResponse,
+        AddRecipientsOutputBody,
+        AgentResponse,
+        AutomationConfigResponse,
+        AutomationTriggerResponse,
+        AutomationWorkflowResponse,
+        CampaignResponse,
+        ChannelResponse,
+        ChannelResponseStatus,
+        ChartDataPointResponse,
+        ContactResponse,
+        CreateDownloadUrlOutputBody,
+        CreateUploadUrlOutputBody,
+        ErrorDetail,
+        ErrorModel,
+        EventResponse,
+        HandoffResponse,
+        IdentityAccountResponse,
+        IntelligenceContextResponse,
+        IntelligenceContextResponseContextType,
+        ListAccountsOutputBody,
+        ListActionsOutputBody,
+        ListAgentsOutputBody,
+        ListCampaignsOutputBody,
+        ListChannelsOutputBody,
+        ListContactsOutputBody,
+        ListContextsOutputBody,
+        ListEventsOutputBody,
+        ListHandoffsOutputBody,
+        ListMessagesOutputBody,
+        ListOrganizationsOutputBody,
+        ListPanelsOutputBody,
+        ListProductsOutputBody,
+        ListRecipientsOutputBody,
+        ListSnippetsOutputBody,
+        ListStoresOutputBody,
+        ListTagsOutputBody,
+        ListTeamsOutputBody,
+        ListTemplatesOutputBody,
+        ListTriggersOutputBody,
+        ListWebhooksOutputBody,
+        ListWorkflowsOutputBody,
+        LoginOutputBody,
+        MessageResponse,
+        OrganizationResponse,
+        PanelDataResponse,
+        PanelFilterInput,
+        PanelFilterInputOperator,
+        PanelFilterResponse,
+        PanelResponse,
+        ProductResponse,
+        RecipientInput,
+        RecipientResponse,
+        RefreshOutputBody,
+        RegisterOutputBody,
+        SnippetResponse,
+        StoreResponse,
+        TagResponse,
+        TeamResponse,
+        TemplateResponse,
+        WebhookResponse,
+    )
+    from . import (
+        audit,
+        auth,
+        automation,
+        campaigns,
+        catalog,
+        channels,
+        contacts,
+        identity,
+        insights,
+        intelligence,
+        media,
+        messages,
+        organizations,
+        routing,
+        snippets,
+        tags,
+        templates,
+        webhooks,
+    )
+    from ._default_clients import DefaultAioHttpClient, DefaultAsyncHttpxClient
+    from .automation import CreateTriggerInputBodyMatchType, UpdateTriggerInputBodyMatchType
+    from .channels import UpdateChannelInputBodyStatus
+    from .client import AsyncBoltixApi, BoltixApi
+    from .environment import BoltixApiEnvironment
+    from .insights import (
+        CreatePanelInputBodyDataSource,
+        CreatePanelInputBodyDisplayType,
+        CreatePanelInputBodyMetric,
+        CreatePanelInputBodySize,
+        UpdatePanelInputBodyDataSource,
+        UpdatePanelInputBodyDisplayType,
+        UpdatePanelInputBodyMetric,
+        UpdatePanelInputBodySize,
+    )
+    from .intelligence import CreateContextInputBodyContextType, UpdateContextInputBodyContextType
+    from .routing import (
+        AddAgentInputBodyRole,
+        CreateHandoffInputBodySource,
+        CreateTeamInputBodyAssignmentStrategy,
+        UpdateTeamInputBodyAssignmentStrategy,
+    )
+    from .tags import CreateTagInputBodyColor, UpdateTagInputBodyColor
+_dynamic_imports: typing.Dict[str, str] = {
+    "ActionResponse": ".types",
+    "AddAgentInputBodyRole": ".routing",
+    "AddRecipientsOutputBody": ".types",
+    "AgentResponse": ".types",
+    "AsyncBoltixApi": ".client",
+    "AutomationConfigResponse": ".types",
+    "AutomationTriggerResponse": ".types",
+    "AutomationWorkflowResponse": ".types",
+    "BoltixApi": ".client",
+    "BoltixApiEnvironment": ".environment",
+    "CampaignResponse": ".types",
+    "ChannelResponse": ".types",
+    "ChannelResponseStatus": ".types",
+    "ChartDataPointResponse": ".types",
+    "ContactResponse": ".types",
+    "CreateContextInputBodyContextType": ".intelligence",
+    "CreateDownloadUrlOutputBody": ".types",
+    "CreateHandoffInputBodySource": ".routing",
+    "CreatePanelInputBodyDataSource": ".insights",
+    "CreatePanelInputBodyDisplayType": ".insights",
+    "CreatePanelInputBodyMetric": ".insights",
+    "CreatePanelInputBodySize": ".insights",
+    "CreateTagInputBodyColor": ".tags",
+    "CreateTeamInputBodyAssignmentStrategy": ".routing",
+    "CreateTriggerInputBodyMatchType": ".automation",
+    "CreateUploadUrlOutputBody": ".types",
+    "DefaultAioHttpClient": "._default_clients",
+    "DefaultAsyncHttpxClient": "._default_clients",
+    "ErrorDetail": ".types",
+    "ErrorModel": ".types",
+    "EventResponse": ".types",
+    "HandoffResponse": ".types",
+    "IdentityAccountResponse": ".types",
+    "IntelligenceContextResponse": ".types",
+    "IntelligenceContextResponseContextType": ".types",
+    "ListAccountsOutputBody": ".types",
+    "ListActionsOutputBody": ".types",
+    "ListAgentsOutputBody": ".types",
+    "ListCampaignsOutputBody": ".types",
+    "ListChannelsOutputBody": ".types",
+    "ListContactsOutputBody": ".types",
+    "ListContextsOutputBody": ".types",
+    "ListEventsOutputBody": ".types",
+    "ListHandoffsOutputBody": ".types",
+    "ListMessagesOutputBody": ".types",
+    "ListOrganizationsOutputBody": ".types",
+    "ListPanelsOutputBody": ".types",
+    "ListProductsOutputBody": ".types",
+    "ListRecipientsOutputBody": ".types",
+    "ListSnippetsOutputBody": ".types",
+    "ListStoresOutputBody": ".types",
+    "ListTagsOutputBody": ".types",
+    "ListTeamsOutputBody": ".types",
+    "ListTemplatesOutputBody": ".types",
+    "ListTriggersOutputBody": ".types",
+    "ListWebhooksOutputBody": ".types",
+    "ListWorkflowsOutputBody": ".types",
+    "LoginOutputBody": ".types",
+    "MessageResponse": ".types",
+    "OrganizationResponse": ".types",
+    "PanelDataResponse": ".types",
+    "PanelFilterInput": ".types",
+    "PanelFilterInputOperator": ".types",
+    "PanelFilterResponse": ".types",
+    "PanelResponse": ".types",
+    "ProductResponse": ".types",
+    "RecipientInput": ".types",
+    "RecipientResponse": ".types",
+    "RefreshOutputBody": ".types",
+    "RegisterOutputBody": ".types",
+    "SnippetResponse": ".types",
+    "StoreResponse": ".types",
+    "TagResponse": ".types",
+    "TeamResponse": ".types",
+    "TemplateResponse": ".types",
+    "UpdateChannelInputBodyStatus": ".channels",
+    "UpdateContextInputBodyContextType": ".intelligence",
+    "UpdatePanelInputBodyDataSource": ".insights",
+    "UpdatePanelInputBodyDisplayType": ".insights",
+    "UpdatePanelInputBodyMetric": ".insights",
+    "UpdatePanelInputBodySize": ".insights",
+    "UpdateTagInputBodyColor": ".tags",
+    "UpdateTeamInputBodyAssignmentStrategy": ".routing",
+    "UpdateTriggerInputBodyMatchType": ".automation",
+    "WebhookResponse": ".types",
+    "audit": ".audit",
+    "auth": ".auth",
+    "automation": ".automation",
+    "campaigns": ".campaigns",
+    "catalog": ".catalog",
+    "channels": ".channels",
+    "contacts": ".contacts",
+    "identity": ".identity",
+    "insights": ".insights",
+    "intelligence": ".intelligence",
+    "media": ".media",
+    "messages": ".messages",
+    "organizations": ".organizations",
+    "routing": ".routing",
+    "snippets": ".snippets",
+    "tags": ".tags",
+    "templates": ".templates",
+    "webhooks": ".webhooks",
+}
+
+
+def __getattr__(attr_name: str) -> typing.Any:
+    module_name = _dynamic_imports.get(attr_name)
+    if module_name is None:
+        raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}")
+    try:
+        module = import_module(module_name, __package__)
+        if module_name == f".{attr_name}":
+            return module
+        else:
+            return getattr(module, attr_name)
+    except ImportError as e:
+        raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e
+    except AttributeError as e:
+        raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e
+
+
+def __dir__():
+    lazy_attrs = list(_dynamic_imports.keys())
+    return sorted(lazy_attrs)
+
+
+__all__ = [
+    "ActionResponse",
+    "AddAgentInputBodyRole",
+    "AddRecipientsOutputBody",
+    "AgentResponse",
+    "AsyncBoltixApi",
+    "AutomationConfigResponse",
+    "AutomationTriggerResponse",
+    "AutomationWorkflowResponse",
+    "BoltixApi",
+    "BoltixApiEnvironment",
+    "CampaignResponse",
+    "ChannelResponse",
+    "ChannelResponseStatus",
+    "ChartDataPointResponse",
+    "ContactResponse",
+    "CreateContextInputBodyContextType",
+    "CreateDownloadUrlOutputBody",
+    "CreateHandoffInputBodySource",
+    "CreatePanelInputBodyDataSource",
+    "CreatePanelInputBodyDisplayType",
+    "CreatePanelInputBodyMetric",
+    "CreatePanelInputBodySize",
+    "CreateTagInputBodyColor",
+    "CreateTeamInputBodyAssignmentStrategy",
+    "CreateTriggerInputBodyMatchType",
+    "CreateUploadUrlOutputBody",
+    "DefaultAioHttpClient",
+    "DefaultAsyncHttpxClient",
+    "ErrorDetail",
+    "ErrorModel",
+    "EventResponse",
+    "HandoffResponse",
+    "IdentityAccountResponse",
+    "IntelligenceContextResponse",
+    "IntelligenceContextResponseContextType",
+    "ListAccountsOutputBody",
+    "ListActionsOutputBody",
+    "ListAgentsOutputBody",
+    "ListCampaignsOutputBody",
+    "ListChannelsOutputBody",
+    "ListContactsOutputBody",
+    "ListContextsOutputBody",
+    "ListEventsOutputBody",
+    "ListHandoffsOutputBody",
+    "ListMessagesOutputBody",
+    "ListOrganizationsOutputBody",
+    "ListPanelsOutputBody",
+    "ListProductsOutputBody",
+    "ListRecipientsOutputBody",
+    "ListSnippetsOutputBody",
+    "ListStoresOutputBody",
+    "ListTagsOutputBody",
+    "ListTeamsOutputBody",
+    "ListTemplatesOutputBody",
+    "ListTriggersOutputBody",
+    "ListWebhooksOutputBody",
+    "ListWorkflowsOutputBody",
+    "LoginOutputBody",
+    "MessageResponse",
+    "OrganizationResponse",
+    "PanelDataResponse",
+    "PanelFilterInput",
+    "PanelFilterInputOperator",
+    "PanelFilterResponse",
+    "PanelResponse",
+    "ProductResponse",
+    "RecipientInput",
+    "RecipientResponse",
+    "RefreshOutputBody",
+    "RegisterOutputBody",
+    "SnippetResponse",
+    "StoreResponse",
+    "TagResponse",
+    "TeamResponse",
+    "TemplateResponse",
+    "UpdateChannelInputBodyStatus",
+    "UpdateContextInputBodyContextType",
+    "UpdatePanelInputBodyDataSource",
+    "UpdatePanelInputBodyDisplayType",
+    "UpdatePanelInputBodyMetric",
+    "UpdatePanelInputBodySize",
+    "UpdateTagInputBodyColor",
+    "UpdateTeamInputBodyAssignmentStrategy",
+    "UpdateTriggerInputBodyMatchType",
+    "WebhookResponse",
+    "audit",
+    "auth",
+    "automation",
+    "campaigns",
+    "catalog",
+    "channels",
+    "contacts",
+    "identity",
+    "insights",
+    "intelligence",
+    "media",
+    "messages",
+    "organizations",
+    "routing",
+    "snippets",
+    "tags",
+    "templates",
+    "webhooks",
+]

boltix/_default_clients.py

@@ -0,0 +1,30 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import httpx
+
+SDK_DEFAULT_TIMEOUT = 60
+
+try:
+    import httpx_aiohttp  # type: ignore[import-not-found]
+except ImportError:
+
+    class DefaultAioHttpClient(httpx.AsyncClient):  # type: ignore
+        def __init__(self, **kwargs: typing.Any) -> None:
+            raise RuntimeError("To use the aiohttp client, install the aiohttp extra: pip install package[aiohttp]")
+
+else:
+
+    class DefaultAioHttpClient(httpx_aiohttp.HttpxAiohttpClient):  # type: ignore
+        def __init__(self, **kwargs: typing.Any) -> None:
+            kwargs.setdefault("timeout", SDK_DEFAULT_TIMEOUT)
+            kwargs.setdefault("follow_redirects", True)
+            super().__init__(**kwargs)
+
+
+class DefaultAsyncHttpxClient(httpx.AsyncClient):
+    def __init__(self, **kwargs: typing.Any) -> None:
+        kwargs.setdefault("timeout", SDK_DEFAULT_TIMEOUT)
+        kwargs.setdefault("follow_redirects", True)
+        super().__init__(**kwargs)

boltix/audit/__init__.py

@@ -0,0 +1,4 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+