arplyx 0.1.0__tar.gz

arplyx-0.1.0/PKG-INFO

@@ -0,0 +1,105 @@
+Metadata-Version: 2.4
+Name: arplyx
+Version: 0.1.0
+Summary: SDK oficial de Arplyx: enviá mensajes y broadcasts de WhatsApp desde Python.
+Author-email: Arplyx <info@arplyx.com>
+License: MIT
+Project-URL: Homepage, https://docs.arplyx.com/api/
+Project-URL: Documentation, https://docs.arplyx.com/api/
+Keywords: arplyx,whatsapp,whatsapp-api,sdk,mensajeria,broadcasts
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: requests>=2.25
+
+# arplyx (Python SDK)
+
+SDK oficial de **Arplyx** para Python: enviá mensajes y broadcasts de WhatsApp y consultá estados con una API tipada.
+
+## Instalación
+
+```bash
+pip install arplyx
+```
+
+Requiere Python 3.8+.
+
+## Uso
+
+```python
+from arplyx import Arplyx, ArplyxError
+
+client = Arplyx(api_key="ak_live_...")
+
+# Enviar un texto
+msg = client.send_message(
+    external_id="pedido-10045",
+    to="+5491155551234",
+    text="Tu pedido fue confirmado.",
+    channel="whatsapp_direct",
+    whatsapp_account_id="TU_ACCOUNT_ID",
+)
+print(msg.message_id, msg.status)
+
+# Consultar estado (por message_id o por tu external_id)
+status = client.get_message("pedido-10045")
+print(status.status)  # pending | queued | sent | delivered | read | failed
+```
+
+### Plantillas (Meta Official)
+
+```python
+client.send_message(
+    external_id="pedido-10045",
+    to="+5491155551234",
+    channel="whatsapp_meta",
+    template={"name": "pedido_confirmado", "language": "es_AR", "body": ["Juan", "10045"]},
+)
+```
+
+### Broadcast a una lista (planes Basic/Pro)
+
+```python
+client.send_broadcast(
+    external_id="promo-junio-2026",
+    list_id="TU_LIST_ID",
+    text="Este mes 2x1 en turnos.",
+    channel="whatsapp_direct",
+    whatsapp_account_id="TU_ACCOUNT_ID",
+)
+```
+
+### Listar cuentas de WhatsApp
+
+```python
+for acc in client.list_whatsapp_accounts():
+    print(acc.id, acc.type, acc.status)  # acc.id se usa como whatsapp_account_id
+```
+
+## Manejo de errores
+
+```python
+try:
+    client.send_message(external_id="x", to="+549...", text="hola")
+except ArplyxError as e:
+    print(e.status)   # 400, 401, 409, 422, 429, 500...
+    print(e.code)     # 'validation_error', 'conflict', 'quota_exceeded'...
+    print(e.details)  # detalles por campo si es validation_error
+```
+
+## Idempotencia
+
+Todos los envíos usan tu `external_id` como clave de idempotencia: reintentar con el mismo `external_id` y payload no duplica el envío. Es seguro reintentar ante timeouts.
+
+## Configuración
+
+| Parámetro | Requerido | Default |
+|---|---|---|
+| `api_key` | Sí | — |
+| `base_url` | No | `https://api.arplyx.com` |
+| `timeout` | No | `10.0` |
+| `session` | No | `requests.Session()` nueva |
+
+Docs de la API: https://docs.arplyx.com/api/ · OpenAPI: https://api.arplyx.com/openapi.yaml

arplyx-0.1.0/README.md

@@ -0,0 +1,89 @@
+# arplyx (Python SDK)
+
+SDK oficial de **Arplyx** para Python: enviá mensajes y broadcasts de WhatsApp y consultá estados con una API tipada.
+
+## Instalación
+
+```bash
+pip install arplyx
+```
+
+Requiere Python 3.8+.
+
+## Uso
+
+```python
+from arplyx import Arplyx, ArplyxError
+
+client = Arplyx(api_key="ak_live_...")
+
+# Enviar un texto
+msg = client.send_message(
+    external_id="pedido-10045",
+    to="+5491155551234",
+    text="Tu pedido fue confirmado.",
+    channel="whatsapp_direct",
+    whatsapp_account_id="TU_ACCOUNT_ID",
+)
+print(msg.message_id, msg.status)
+
+# Consultar estado (por message_id o por tu external_id)
+status = client.get_message("pedido-10045")
+print(status.status)  # pending | queued | sent | delivered | read | failed
+```
+
+### Plantillas (Meta Official)
+
+```python
+client.send_message(
+    external_id="pedido-10045",
+    to="+5491155551234",
+    channel="whatsapp_meta",
+    template={"name": "pedido_confirmado", "language": "es_AR", "body": ["Juan", "10045"]},
+)
+```
+
+### Broadcast a una lista (planes Basic/Pro)
+
+```python
+client.send_broadcast(
+    external_id="promo-junio-2026",
+    list_id="TU_LIST_ID",
+    text="Este mes 2x1 en turnos.",
+    channel="whatsapp_direct",
+    whatsapp_account_id="TU_ACCOUNT_ID",
+)
+```
+
+### Listar cuentas de WhatsApp
+
+```python
+for acc in client.list_whatsapp_accounts():
+    print(acc.id, acc.type, acc.status)  # acc.id se usa como whatsapp_account_id
+```
+
+## Manejo de errores
+
+```python
+try:
+    client.send_message(external_id="x", to="+549...", text="hola")
+except ArplyxError as e:
+    print(e.status)   # 400, 401, 409, 422, 429, 500...
+    print(e.code)     # 'validation_error', 'conflict', 'quota_exceeded'...
+    print(e.details)  # detalles por campo si es validation_error
+```
+
+## Idempotencia
+
+Todos los envíos usan tu `external_id` como clave de idempotencia: reintentar con el mismo `external_id` y payload no duplica el envío. Es seguro reintentar ante timeouts.
+
+## Configuración
+
+| Parámetro | Requerido | Default |
+|---|---|---|
+| `api_key` | Sí | — |
+| `base_url` | No | `https://api.arplyx.com` |
+| `timeout` | No | `10.0` |
+| `session` | No | `requests.Session()` nueva |
+
+Docs de la API: https://docs.arplyx.com/api/ · OpenAPI: https://api.arplyx.com/openapi.yaml

arplyx-0.1.0/pyproject.toml

@@ -0,0 +1,26 @@
+[build-system]
+requires = ["setuptools>=61"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "arplyx"
+version = "0.1.0"
+description = "SDK oficial de Arplyx: enviá mensajes y broadcasts de WhatsApp desde Python."
+readme = "README.md"
+requires-python = ">=3.8"
+license = { text = "MIT" }
+authors = [{ name = "Arplyx", email = "info@arplyx.com" }]
+keywords = ["arplyx", "whatsapp", "whatsapp-api", "sdk", "mensajeria", "broadcasts"]
+dependencies = ["requests>=2.25"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+
+[project.urls]
+Homepage = "https://docs.arplyx.com/api/"
+Documentation = "https://docs.arplyx.com/api/"
+
+[tool.setuptools.packages.find]
+where = ["src"]

arplyx-0.1.0/setup.cfg

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

arplyx-0.1.0/src/arplyx/__init__.py

@@ -0,0 +1,20 @@
+"""SDK oficial de Arplyx para Python."""
+
+from .client import Arplyx
+from .errors import ArplyxError
+from .types import (
+    BroadcastResponse,
+    MessageResponse,
+    MessageStatus,
+    WhatsAppAccount,
+)
+
+__version__ = "0.1.0"
+__all__ = [
+    "Arplyx",
+    "ArplyxError",
+    "MessageResponse",
+    "BroadcastResponse",
+    "MessageStatus",
+    "WhatsAppAccount",
+]

arplyx-0.1.0/src/arplyx/client.py

@@ -0,0 +1,157 @@
+from typing import Any, Dict, List, Optional
+
+import requests
+
+from .errors import ArplyxError
+from .types import (
+    BroadcastResponse,
+    MessageResponse,
+    MessageStatus,
+    WhatsAppAccount,
+)
+
+DEFAULT_BASE_URL = "https://api.arplyx.com"
+
+
+class Arplyx:
+    """Cliente de la API de Arplyx.
+
+    Ejemplo::
+
+        from arplyx import Arplyx
+
+        client = Arplyx(api_key="ak_live_...")
+        msg = client.send_message(
+            external_id="pedido-10045",
+            to="+5491155551234",
+            text="Tu pedido fue confirmado",
+            channel="whatsapp_direct",
+            whatsapp_account_id="...",
+        )
+        print(msg.message_id, msg.status)
+    """
+
+    def __init__(
+        self,
+        api_key: str,
+        base_url: str = DEFAULT_BASE_URL,
+        timeout: float = 10.0,
+        session: Optional[requests.Session] = None,
+    ) -> None:
+        if not api_key:
+            raise ValueError("Arplyx: falta api_key.")
+        self.api_key = api_key
+        self.base_url = base_url.rstrip("/")
+        self.timeout = timeout
+        self._session = session or requests.Session()
+
+    def _request(self, method: str, path: str, json: Optional[dict] = None) -> Any:
+        resp = self._session.request(
+            method,
+            f"{self.base_url}{path}",
+            json=json,
+            headers={"x-api-key": self.api_key, "Content-Type": "application/json"},
+            timeout=self.timeout,
+        )
+        data: Any = None
+        if resp.content:
+            try:
+                data = resp.json()
+            except ValueError:
+                data = resp.text
+        if not resp.ok:
+            body = data if isinstance(data, dict) else {"error": data}
+            raise ArplyxError(resp.status_code, body)
+        return data
+
+    def send_message(
+        self,
+        external_id: str,
+        to: str,
+        *,
+        text: Optional[str] = None,
+        template: Optional[Dict[str, Any]] = None,
+        channel: Optional[str] = None,
+        whatsapp_account_id: Optional[str] = None,
+        metadata: Optional[Dict[str, Any]] = None,
+        ttl_seconds: Optional[int] = None,
+    ) -> MessageResponse:
+        """Envía un mensaje de WhatsApp (texto o plantilla).
+
+        Indicá exactamente uno de ``text`` o ``template``. ``template`` es un
+        dict ``{"name", "language", "body": [...], "header": [...]}``.
+        """
+        if (text is None) == (template is None):
+            raise ValueError(
+                "send_message: indicá exactamente uno de `text` o `template`."
+            )
+
+        if text is not None:
+            content: Dict[str, Any] = {"type": "text", "text": text}
+        else:
+            tpl: Dict[str, Any] = {
+                "name": template["name"],
+                "language": template["language"],
+            }
+            components: Dict[str, Any] = {}
+            if template.get("body"):
+                components["body"] = template["body"]
+            if template.get("header"):
+                components["header"] = template["header"]
+            if components:
+                tpl["components"] = components
+            content = {"type": "template", "template": tpl}
+
+        payload: Dict[str, Any] = {
+            "externalId": external_id,
+            "to": {"type": "phone", "phoneE164": to},
+            "content": content,
+        }
+        if channel is not None:
+            payload["channel"] = channel
+        if whatsapp_account_id is not None:
+            payload["whatsappAccountId"] = whatsapp_account_id
+        if metadata is not None:
+            payload["metadata"] = metadata
+        if ttl_seconds is not None:
+            payload["ttlSeconds"] = ttl_seconds
+
+        return MessageResponse._from_api(self._request("POST", "/messages", payload))
+
+    def send_broadcast(
+        self,
+        external_id: str,
+        list_id: str,
+        text: str,
+        channel: str,
+        *,
+        whatsapp_account_id: Optional[str] = None,
+        ttl_seconds: Optional[int] = None,
+    ) -> BroadcastResponse:
+        """Envía un texto a todos los contactos de una lista (planes Basic/Pro)."""
+        payload: Dict[str, Any] = {
+            "externalId": external_id,
+            "listId": list_id,
+            "channel": channel,
+            "content": {"type": "text", "text": text},
+        }
+        if whatsapp_account_id is not None:
+            payload["whatsappAccountId"] = whatsapp_account_id
+        if ttl_seconds is not None:
+            payload["ttlSeconds"] = ttl_seconds
+
+        return BroadcastResponse._from_api(
+            self._request("POST", "/messages/broadcast", payload)
+        )
+
+    def list_whatsapp_accounts(self) -> List[WhatsAppAccount]:
+        """Lista las cuentas de WhatsApp del cliente."""
+        data = self._request("GET", "/whatsapp-accounts")
+        return [WhatsAppAccount._from_api(a) for a in data["accounts"]]
+
+    def get_message(self, id_or_external_id: str) -> MessageStatus:
+        """Estado de un mensaje por su ``message_id`` o tu ``external_id``."""
+        from urllib.parse import quote
+
+        data = self._request("GET", f"/messages/{quote(id_or_external_id, safe='')}")
+        return MessageStatus._from_api(data)

arplyx-0.1.0/src/arplyx/errors.py

@@ -0,0 +1,29 @@
+from typing import Any, List, Optional
+
+
+class ArplyxError(Exception):
+    """Error devuelto por la API de Arplyx (respuesta HTTP no-2xx).
+
+    Atributos:
+        status: código HTTP.
+        code: código de error de Arplyx (campo ``error`` del cuerpo), p. ej.
+            ``validation_error``, ``conflict``, ``quota_exceeded``,
+            ``invalid_whatsapp_account``, ``templates_not_available``.
+        body: cuerpo crudo de la respuesta.
+        details: detalles por campo si ``code == "validation_error"``.
+    """
+
+    def __init__(self, status: int, body: Any) -> None:
+        self.status = status
+        self.body = body
+        code: Optional[str] = None
+        message: Optional[str] = None
+        details: Optional[List[dict]] = None
+        if isinstance(body, dict):
+            code = body.get("error")
+            message = body.get("message")
+            if isinstance(body.get("details"), list):
+                details = body["details"]
+        self.code = code or f"http_{status}"
+        self.details = details
+        super().__init__(f"Arplyx {status} ({self.code}): {message or self.code}")

arplyx-0.1.0/src/arplyx/types.py

@@ -0,0 +1,92 @@
+from dataclasses import dataclass
+from typing import Optional
+
+
+@dataclass
+class MessageResponse:
+    message_id: str
+    external_id: str
+    status: str
+    queued: bool
+
+    @staticmethod
+    def _from_api(d: dict) -> "MessageResponse":
+        return MessageResponse(
+            message_id=d["messageId"],
+            external_id=d["externalId"],
+            status=d["status"],
+            queued=d["queued"],
+        )
+
+
+@dataclass
+class BroadcastResponse:
+    broadcast_id: str
+    external_id: str
+    list_id: str
+    message_count: int
+    status: str
+
+    @staticmethod
+    def _from_api(d: dict) -> "BroadcastResponse":
+        return BroadcastResponse(
+            broadcast_id=d["broadcastId"],
+            external_id=d["externalId"],
+            list_id=d["listId"],
+            message_count=d["messageCount"],
+            status=d["status"],
+        )
+
+
+@dataclass
+class MessageStatus:
+    message_id: str
+    external_id: str
+    recipient: str
+    channel: str
+    status: str
+    attempt_count: int
+    last_error_code: Optional[str]
+    broadcast_id: Optional[str]
+    created_at: str
+    sent_at: Optional[str]
+    delivered_at: Optional[str]
+    failed_at: Optional[str]
+
+    @staticmethod
+    def _from_api(d: dict) -> "MessageStatus":
+        return MessageStatus(
+            message_id=d["messageId"],
+            external_id=d["externalId"],
+            recipient=d["recipient"],
+            channel=d["channel"],
+            status=d["status"],
+            attempt_count=d["attemptCount"],
+            last_error_code=d.get("lastErrorCode"),
+            broadcast_id=d.get("broadcastId"),
+            created_at=d["createdAt"],
+            sent_at=d.get("sentAt"),
+            delivered_at=d.get("deliveredAt"),
+            failed_at=d.get("failedAt"),
+        )
+
+
+@dataclass
+class WhatsAppAccount:
+    id: str
+    type: str
+    status: str
+    phone_number: Optional[str]
+    display_name: Optional[str]
+    connected_at: Optional[str]
+
+    @staticmethod
+    def _from_api(d: dict) -> "WhatsAppAccount":
+        return WhatsAppAccount(
+            id=d["id"],
+            type=d["type"],
+            status=d["status"],
+            phone_number=d.get("phoneNumber"),
+            display_name=d.get("displayName"),
+            connected_at=d.get("connectedAt"),
+        )

arplyx-0.1.0/src/arplyx.egg-info/PKG-INFO

@@ -0,0 +1,105 @@
+Metadata-Version: 2.4
+Name: arplyx
+Version: 0.1.0
+Summary: SDK oficial de Arplyx: enviá mensajes y broadcasts de WhatsApp desde Python.
+Author-email: Arplyx <info@arplyx.com>
+License: MIT
+Project-URL: Homepage, https://docs.arplyx.com/api/
+Project-URL: Documentation, https://docs.arplyx.com/api/
+Keywords: arplyx,whatsapp,whatsapp-api,sdk,mensajeria,broadcasts
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: requests>=2.25
+
+# arplyx (Python SDK)
+
+SDK oficial de **Arplyx** para Python: enviá mensajes y broadcasts de WhatsApp y consultá estados con una API tipada.
+
+## Instalación
+
+```bash
+pip install arplyx
+```
+
+Requiere Python 3.8+.
+
+## Uso
+
+```python
+from arplyx import Arplyx, ArplyxError
+
+client = Arplyx(api_key="ak_live_...")
+
+# Enviar un texto
+msg = client.send_message(
+    external_id="pedido-10045",
+    to="+5491155551234",
+    text="Tu pedido fue confirmado.",
+    channel="whatsapp_direct",
+    whatsapp_account_id="TU_ACCOUNT_ID",
+)
+print(msg.message_id, msg.status)
+
+# Consultar estado (por message_id o por tu external_id)
+status = client.get_message("pedido-10045")
+print(status.status)  # pending | queued | sent | delivered | read | failed
+```
+
+### Plantillas (Meta Official)
+
+```python
+client.send_message(
+    external_id="pedido-10045",
+    to="+5491155551234",
+    channel="whatsapp_meta",
+    template={"name": "pedido_confirmado", "language": "es_AR", "body": ["Juan", "10045"]},
+)
+```
+
+### Broadcast a una lista (planes Basic/Pro)
+
+```python
+client.send_broadcast(
+    external_id="promo-junio-2026",
+    list_id="TU_LIST_ID",
+    text="Este mes 2x1 en turnos.",
+    channel="whatsapp_direct",
+    whatsapp_account_id="TU_ACCOUNT_ID",
+)
+```
+
+### Listar cuentas de WhatsApp
+
+```python
+for acc in client.list_whatsapp_accounts():
+    print(acc.id, acc.type, acc.status)  # acc.id se usa como whatsapp_account_id
+```
+
+## Manejo de errores
+
+```python
+try:
+    client.send_message(external_id="x", to="+549...", text="hola")
+except ArplyxError as e:
+    print(e.status)   # 400, 401, 409, 422, 429, 500...
+    print(e.code)     # 'validation_error', 'conflict', 'quota_exceeded'...
+    print(e.details)  # detalles por campo si es validation_error
+```
+
+## Idempotencia
+
+Todos los envíos usan tu `external_id` como clave de idempotencia: reintentar con el mismo `external_id` y payload no duplica el envío. Es seguro reintentar ante timeouts.
+
+## Configuración
+
+| Parámetro | Requerido | Default |
+|---|---|---|
+| `api_key` | Sí | — |
+| `base_url` | No | `https://api.arplyx.com` |
+| `timeout` | No | `10.0` |
+| `session` | No | `requests.Session()` nueva |
+
+Docs de la API: https://docs.arplyx.com/api/ · OpenAPI: https://api.arplyx.com/openapi.yaml

arplyx-0.1.0/src/arplyx.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+README.md
+pyproject.toml
+src/arplyx/__init__.py
+src/arplyx/client.py
+src/arplyx/errors.py
+src/arplyx/types.py
+src/arplyx.egg-info/PKG-INFO
+src/arplyx.egg-info/SOURCES.txt
+src/arplyx.egg-info/dependency_links.txt
+src/arplyx.egg-info/requires.txt
+src/arplyx.egg-info/top_level.txt

arplyx-0.1.0/src/arplyx.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

arplyx-0.1.0/src/arplyx.egg-info/requires.txt

@@ -0,0 +1 @@
+requests>=2.25

arplyx-0.1.0/src/arplyx.egg-info/top_level.txt

@@ -0,0 +1 @@
+arplyx