wazzapi 0.4.0__tar.gz → 0.5.0__tar.gz

{wazzapi-0.4.0 → wazzapi-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wazzapi
-Version: 0.4.0
+Version: 0.5.0
 Summary: Typed Python SDK for WazzAPI
 Project-URL: API, https://api.wazzapi.com
 Project-URL: Homepage, https://github.com/wazzapihq/wazzapi-py

{wazzapi-0.4.0 → wazzapi-0.5.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "wazzapi"
-version = "0.4.0"
+version = "0.5.0"
 description = "Typed Python SDK for WazzAPI"
 readme = { file = "README.md", content-type = "text/markdown" }
 requires-python = ">=3.10"

{wazzapi-0.4.0 → wazzapi-0.5.0}/tests/smoke_test.py

@@ -10,7 +10,7 @@ from wazzapi import (
 
 
 def main() -> None:
-    assert __version__ == "0.4.0"
+    assert __version__ == "0.5.0"
 
     client = WazzapiClient(api_key="smoke-test-token")
     try:

{wazzapi-0.4.0 → wazzapi-0.5.0}/wazzapi/__init__.py

@@ -16,7 +16,7 @@ from .webhooks import (
     verify_webhook_signature,
 )
 
-__version__ = "0.4.0"
+__version__ = "0.5.0"
 
 __all__ = [
     "EVENT_HEADER",

{wazzapi-0.4.0 → wazzapi-0.5.0}/wazzapi/client.py

@@ -7,7 +7,16 @@ import httpx
 from pydantic import BaseModel, TypeAdapter
 
 from .errors import WazzapiAPIError
-from .resources import ContactsResource, DevicesResource, GroupsResource, MessagesResource, TemplatesResource
+from .resources import (
+    CampaignsResource,
+    ContactsResource,
+    ConversationsResource,
+    DevicesResource,
+    GroupsResource,
+    MessagesResource,
+    TemplatesResource,
+    WebhookSubscriptionsResource,
+)
 
 DEFAULT_BASE_URL = "https://api.wazzapi.com"
 
@@ -38,11 +47,14 @@ class WazzapiClient:
             transport=transport,
         )
 
+        self.campaigns = CampaignsResource(self)
         self.contacts = ContactsResource(self)
+        self.conversations = ConversationsResource(self)
         self.devices = DevicesResource(self)
         self.groups = GroupsResource(self)
         self.messages = MessagesResource(self)
         self.templates = TemplatesResource(self)
+        self.webhook_subscriptions = WebhookSubscriptionsResource(self)
 
     @staticmethod
     def _build_headers(

{wazzapi-0.4.0 → wazzapi-0.5.0}/wazzapi/models/__init__.py

@@ -1,6 +1,10 @@
 from .base import WazzapiModel
+from .campaigns import *
+from .campaigns import __all__ as campaigns_all
 from .contacts import *
 from .contacts import __all__ as contacts_all
+from .conversations import *
+from .conversations import __all__ as conversations_all
 from .devices import *
 from .devices import __all__ as devices_all
 from .groups import *
@@ -11,16 +15,21 @@ from .messages import *
 from .messages import __all__ as messages_all
 from .templates import *
 from .templates import __all__ as templates_all
+from .webhook_subscriptions import *
+from .webhook_subscriptions import __all__ as webhook_subscriptions_all
 from .webhooks import *
 from .webhooks import __all__ as webhooks_all
 
 __all__ = [
 	"WazzapiModel",
+	*campaigns_all,
 	*contacts_all,
+	*conversations_all,
 	*devices_all,
 	*groups_all,
 	*media_all,
 	*messages_all,
 	*templates_all,
+	*webhook_subscriptions_all,
 	*webhooks_all,
 ]

wazzapi-0.5.0/wazzapi/models/campaigns.py

@@ -0,0 +1,103 @@
+from __future__ import annotations
+
+from datetime import datetime
+from typing import Any
+
+from .base import WazzapiModel
+
+
+class CampaignCreateRequest(WazzapiModel):
+    name: str
+    whatsapp_account_id: str
+    recipient_type: str
+    description: str | None = None
+    template_id: str | None = None
+    message_type: str = "text"
+    custom_message: str | None = None
+    message_payload: dict[str, Any] | None = None
+    recipient_group_ids: list[str] | None = None
+    recipient_contact_ids: list[str] | None = None
+    scheduled_for: datetime | None = None
+
+
+class CampaignUpdateRequest(WazzapiModel):
+    name: str | None = None
+    description: str | None = None
+    template_id: str | None = None
+    message_type: str | None = None
+    custom_message: str | None = None
+    message_payload: dict[str, Any] | None = None
+    recipient_type: str | None = None
+    recipient_group_ids: list[str] | None = None
+    recipient_contact_ids: list[str] | None = None
+    scheduled_for: datetime | None = None
+
+
+class CampaignItem(WazzapiModel):
+    id: str
+    name: str
+    status: str
+    recipient_type: str
+    total_recipients: int
+    messages_sent: int
+    messages_delivered: int
+    messages_failed: int
+    whatsapp_account_id: str
+    message_type: str = "text"
+    recipient_contact_ids: list[str] | None = None
+    scheduled_for: str | None = None
+    created_at: str
+
+
+class CampaignListResponse(WazzapiModel):
+    items: list[CampaignItem]
+    total: int
+    limit: int
+    offset: int
+
+
+class CampaignResponse(WazzapiModel):
+    id: str
+    name: str
+    status: str
+    description: str | None = None
+    whatsapp_account_id: str
+    template_id: str | None = None
+    message_type: str = "text"
+    custom_message: str | None = None
+    message_payload: dict[str, Any] | None = None
+    recipient_type: str
+    recipient_group_ids: list[str] | None = None
+    recipient_contact_ids: list[str] | None = None
+    total_recipients: int = 0
+    messages_sent: int = 0
+    messages_delivered: int = 0
+    messages_failed: int = 0
+    scheduled_for: str | None = None
+    created_at: str | None = None
+    updated_at: str | None = None
+
+
+class CampaignActionResponse(WazzapiModel):
+    success: bool
+    campaign_id: str
+    status: str
+
+
+class CampaignExecuteResponse(WazzapiModel):
+    success: bool
+    campaign_id: str
+    status: str
+    total_recipients: int
+    job_id: str | None = None
+
+
+__all__ = [
+    "CampaignActionResponse",
+    "CampaignCreateRequest",
+    "CampaignExecuteResponse",
+    "CampaignItem",
+    "CampaignListResponse",
+    "CampaignResponse",
+    "CampaignUpdateRequest",
+]

wazzapi-0.5.0/wazzapi/models/conversations.py

@@ -0,0 +1,80 @@
+from __future__ import annotations
+
+from datetime import datetime
+
+from .base import WazzapiModel
+
+
+class ConversationItem(WazzapiModel):
+    id: str
+    whatsapp_account_id: str
+    contact_id: str | None = None
+    phone_number: str
+    status: str
+    assignee_user_id: str | None = None
+    subject: str | None = None
+    last_message_preview: str | None = None
+    last_message_at: datetime | None = None
+    last_inbound_at: datetime | None = None
+    last_outbound_at: datetime | None = None
+    unread_count: int
+    created_at: datetime
+    updated_at: datetime
+
+
+class ConversationListResponse(WazzapiModel):
+    conversations: list[ConversationItem]
+    total: int
+    limit: int
+    offset: int
+
+
+class ConversationUpdateRequest(WazzapiModel):
+    status: str | None = None
+    assignee_user_id: str | None = None
+    clear_assignee: bool = False
+    mark_read: bool = False
+
+
+class ConversationMessageItem(WazzapiModel):
+    id: str
+    direction: str
+    content: str
+    status: str
+    message_type: str
+    phone_number: str
+    whatsapp_message_id: str | None = None
+    created_at: datetime
+    sent_at: datetime | None = None
+    delivered_at: datetime | None = None
+    read_at: datetime | None = None
+
+
+class ConversationMessageListResponse(WazzapiModel):
+    messages: list[ConversationMessageItem]
+    total: int
+    limit: int
+    offset: int
+
+
+class ConversationReplyRequest(WazzapiModel):
+    content: str
+    whatsapp_account_id: str | None = None
+
+
+class ConversationReplyResponse(WazzapiModel):
+    success: bool
+    message_id: str
+    conversation_id: str
+    status: str
+
+
+__all__ = [
+    "ConversationItem",
+    "ConversationListResponse",
+    "ConversationMessageItem",
+    "ConversationMessageListResponse",
+    "ConversationReplyRequest",
+    "ConversationReplyResponse",
+    "ConversationUpdateRequest",
+]

wazzapi-0.5.0/wazzapi/models/webhook_subscriptions.py

@@ -0,0 +1,87 @@
+from __future__ import annotations
+
+from datetime import datetime
+
+from .base import WazzapiModel
+
+
+class WebhookCreateRequest(WazzapiModel):
+    url: str
+    subscribed_events: list[str]
+    secret: str | None = None
+    description: str | None = None
+
+
+class WebhookUpdateRequest(WazzapiModel):
+    url: str | None = None
+    subscribed_events: list[str] | None = None
+    is_active: bool | None = None
+    description: str | None = None
+
+
+class WebhookResponse(WazzapiModel):
+    id: str
+    url: str
+    secret_prefix: str
+    subscribed_events: list[str]
+    is_active: bool
+    status: str
+    failure_count: int
+    last_success_at: datetime | None = None
+    last_failure_at: datetime | None = None
+    description: str | None = None
+    created_at: datetime
+    updated_at: datetime
+
+
+class WebhookListItem(WazzapiModel):
+    id: str
+    url: str
+    subscribed_events: list[str]
+    is_active: bool
+    status: str
+    failure_count: int
+    last_success_at: datetime | None = None
+    last_failure_at: datetime | None = None
+    description: str | None = None
+    created_at: datetime
+
+
+class WebhookListResponse(WazzapiModel):
+    webhooks: list[WebhookListItem]
+    total: int
+
+
+class WebhookEventListItem(WazzapiModel):
+    id: str
+    event_type: str
+    status: str
+    retry_count: int
+    response_code: int | None = None
+    error_message: str | None = None
+    created_at: datetime
+    delivered_at: datetime | None = None
+
+
+class WebhookEventListResponse(WazzapiModel):
+    events: list[WebhookEventListItem]
+    total: int
+
+
+class PingWebhookResponse(WazzapiModel):
+    success: bool
+    status_code: int | None = None
+    response_time_ms: int | None = None
+    error: str | None = None
+
+
+__all__ = [
+    "PingWebhookResponse",
+    "WebhookCreateRequest",
+    "WebhookEventListItem",
+    "WebhookEventListResponse",
+    "WebhookListItem",
+    "WebhookListResponse",
+    "WebhookResponse",
+    "WebhookUpdateRequest",
+]

{wazzapi-0.4.0 → wazzapi-0.5.0}/wazzapi/resources/__init__.py

@@ -1,13 +1,19 @@
+from .campaigns import CampaignsResource
 from .contacts import ContactsResource
+from .conversations import ConversationsResource
 from .devices import DevicesResource
 from .groups import GroupsResource
 from .messages import MessagesResource
 from .templates import TemplatesResource
+from .webhook_subscriptions import WebhookSubscriptionsResource
 
 __all__ = [
+	"CampaignsResource",
 	"ContactsResource",
+	"ConversationsResource",
 	"DevicesResource",
 	"GroupsResource",
 	"MessagesResource",
 	"TemplatesResource",
+	"WebhookSubscriptionsResource",
 ]

wazzapi-0.5.0/wazzapi/resources/campaigns.py

@@ -0,0 +1,87 @@
+from __future__ import annotations
+
+from typing import Any
+
+from .. import models
+from .base import BaseResource
+
+
+class CampaignsResource(BaseResource):
+    def list(
+        self,
+        *,
+        limit: int | None = None,
+        offset: int | None = None,
+        status: str | None = None,
+    ) -> models.CampaignListResponse:
+        return self._client._request(
+            "GET",
+            "/api/v1/campaigns",
+            params={"limit": limit, "offset": offset, "status": status},
+            response_model=models.CampaignListResponse,
+        )
+
+    def create(
+        self,
+        payload: models.CampaignCreateRequest | dict[str, Any],
+    ) -> models.CampaignResponse:
+        return self._client._request(
+            "POST",
+            "/api/v1/campaigns",
+            json_body=payload,
+            response_model=models.CampaignResponse,
+        )
+
+    def get(self, campaign_id: str) -> models.CampaignResponse:
+        return self._client._request(
+            "GET",
+            f"/api/v1/campaigns/{campaign_id}",
+            response_model=models.CampaignResponse,
+        )
+
+    def update(
+        self,
+        campaign_id: str,
+        payload: models.CampaignUpdateRequest | dict[str, Any],
+    ) -> models.CampaignResponse:
+        return self._client._request(
+            "PATCH",
+            f"/api/v1/campaigns/{campaign_id}",
+            json_body=payload,
+            response_model=models.CampaignResponse,
+        )
+
+    def delete(self, campaign_id: str) -> None:
+        self._client._request("DELETE", f"/api/v1/campaigns/{campaign_id}")
+        return None
+
+    def execute(self, campaign_id: str) -> models.CampaignExecuteResponse:
+        return self._client._request(
+            "POST",
+            f"/api/v1/campaigns/{campaign_id}/execute",
+            response_model=models.CampaignExecuteResponse,
+        )
+
+    def pause(self, campaign_id: str) -> models.CampaignActionResponse:
+        return self._client._request(
+            "POST",
+            f"/api/v1/campaigns/{campaign_id}/pause",
+            response_model=models.CampaignActionResponse,
+        )
+
+    def resume(self, campaign_id: str) -> models.CampaignActionResponse:
+        return self._client._request(
+            "POST",
+            f"/api/v1/campaigns/{campaign_id}/resume",
+            response_model=models.CampaignActionResponse,
+        )
+
+    def cancel(self, campaign_id: str) -> models.CampaignActionResponse:
+        return self._client._request(
+            "POST",
+            f"/api/v1/campaigns/{campaign_id}/cancel",
+            response_model=models.CampaignActionResponse,
+        )
+
+
+__all__ = ["CampaignsResource"]

wazzapi-0.5.0/wazzapi/resources/conversations.py

@@ -0,0 +1,80 @@
+from __future__ import annotations
+
+from typing import Any
+
+from .. import models
+from .base import BaseResource
+
+
+class ConversationsResource(BaseResource):
+    def list(
+        self,
+        *,
+        limit: int | None = None,
+        offset: int | None = None,
+        status: str | None = None,
+        whatsapp_account_id: str | None = None,
+        assignee_user_id: str | None = None,
+        search: str | None = None,
+    ) -> models.ConversationListResponse:
+        return self._client._request(
+            "GET",
+            "/api/v1/conversations",
+            params={
+                "limit": limit,
+                "offset": offset,
+                "status": status,
+                "whatsapp_account_id": whatsapp_account_id,
+                "assignee_user_id": assignee_user_id,
+                "search": search,
+            },
+            response_model=models.ConversationListResponse,
+        )
+
+    def get(self, conversation_id: str) -> models.ConversationItem:
+        return self._client._request(
+            "GET",
+            f"/api/v1/conversations/{conversation_id}",
+            response_model=models.ConversationItem,
+        )
+
+    def update(
+        self,
+        conversation_id: str,
+        payload: models.ConversationUpdateRequest | dict[str, Any],
+    ) -> models.ConversationItem:
+        return self._client._request(
+            "PATCH",
+            f"/api/v1/conversations/{conversation_id}",
+            json_body=payload,
+            response_model=models.ConversationItem,
+        )
+
+    def list_messages(
+        self,
+        conversation_id: str,
+        *,
+        limit: int | None = None,
+        offset: int | None = None,
+    ) -> models.ConversationMessageListResponse:
+        return self._client._request(
+            "GET",
+            f"/api/v1/conversations/{conversation_id}/messages",
+            params={"limit": limit, "offset": offset},
+            response_model=models.ConversationMessageListResponse,
+        )
+
+    def reply(
+        self,
+        conversation_id: str,
+        payload: models.ConversationReplyRequest | dict[str, Any],
+    ) -> models.ConversationReplyResponse:
+        return self._client._request(
+            "POST",
+            f"/api/v1/conversations/{conversation_id}/reply",
+            json_body=payload,
+            response_model=models.ConversationReplyResponse,
+        )
+
+
+__all__ = ["ConversationsResource"]

wazzapi-0.5.0/wazzapi/resources/devices.py

@@ -0,0 +1,99 @@
+from __future__ import annotations
+
+from .. import models
+from .base import BaseResource
+
+
+class DevicesResource(BaseResource):
+    def list(
+        self,
+        *,
+        limit: int | None = None,
+        offset: int | None = None,
+        status: str | None = None,
+        search: str | None = None,
+        sort_by: str | None = None,
+        sort_order: str | None = None,
+    ) -> models.DeviceListResponse:
+        return self._client._request(
+            "GET",
+            "/api/v1/devices",
+            params={
+                "limit": limit,
+                "offset": offset,
+                "status": status,
+                "search": search,
+                "sort_by": sort_by,
+                "sort_order": sort_order,
+            },
+            response_model=models.DeviceListResponse,
+        )
+
+    def get(self, device_id: str) -> models.DeviceResponse:
+        return self._client._request(
+            "GET",
+            f"/api/v1/devices/{device_id}",
+            response_model=models.DeviceResponse,
+        )
+
+    def link(self, payload: dict) -> dict:
+        return self._client._request(
+            "POST",
+            "/api/v1/devices",
+            json_body=payload,
+            response_model=dict,
+        )
+
+    def get_qr(self, device_id: str) -> dict:
+        return self._client._request(
+            "GET",
+            f"/api/v1/devices/{device_id}/qr",
+            response_model=dict,
+        )
+
+    def get_status(self, device_id: str) -> dict:
+        return self._client._request(
+            "GET",
+            f"/api/v1/devices/{device_id}/status",
+            response_model=dict,
+        )
+
+    def disconnect(self, device_id: str) -> dict:
+        return self._client._request(
+            "POST",
+            f"/api/v1/devices/{device_id}/disconnect",
+            response_model=dict,
+        )
+
+    def reconnect(self, device_id: str) -> dict:
+        return self._client._request(
+            "POST",
+            f"/api/v1/devices/{device_id}/reconnect",
+            response_model=dict,
+        )
+
+    def get_proxy(self, device_id: str) -> dict:
+        return self._client._request(
+            "GET",
+            f"/api/v1/devices/{device_id}/proxy",
+            response_model=dict,
+        )
+
+    def update_proxy(self, device_id: str, payload: dict) -> dict:
+        return self._client._request(
+            "PATCH",
+            f"/api/v1/devices/{device_id}/proxy",
+            json_body=payload,
+            response_model=dict,
+        )
+
+    def test_proxy(self, payload: dict) -> dict:
+        return self._client._request(
+            "POST",
+            "/api/v1/devices/proxy/test",
+            json_body=payload,
+            response_model=dict,
+        )
+
+
+__all__ = ["DevicesResource"]

wazzapi-0.5.0/wazzapi/resources/webhook_subscriptions.py

@@ -0,0 +1,80 @@
+from __future__ import annotations
+
+from typing import Any
+
+from .. import models
+from .base import BaseResource
+
+
+class WebhookSubscriptionsResource(BaseResource):
+    def list(
+        self,
+        *,
+        limit: int | None = None,
+        offset: int | None = None,
+        active_only: bool | None = None,
+    ) -> models.WebhookListResponse:
+        return self._client._request(
+            "GET",
+            "/api/v1/webhooks/subscriptions",
+            params={"limit": limit, "offset": offset, "active_only": active_only},
+            response_model=models.WebhookListResponse,
+        )
+
+    def create(
+        self,
+        payload: models.WebhookCreateRequest | dict[str, Any],
+    ) -> models.WebhookResponse:
+        return self._client._request(
+            "POST",
+            "/api/v1/webhooks/subscriptions",
+            json_body=payload,
+            response_model=models.WebhookResponse,
+        )
+
+    def get(self, webhook_id: str) -> models.WebhookResponse:
+        return self._client._request(
+            "GET",
+            f"/api/v1/webhooks/subscriptions/{webhook_id}",
+            response_model=models.WebhookResponse,
+        )
+
+    def update(
+        self,
+        webhook_id: str,
+        payload: models.WebhookUpdateRequest | dict[str, Any],
+    ) -> models.WebhookResponse:
+        return self._client._request(
+            "PATCH",
+            f"/api/v1/webhooks/subscriptions/{webhook_id}",
+            json_body=payload,
+            response_model=models.WebhookResponse,
+        )
+
+    def delete(self, webhook_id: str) -> None:
+        self._client._request("DELETE", f"/api/v1/webhooks/subscriptions/{webhook_id}")
+        return None
+
+    def list_events(
+        self,
+        webhook_id: str,
+        *,
+        limit: int | None = None,
+        offset: int | None = None,
+    ) -> models.WebhookEventListResponse:
+        return self._client._request(
+            "GET",
+            f"/api/v1/webhooks/subscriptions/{webhook_id}/events",
+            params={"limit": limit, "offset": offset},
+            response_model=models.WebhookEventListResponse,
+        )
+
+    def ping(self, webhook_id: str) -> models.PingWebhookResponse:
+        return self._client._request(
+            "POST",
+            f"/api/v1/webhooks/subscriptions/{webhook_id}/ping",
+            response_model=models.PingWebhookResponse,
+        )
+
+
+__all__ = ["WebhookSubscriptionsResource"]

wazzapi-0.4.0/wazzapi/resources/devices.py

@@ -1,40 +0,0 @@
-from __future__ import annotations
-
-from .. import models
-from .base import BaseResource
-
-
-class DevicesResource(BaseResource):
-    def list(
-        self,
-        *,
-        limit: int | None = None,
-        offset: int | None = None,
-        status: str | None = None,
-        search: str | None = None,
-        sort_by: str | None = None,
-        sort_order: str | None = None,
-    ) -> models.DeviceListResponse:
-        return self._client._request(
-            "GET",
-            "/api/v1/devices",
-            params={
-                "limit": limit,
-                "offset": offset,
-                "status": status,
-                "search": search,
-                "sort_by": sort_by,
-                "sort_order": sort_order,
-            },
-            response_model=models.DeviceListResponse,
-        )
-
-    def get(self, device_id: str) -> models.DeviceResponse:
-        return self._client._request(
-            "GET",
-            f"/api/v1/devices/{device_id}",
-            response_model=models.DeviceResponse,
-        )
-
-
-__all__ = ["DevicesResource"]