mailmus 0.2.0__tar.gz

mailmus-0.2.0/PKG-INFO

@@ -0,0 +1,192 @@
+Metadata-Version: 2.4
+Name: mailmus
+Version: 0.2.0
+Summary: Official Python SDK for the Mailmus API
+Author-email: Mailmus <support@mailmus.com>
+License: MIT
+Project-URL: Homepage, https://mailmus.com
+Project-URL: Repository, https://github.com/mailmus/mailmus-python
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: httpx>=0.21.2
+Requires-Dist: pydantic>=1.9.2
+Requires-Dist: typing_extensions>=4.0.0
+Provides-Extra: aiohttp
+Requires-Dist: httpx-aiohttp>=0.1.8; extra == "aiohttp"
+
+# Mailmus 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=Mailmus%2FPython)
+[![pypi](https://img.shields.io/pypi/v/mailmus)](https://pypi.python.org/pypi/mailmus)
+
+The Mailmus Python library provides convenient access to the Mailmus APIs from Python.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Reference](#reference)
+- [Usage](#usage)
+- [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 mailmus
+```
+
+## Reference
+
+A full reference for this library is available [here](./reference.md).
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```python
+from mailmus import MailmusApi
+
+client = MailmusApi(
+    token="<token>",
+    base_url="https://yourhost.com/path/to/api",
+)
+
+client.suppressions.suppressions_controller_create(
+    email="bounced@example.com",
+)
+```
+
+## 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 mailmus import AsyncMailmusApi
+
+client = AsyncMailmusApi(
+    token="<token>",
+    base_url="https://yourhost.com/path/to/api",
+)
+
+
+async def main() -> None:
+    await client.suppressions.suppressions_controller_create(
+        email="bounced@example.com",
+    )
+
+
+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 mailmus.core.api_error import ApiError
+
+try:
+    client.suppressions.suppressions_controller_create(...)
+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 mailmus import MailmusApi
+
+client = MailmusApi(...)
+response = client.suppressions.with_raw_response.suppressions_controller_create(...)
+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.suppressions.suppressions_controller_create(..., 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 mailmus import MailmusApi
+
+client = MailmusApi(..., timeout=20.0)
+
+# Override timeout for a specific method
+client.suppressions.suppressions_controller_create(..., 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 mailmus import MailmusApi
+
+client = MailmusApi(
+    ...,
+    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!

mailmus-0.2.0/README.md

@@ -0,0 +1,176 @@
+# Mailmus 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=Mailmus%2FPython)
+[![pypi](https://img.shields.io/pypi/v/mailmus)](https://pypi.python.org/pypi/mailmus)
+
+The Mailmus Python library provides convenient access to the Mailmus APIs from Python.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Reference](#reference)
+- [Usage](#usage)
+- [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 mailmus
+```
+
+## Reference
+
+A full reference for this library is available [here](./reference.md).
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```python
+from mailmus import MailmusApi
+
+client = MailmusApi(
+    token="<token>",
+    base_url="https://yourhost.com/path/to/api",
+)
+
+client.suppressions.suppressions_controller_create(
+    email="bounced@example.com",
+)
+```
+
+## 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 mailmus import AsyncMailmusApi
+
+client = AsyncMailmusApi(
+    token="<token>",
+    base_url="https://yourhost.com/path/to/api",
+)
+
+
+async def main() -> None:
+    await client.suppressions.suppressions_controller_create(
+        email="bounced@example.com",
+    )
+
+
+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 mailmus.core.api_error import ApiError
+
+try:
+    client.suppressions.suppressions_controller_create(...)
+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 mailmus import MailmusApi
+
+client = MailmusApi(...)
+response = client.suppressions.with_raw_response.suppressions_controller_create(...)
+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.suppressions.suppressions_controller_create(..., 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 mailmus import MailmusApi
+
+client = MailmusApi(..., timeout=20.0)
+
+# Override timeout for a specific method
+client.suppressions.suppressions_controller_create(..., 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 mailmus import MailmusApi
+
+client = MailmusApi(
+    ...,
+    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!

mailmus-0.2.0/pyproject.toml

@@ -0,0 +1,30 @@
+[build-system]
+requires = ["setuptools>=68.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "mailmus"
+version = "0.2.0"
+description = "Official Python SDK for the Mailmus API"
+readme = "README.md"
+requires-python = ">=3.9"
+license = { text = "MIT" }
+authors = [{ name = "Mailmus", email = "support@mailmus.com" }]
+dependencies = [
+    "httpx>=0.21.2",
+    "pydantic>=1.9.2",
+    "typing_extensions>=4.0.0",
+]
+
+[project.optional-dependencies]
+aiohttp = ["httpx-aiohttp>=0.1.8"]
+
+[project.urls]
+Homepage = "https://mailmus.com"
+Repository = "https://github.com/mailmus/mailmus-python"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+mailmus = ["py.typed"]

mailmus-0.2.0/setup.cfg

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

mailmus-0.2.0/src/mailmus/__init__.py

@@ -0,0 +1,129 @@
+# 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 EmailAttachmentDto, SendTransactionalEmailDto
+    from . import (
+        account,
+        account_analytics,
+        analytics,
+        api_keys,
+        app,
+        apps,
+        audiences,
+        auth,
+        automations,
+        billing,
+        billing_webhook,
+        campaigns,
+        contacts,
+        domains,
+        emails,
+        public,
+        ses_webhook,
+        suppressions,
+        templates,
+        tracking,
+        usage,
+        webhooks,
+    )
+    from ._default_clients import DefaultAioHttpClient, DefaultAsyncHttpxClient
+    from .api_keys import CreateApiKeyDtoType
+    from .billing import CreateCheckoutDtoPlan
+    from .client import AsyncMailmusApi, MailmusApi
+    from .webhooks import CreateWebhookDtoEventsItem, UpdateWebhookDtoEventsItem
+_dynamic_imports: typing.Dict[str, str] = {
+    "AsyncMailmusApi": ".client",
+    "CreateApiKeyDtoType": ".api_keys",
+    "CreateCheckoutDtoPlan": ".billing",
+    "CreateWebhookDtoEventsItem": ".webhooks",
+    "DefaultAioHttpClient": "._default_clients",
+    "DefaultAsyncHttpxClient": "._default_clients",
+    "EmailAttachmentDto": ".types",
+    "MailmusApi": ".client",
+    "SendTransactionalEmailDto": ".types",
+    "UpdateWebhookDtoEventsItem": ".webhooks",
+    "account": ".account",
+    "account_analytics": ".account_analytics",
+    "analytics": ".analytics",
+    "api_keys": ".api_keys",
+    "app": ".app",
+    "apps": ".apps",
+    "audiences": ".audiences",
+    "auth": ".auth",
+    "automations": ".automations",
+    "billing": ".billing",
+    "billing_webhook": ".billing_webhook",
+    "campaigns": ".campaigns",
+    "contacts": ".contacts",
+    "domains": ".domains",
+    "emails": ".emails",
+    "public": ".public",
+    "ses_webhook": ".ses_webhook",
+    "suppressions": ".suppressions",
+    "templates": ".templates",
+    "tracking": ".tracking",
+    "usage": ".usage",
+    "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__ = [
+    "AsyncMailmusApi",
+    "CreateApiKeyDtoType",
+    "CreateCheckoutDtoPlan",
+    "CreateWebhookDtoEventsItem",
+    "DefaultAioHttpClient",
+    "DefaultAsyncHttpxClient",
+    "EmailAttachmentDto",
+    "MailmusApi",
+    "SendTransactionalEmailDto",
+    "UpdateWebhookDtoEventsItem",
+    "account",
+    "account_analytics",
+    "analytics",
+    "api_keys",
+    "app",
+    "apps",
+    "audiences",
+    "auth",
+    "automations",
+    "billing",
+    "billing_webhook",
+    "campaigns",
+    "contacts",
+    "domains",
+    "emails",
+    "public",
+    "ses_webhook",
+    "suppressions",
+    "templates",
+    "tracking",
+    "usage",
+    "webhooks",
+]

mailmus-0.2.0/src/mailmus/_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 mailmus[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)

mailmus-0.2.0/src/mailmus/account/__init__.py

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