informly 0.1.0__tar.gz

informly-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Informly
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

informly-0.1.0/PKG-INFO

@@ -0,0 +1,12 @@
+Metadata-Version: 2.4
+Name: informly
+Version: 0.1.0
+Summary: Official Informly API client for Python
+License-Expression: MIT
+Requires-Python: >=3.10
+License-File: LICENSE
+Requires-Dist: httpx>=0.21.2
+Requires-Dist: pydantic>=2.0
+Requires-Dist: pydantic-core>=2.18.2
+Requires-Dist: typing_extensions>=4.0.0
+Dynamic: license-file

informly-0.1.0/README.md

@@ -0,0 +1,164 @@
+# Informly 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=Informly%2FPython)
+[![pypi](https://img.shields.io/pypi/v/informly-sdk)](https://pypi.python.org/pypi/informly-sdk)
+
+The Informly Python library provides convenient access to the Informly APIs from Python.
+
+## Table of Contents
+
+- [Documentation](#documentation)
+- [Installation](#installation)
+- [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)
+
+## Documentation
+
+API reference documentation is available [here](https://docs.informly.com/docs/api-reference).
+
+## Installation
+
+```sh
+pip install informly-sdk
+```
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```python
+from informly-sdk import Informly
+
+client = Informly(
+    token="<token>",
+)
+
+client.contacts.create_contact()
+```
+
+## Environments
+
+This SDK allows you to configure different environments for API requests.
+
+```python
+from informly-sdk import Informly
+from informly-sdk.environment import InformlyEnvironment
+
+client = Informly(
+    environment=InformlyEnvironment.DEFAULT,
+)
+```
+
+## 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 informly-sdk import AsyncInformly
+
+client = AsyncInformly(
+    token="<token>",
+)
+
+
+async def main() -> None:
+    await client.contacts.create_contact()
+
+
+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 informly-sdk.core.api_error import ApiError
+
+try:
+    client.contacts.create_contact(...)
+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 informly-sdk import Informly
+
+client = Informly(...)
+response = client.contacts.with_raw_response.create_contact(...)
+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).
+
+A request is deemed retryable when any of the following HTTP status codes is returned:
+
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [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/500) (Internal Server Errors)
+
+Use the `max_retries` request option to configure this behavior.
+
+```python
+client.contacts.create_contact(..., 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 informly-sdk import Informly
+
+client = Informly(..., timeout=20.0)
+
+# Override timeout for a specific method
+client.contacts.create_contact(..., 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 informly-sdk import Informly
+
+client = Informly(
+    ...,
+    httpx_client=httpx.Client(
+        proxy="http://my.test.proxy.example.com",
+        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
+    ),
+)
+```
+

informly-0.1.0/pyproject.toml

@@ -0,0 +1,19 @@
+[project]
+name = "informly"
+version = "0.1.0"
+description = "Official Informly API client for Python"
+license = "MIT"
+requires-python = ">=3.10"
+dependencies = [
+    "httpx >= 0.21.2",
+    "pydantic >= 2.0",
+    "pydantic-core >= 2.18.2",
+    "typing_extensions >= 4.0.0",
+]
+
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+where = ["src"]

informly-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

informly-0.1.0/src/informly/__init__.py

@@ -0,0 +1,114 @@
+# 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 (
+        Contact,
+        ContactContact,
+        ContactSegmentsItem,
+        ErrorResponse,
+        ErrorResponseError,
+        ErrorResponseErrorDetailsItem,
+        PaginationMeta,
+        Segment,
+    )
+    from .errors import BadRequestError, ForbiddenError, NotFoundError, UnauthorizedError
+    from . import contacts, segments
+    from ._default_clients import DefaultAioHttpClient, DefaultAsyncHttpxClient
+    from .client import AsyncInformly, Informly
+    from .contacts import (
+        CreateContactResponse,
+        DeleteContactResponse,
+        DeleteContactsResponse,
+        DeleteContactsResponseData,
+        GetContactResponse,
+        ListContactsResponse,
+        UpdateContactResponse,
+    )
+    from .environment import InformlyEnvironment
+    from .segments import ListSegmentsResponse
+_dynamic_imports: typing.Dict[str, str] = {
+    "AsyncInformly": ".client",
+    "BadRequestError": ".errors",
+    "Contact": ".types",
+    "ContactContact": ".types",
+    "ContactSegmentsItem": ".types",
+    "CreateContactResponse": ".contacts",
+    "DefaultAioHttpClient": "._default_clients",
+    "DefaultAsyncHttpxClient": "._default_clients",
+    "DeleteContactResponse": ".contacts",
+    "DeleteContactsResponse": ".contacts",
+    "DeleteContactsResponseData": ".contacts",
+    "ErrorResponse": ".types",
+    "ErrorResponseError": ".types",
+    "ErrorResponseErrorDetailsItem": ".types",
+    "ForbiddenError": ".errors",
+    "GetContactResponse": ".contacts",
+    "Informly": ".client",
+    "InformlyEnvironment": ".environment",
+    "ListContactsResponse": ".contacts",
+    "ListSegmentsResponse": ".segments",
+    "NotFoundError": ".errors",
+    "PaginationMeta": ".types",
+    "Segment": ".types",
+    "UnauthorizedError": ".errors",
+    "UpdateContactResponse": ".contacts",
+    "contacts": ".contacts",
+    "segments": ".segments",
+}
+
+
+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__ = [
+    "AsyncInformly",
+    "BadRequestError",
+    "Contact",
+    "ContactContact",
+    "ContactSegmentsItem",
+    "CreateContactResponse",
+    "DefaultAioHttpClient",
+    "DefaultAsyncHttpxClient",
+    "DeleteContactResponse",
+    "DeleteContactsResponse",
+    "DeleteContactsResponseData",
+    "ErrorResponse",
+    "ErrorResponseError",
+    "ErrorResponseErrorDetailsItem",
+    "ForbiddenError",
+    "GetContactResponse",
+    "Informly",
+    "InformlyEnvironment",
+    "ListContactsResponse",
+    "ListSegmentsResponse",
+    "NotFoundError",
+    "PaginationMeta",
+    "Segment",
+    "UnauthorizedError",
+    "UpdateContactResponse",
+    "contacts",
+    "segments",
+]

informly-0.1.0/src/informly/_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)

informly-0.1.0/src/informly/client.py

@@ -0,0 +1,220 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+
+import typing
+
+import httpx
+from .core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from .core.logging import LogConfig, Logger
+from .environment import InformlyEnvironment
+
+if typing.TYPE_CHECKING:
+    from .contacts.client import AsyncContactsClient, ContactsClient
+    from .segments.client import AsyncSegmentsClient, SegmentsClient
+
+
+class Informly:
+    """
+    Use this class to access the different functions within the SDK. You can instantiate any number of clients with different configuration that will propagate to these functions.
+
+    Parameters
+    ----------
+    base_url : typing.Optional[str]
+        The base url to use for requests from the client.
+
+    environment : InformlyEnvironment
+        The environment to use for requests from the client. from .environment import InformlyEnvironment
+
+
+
+        Defaults to InformlyEnvironment.DEFAULT
+
+
+
+    token : typing.Union[str, typing.Callable[[], str]]
+    headers : typing.Optional[typing.Dict[str, str]]
+        Additional headers to send with every request.
+
+    timeout : typing.Optional[float]
+        The timeout to be used, in seconds, for requests. By default the timeout is 30 seconds, unless a custom httpx client is used, in which case this default is not enforced.
+
+    follow_redirects : typing.Optional[bool]
+        Whether the default httpx client follows redirects or not, this is irrelevant if a custom httpx client is passed in.
+
+    httpx_client : typing.Optional[httpx.Client]
+        The httpx client to use for making requests, a preconfigured client is used by default, however this is useful should you want to pass in any custom httpx configuration.
+
+    logging : typing.Optional[typing.Union[LogConfig, Logger]]
+        Configure logging for the SDK. Accepts a LogConfig dict with 'level' (debug/info/warn/error), 'logger' (custom logger implementation), and 'silent' (boolean, defaults to True) fields. You can also pass a pre-configured Logger instance.
+
+    Examples
+    --------
+    from informly-sdk import Informly
+
+    client = Informly(token="YOUR_TOKEN", )
+    """
+
+    def __init__(
+        self,
+        *,
+        base_url: typing.Optional[str] = None,
+        environment: InformlyEnvironment = InformlyEnvironment.DEFAULT,
+        token: typing.Union[str, typing.Callable[[], str]],
+        headers: typing.Optional[typing.Dict[str, str]] = None,
+        timeout: typing.Optional[float] = None,
+        follow_redirects: typing.Optional[bool] = True,
+        httpx_client: typing.Optional[httpx.Client] = None,
+        logging: typing.Optional[typing.Union[LogConfig, Logger]] = None,
+    ):
+        _defaulted_timeout = (
+            timeout if timeout is not None else 30 if httpx_client is None else httpx_client.timeout.read
+        )
+        self._client_wrapper = SyncClientWrapper(
+            base_url=_get_base_url(base_url=base_url, environment=environment),
+            token=token,
+            headers=headers,
+            httpx_client=httpx_client
+            if httpx_client is not None
+            else httpx.Client(timeout=_defaulted_timeout, follow_redirects=follow_redirects)
+            if follow_redirects is not None
+            else httpx.Client(timeout=_defaulted_timeout),
+            timeout=_defaulted_timeout,
+            logging=logging,
+        )
+        self._contacts: typing.Optional[ContactsClient] = None
+        self._segments: typing.Optional[SegmentsClient] = None
+
+    @property
+    def contacts(self):
+        if self._contacts is None:
+            from .contacts.client import ContactsClient  # noqa: E402
+
+            self._contacts = ContactsClient(client_wrapper=self._client_wrapper)
+        return self._contacts
+
+    @property
+    def segments(self):
+        if self._segments is None:
+            from .segments.client import SegmentsClient  # noqa: E402
+
+            self._segments = SegmentsClient(client_wrapper=self._client_wrapper)
+        return self._segments
+
+
+def _make_default_async_client(
+    timeout: typing.Optional[float],
+    follow_redirects: typing.Optional[bool],
+) -> httpx.AsyncClient:
+    try:
+        import httpx_aiohttp  # type: ignore[import-not-found]
+    except ImportError:
+        pass
+    else:
+        if follow_redirects is not None:
+            return httpx_aiohttp.HttpxAiohttpClient(timeout=timeout, follow_redirects=follow_redirects)
+        return httpx_aiohttp.HttpxAiohttpClient(timeout=timeout)
+
+    if follow_redirects is not None:
+        return httpx.AsyncClient(timeout=timeout, follow_redirects=follow_redirects)
+    return httpx.AsyncClient(timeout=timeout)
+
+
+class AsyncInformly:
+    """
+    Use this class to access the different functions within the SDK. You can instantiate any number of clients with different configuration that will propagate to these functions.
+
+    Parameters
+    ----------
+    base_url : typing.Optional[str]
+        The base url to use for requests from the client.
+
+    environment : InformlyEnvironment
+        The environment to use for requests from the client. from .environment import InformlyEnvironment
+
+
+
+        Defaults to InformlyEnvironment.DEFAULT
+
+
+
+    token : typing.Union[str, typing.Callable[[], str]]
+    headers : typing.Optional[typing.Dict[str, str]]
+        Additional headers to send with every request.
+
+    async_token : typing.Optional[typing.Callable[[], typing.Awaitable[str]]]
+        An async callable that returns a bearer token. Use this when token acquisition involves async I/O (e.g., refreshing tokens via an async HTTP client). When provided, this is used instead of the synchronous token for async requests.
+
+    timeout : typing.Optional[float]
+        The timeout to be used, in seconds, for requests. By default the timeout is 30 seconds, unless a custom httpx client is used, in which case this default is not enforced.
+
+    follow_redirects : typing.Optional[bool]
+        Whether the default httpx client follows redirects or not, this is irrelevant if a custom httpx client is passed in.
+
+    httpx_client : typing.Optional[httpx.AsyncClient]
+        The httpx client to use for making requests, a preconfigured client is used by default, however this is useful should you want to pass in any custom httpx configuration.
+
+    logging : typing.Optional[typing.Union[LogConfig, Logger]]
+        Configure logging for the SDK. Accepts a LogConfig dict with 'level' (debug/info/warn/error), 'logger' (custom logger implementation), and 'silent' (boolean, defaults to True) fields. You can also pass a pre-configured Logger instance.
+
+    Examples
+    --------
+    from informly-sdk import AsyncInformly
+
+    client = AsyncInformly(token="YOUR_TOKEN", )
+    """
+
+    def __init__(
+        self,
+        *,
+        base_url: typing.Optional[str] = None,
+        environment: InformlyEnvironment = InformlyEnvironment.DEFAULT,
+        token: typing.Union[str, typing.Callable[[], str]],
+        headers: typing.Optional[typing.Dict[str, str]] = None,
+        async_token: typing.Optional[typing.Callable[[], typing.Awaitable[str]]] = None,
+        timeout: typing.Optional[float] = None,
+        follow_redirects: typing.Optional[bool] = True,
+        httpx_client: typing.Optional[httpx.AsyncClient] = None,
+        logging: typing.Optional[typing.Union[LogConfig, Logger]] = None,
+    ):
+        _defaulted_timeout = (
+            timeout if timeout is not None else 30 if httpx_client is None else httpx_client.timeout.read
+        )
+        self._client_wrapper = AsyncClientWrapper(
+            base_url=_get_base_url(base_url=base_url, environment=environment),
+            token=token,
+            headers=headers,
+            async_token=async_token,
+            httpx_client=httpx_client
+            if httpx_client is not None
+            else _make_default_async_client(timeout=_defaulted_timeout, follow_redirects=follow_redirects),
+            timeout=_defaulted_timeout,
+            logging=logging,
+        )
+        self._contacts: typing.Optional[AsyncContactsClient] = None
+        self._segments: typing.Optional[AsyncSegmentsClient] = None
+
+    @property
+    def contacts(self):
+        if self._contacts is None:
+            from .contacts.client import AsyncContactsClient  # noqa: E402
+
+            self._contacts = AsyncContactsClient(client_wrapper=self._client_wrapper)
+        return self._contacts
+
+    @property
+    def segments(self):
+        if self._segments is None:
+            from .segments.client import AsyncSegmentsClient  # noqa: E402
+
+            self._segments = AsyncSegmentsClient(client_wrapper=self._client_wrapper)
+        return self._segments
+
+
+def _get_base_url(*, base_url: typing.Optional[str] = None, environment: InformlyEnvironment) -> str:
+    if base_url is not None:
+        return base_url
+    elif environment is not None:
+        return environment.value
+    else:
+        raise Exception("Please pass in either base_url or environment to construct the client")

informly-0.1.0/src/informly/contacts/__init__.py

@@ -0,0 +1,58 @@
+# 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 (
+        CreateContactResponse,
+        DeleteContactResponse,
+        DeleteContactsResponse,
+        DeleteContactsResponseData,
+        GetContactResponse,
+        ListContactsResponse,
+        UpdateContactResponse,
+    )
+_dynamic_imports: typing.Dict[str, str] = {
+    "CreateContactResponse": ".types",
+    "DeleteContactResponse": ".types",
+    "DeleteContactsResponse": ".types",
+    "DeleteContactsResponseData": ".types",
+    "GetContactResponse": ".types",
+    "ListContactsResponse": ".types",
+    "UpdateContactResponse": ".types",
+}
+
+
+def __getattr__(attr_name: str) -> typing.Any:
+    module_name = _dynamic_imports.get(attr_name)
+    if module_name is None:
+        raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}")
+    try:
+        module = import_module(module_name, __package__)
+        if module_name == f".{attr_name}":
+            return module
+        else:
+            return getattr(module, attr_name)
+    except ImportError as e:
+        raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e
+    except AttributeError as e:
+        raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e
+
+
+def __dir__():
+    lazy_attrs = list(_dynamic_imports.keys())
+    return sorted(lazy_attrs)
+
+
+__all__ = [
+    "CreateContactResponse",
+    "DeleteContactResponse",
+    "DeleteContactsResponse",
+    "DeleteContactsResponseData",
+    "GetContactResponse",
+    "ListContactsResponse",
+    "UpdateContactResponse",
+]