pyloops 1.6.0__tar.gz

pyloops-1.6.0/PKG-INFO

@@ -0,0 +1,131 @@
+Metadata-Version: 2.3
+Name: pyloops
+Version: 1.6.0
+Summary: Unofficial Python SDK for Loops.so email platform
+Keywords: loops,email,api,sdk,loops.so
+Author: zegerius
+Author-email: zegerius <aram@askaletta.com>
+License: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: httpx>=0.23.0,<0.29.0
+Requires-Dist: attrs>=22.2.0
+Requires-Dist: python-dateutil>=2.8.0,<3
+Requires-Python: >=3.12
+Project-URL: Documentation, https://loops.so/docs
+Project-URL: Homepage, https://github.com/doctorgpt-corp/pyloops
+Project-URL: Repository, https://github.com/doctorgpt-corp/pyloops
+Description-Content-Type: text/markdown
+
+# PyLoops
+
+Unofficial Python SDK for [Loops.so](https://loops.so).
+
+[![PyPI version](https://badge.fury.io/py/pyloops.svg)](https://badge.fury.io/py/pyloops)
+[![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
+
+## Installation
+
+```bash
+pip install pyloops
+```
+
+Or with uv:
+
+```bash
+uv add pyloops
+```
+
+## Quick Start
+
+```python
+from pyloops import Client
+
+# Initialize the client with your API key
+client = Client(base_url="https://app.loops.so/api/v1", token="your_api_key_here")
+
+# Create a contact
+from pyloops.api.contacts import create_contact
+from pyloops.models import CreateContactBody
+
+response = create_contact.sync(
+    client=client,
+    body=CreateContactBody(
+        email="user@example.com",
+        first_name="John",
+        last_name="Doe"
+    )
+)
+
+print(response)
+```
+
+## Authentication
+
+All API calls require a Loops API key. Get your API key from your [Loops account settings](https://app.loops.so/settings).
+
+```python
+from pyloops import Client
+
+client = Client(
+    base_url="https://app.loops.so/api/v1",
+    token="your_api_key_here"
+)
+```
+
+## Features
+
+This SDK provides access to all Loops.so API endpoints:
+
+- **Contacts**: Create, update, find, and delete contacts
+- **Contact Properties**: Manage custom contact properties
+- **Mailing Lists**: View available mailing lists
+- **Events**: Trigger event-based emails
+- **Transactional Emails**: Send and list transactional emails
+- **Sending IPs**: Retrieve dedicated sending IP addresses
+
+## Documentation
+
+For detailed API documentation, visit the [Loops.so API docs](https://loops.so/docs).
+
+## Automated Updates
+
+This SDK is automatically updated to match the latest Loops.so API specification. The package version corresponds to the Loops API version (current: **1.6.0**).
+
+A GitHub Action checks for API updates daily and creates a pull request when changes are detected. After review and merge, a new version is automatically published to PyPI.
+
+## Development
+
+### Setup
+
+```bash
+# Clone the repository
+git clone https://github.com/doctorgpt-corp/pyloops.git
+cd pyloops
+
+# Install dependencies with uv
+uv sync
+```
+
+### Regenerate SDK
+
+To manually regenerate the SDK from the latest OpenAPI spec:
+
+```bash
+uv run openapi-python-client generate --url https://app.loops.so/openapi.yaml --meta uv
+cp -r loops-open-api-spec-client/loops_open_api_spec_client/* src/pyloops/
+rm -rf loops-open-api-spec-client
+```
+
+## License
+
+MIT
+
+## Disclaimer
+
+This is an unofficial SDK and is not affiliated with or endorsed by Loops.so.

pyloops-1.6.0/README.md

@@ -0,0 +1,107 @@
+# PyLoops
+
+Unofficial Python SDK for [Loops.so](https://loops.so).
+
+[![PyPI version](https://badge.fury.io/py/pyloops.svg)](https://badge.fury.io/py/pyloops)
+[![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
+
+## Installation
+
+```bash
+pip install pyloops
+```
+
+Or with uv:
+
+```bash
+uv add pyloops
+```
+
+## Quick Start
+
+```python
+from pyloops import Client
+
+# Initialize the client with your API key
+client = Client(base_url="https://app.loops.so/api/v1", token="your_api_key_here")
+
+# Create a contact
+from pyloops.api.contacts import create_contact
+from pyloops.models import CreateContactBody
+
+response = create_contact.sync(
+    client=client,
+    body=CreateContactBody(
+        email="user@example.com",
+        first_name="John",
+        last_name="Doe"
+    )
+)
+
+print(response)
+```
+
+## Authentication
+
+All API calls require a Loops API key. Get your API key from your [Loops account settings](https://app.loops.so/settings).
+
+```python
+from pyloops import Client
+
+client = Client(
+    base_url="https://app.loops.so/api/v1",
+    token="your_api_key_here"
+)
+```
+
+## Features
+
+This SDK provides access to all Loops.so API endpoints:
+
+- **Contacts**: Create, update, find, and delete contacts
+- **Contact Properties**: Manage custom contact properties
+- **Mailing Lists**: View available mailing lists
+- **Events**: Trigger event-based emails
+- **Transactional Emails**: Send and list transactional emails
+- **Sending IPs**: Retrieve dedicated sending IP addresses
+
+## Documentation
+
+For detailed API documentation, visit the [Loops.so API docs](https://loops.so/docs).
+
+## Automated Updates
+
+This SDK is automatically updated to match the latest Loops.so API specification. The package version corresponds to the Loops API version (current: **1.6.0**).
+
+A GitHub Action checks for API updates daily and creates a pull request when changes are detected. After review and merge, a new version is automatically published to PyPI.
+
+## Development
+
+### Setup
+
+```bash
+# Clone the repository
+git clone https://github.com/doctorgpt-corp/pyloops.git
+cd pyloops
+
+# Install dependencies with uv
+uv sync
+```
+
+### Regenerate SDK
+
+To manually regenerate the SDK from the latest OpenAPI spec:
+
+```bash
+uv run openapi-python-client generate --url https://app.loops.so/openapi.yaml --meta uv
+cp -r loops-open-api-spec-client/loops_open_api_spec_client/* src/pyloops/
+rm -rf loops-open-api-spec-client
+```
+
+## License
+
+MIT
+
+## Disclaimer
+
+This is an unofficial SDK and is not affiliated with or endorsed by Loops.so.

pyloops-1.6.0/pyproject.toml

@@ -0,0 +1,42 @@
+[build-system]
+requires = ["uv_build>=0.9.9,<0.10.0"]
+build-backend = "uv_build"
+
+[project]
+name = "pyloops"
+version = "1.6.0"
+description = "Unofficial Python SDK for Loops.so email platform"
+readme = "README.md"
+requires-python = ">=3.12"
+license = {text = "MIT"}
+authors = [
+    {name = "zegerius", email = "aram@askaletta.com"}
+]
+keywords = ["loops", "email", "api", "sdk", "loops.so"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
+dependencies = [
+    "httpx>=0.23.0,<0.29.0",
+    "attrs>=22.2.0",
+    "python-dateutil>=2.8.0,<3",
+]
+
+[project.urls]
+Homepage = "https://github.com/doctorgpt-corp/pyloops"
+Repository = "https://github.com/doctorgpt-corp/pyloops"
+Documentation = "https://loops.so/docs"
+
+[tool.uv.build-backend]
+module-root = "src/"
+
+[dependency-groups]
+dev = [
+    "openapi-python-client>=0.27.1",
+]

pyloops-1.6.0/src/pyloops/__init__.py

@@ -0,0 +1,8 @@
+"""A client library for accessing Loops OpenAPI Spec"""
+
+from .client import AuthenticatedClient, Client
+
+__all__ = (
+    "AuthenticatedClient",
+    "Client",
+)

pyloops-1.6.0/src/pyloops/api/__init__.py

@@ -0,0 +1 @@
+"""Contains methods for accessing the API"""

pyloops-1.6.0/src/pyloops/api/api_key/__init__.py

@@ -0,0 +1 @@
+"""Contains endpoint functions for accessing the API"""

pyloops-1.6.0/src/pyloops/api/api_key/get_api_key.py

@@ -0,0 +1,133 @@
+from http import HTTPStatus
+from typing import Any
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.get_api_key_response_200 import GetApiKeyResponse200
+from ...models.get_api_key_response_401 import GetApiKeyResponse401
+from ...types import Response
+
+
+def _get_kwargs() -> dict[str, Any]:
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/api-key",
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> GetApiKeyResponse200 | GetApiKeyResponse401 | None:
+    if response.status_code == 200:
+        response_200 = GetApiKeyResponse200.from_dict(response.json())
+
+        return response_200
+
+    if response.status_code == 401:
+        response_401 = GetApiKeyResponse401.from_dict(response.json())
+
+        return response_401
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[GetApiKeyResponse200 | GetApiKeyResponse401]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: AuthenticatedClient,
+) -> Response[GetApiKeyResponse200 | GetApiKeyResponse401]:
+    """Test your API key
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[GetApiKeyResponse200 | GetApiKeyResponse401]
+    """
+
+    kwargs = _get_kwargs()
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient,
+) -> GetApiKeyResponse200 | GetApiKeyResponse401 | None:
+    """Test your API key
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        GetApiKeyResponse200 | GetApiKeyResponse401
+    """
+
+    return sync_detailed(
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient,
+) -> Response[GetApiKeyResponse200 | GetApiKeyResponse401]:
+    """Test your API key
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[GetApiKeyResponse200 | GetApiKeyResponse401]
+    """
+
+    kwargs = _get_kwargs()
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient,
+) -> GetApiKeyResponse200 | GetApiKeyResponse401 | None:
+    """Test your API key
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        GetApiKeyResponse200 | GetApiKeyResponse401
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+        )
+    ).parsed

pyloops-1.6.0/src/pyloops/api/contact_properties/__init__.py

@@ -0,0 +1 @@
+"""Contains endpoint functions for accessing the API"""

pyloops-1.6.0/src/pyloops/api/contact_properties/get_contacts_properties.py

@@ -0,0 +1,180 @@
+from http import HTTPStatus
+from typing import Any, cast
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.contact_property import ContactProperty
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    *,
+    list_: str | Unset = UNSET,
+) -> dict[str, Any]:
+    params: dict[str, Any] = {}
+
+    params["list"] = list_
+
+    params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/contacts/properties",
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Any | list[ContactProperty] | None:
+    if response.status_code == 200:
+        response_200 = []
+        _response_200 = response.json()
+        for response_200_item_data in _response_200:
+            response_200_item = ContactProperty.from_dict(response_200_item_data)
+
+            response_200.append(response_200_item)
+
+        return response_200
+
+    if response.status_code == 405:
+        response_405 = cast(Any, None)
+        return response_405
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[Any | list[ContactProperty]]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: AuthenticatedClient,
+    list_: str | Unset = UNSET,
+) -> Response[Any | list[ContactProperty]]:
+    r"""Get a list of contact properties
+
+     Retrieve a list of your account's contact properties.<br>Use the `list` parameter to query \"all\"
+    or \"custom\" properties.
+
+    Args:
+        list_ (str | Unset):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Any | list[ContactProperty]]
+    """
+
+    kwargs = _get_kwargs(
+        list_=list_,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient,
+    list_: str | Unset = UNSET,
+) -> Any | list[ContactProperty] | None:
+    r"""Get a list of contact properties
+
+     Retrieve a list of your account's contact properties.<br>Use the `list` parameter to query \"all\"
+    or \"custom\" properties.
+
+    Args:
+        list_ (str | Unset):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Any | list[ContactProperty]
+    """
+
+    return sync_detailed(
+        client=client,
+        list_=list_,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient,
+    list_: str | Unset = UNSET,
+) -> Response[Any | list[ContactProperty]]:
+    r"""Get a list of contact properties
+
+     Retrieve a list of your account's contact properties.<br>Use the `list` parameter to query \"all\"
+    or \"custom\" properties.
+
+    Args:
+        list_ (str | Unset):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Any | list[ContactProperty]]
+    """
+
+    kwargs = _get_kwargs(
+        list_=list_,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient,
+    list_: str | Unset = UNSET,
+) -> Any | list[ContactProperty] | None:
+    r"""Get a list of contact properties
+
+     Retrieve a list of your account's contact properties.<br>Use the `list` parameter to query \"all\"
+    or \"custom\" properties.
+
+    Args:
+        list_ (str | Unset):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Any | list[ContactProperty]
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            list_=list_,
+        )
+    ).parsed