Release v0.58.0 (sdk-python/v0.58.0)

Author: bird-release[bot]

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.58.0
+
+- Add `client.whatsapp.templates` methods to list and get WhatsApp templates, their versions, and each version's languages.
+- **Breaking:** a WhatsApp send of a template you authored now picks its language the way that template says to, so a call that already worked can resolve to a different language or stop resolving at all: omitting `language` sends the template's `default_language` rather than the sole approved language, and a language the template does not stock is served by the closest match or refused according to the template's `on_missing_language` setting. Check that each template's `default_language` is one WhatsApp approved, and handle three refusals new to those sends: `E15007` for a language tag WhatsApp does not support, `E15077` when the template cannot send in the language you asked for, and `E15076` when the template sets `language_source_required` and your send names no language. A send served by a language other than the one you asked for is priced at that language's category, because WhatsApp categorizes each language separately, so sends already made under a template WhatsApp recategorized are worth re-checking.
+- Fields with custom examples now enforce their declared validation rules, including template `slug` and `language` values and WhatsApp `in_reply_to_message_id`.
+
 ## 0.57.0
 
 - A sending domain's DNS record now sets `error` while its status is still `pending`, reporting that the record published in DNS does not match the expected value.

examples/examples.gen.py

@@ -1011,5 +1011,41 @@ async def _ex_151() -> None:
 
 
 async def _ex_152() -> None:
+    tpl = client.whatsapp.templates.get("bird_otp")
+    print(tpl.default_language, tpl.available_languages)
+
+
+async def _ex_153() -> None:
+    for tpl in client.whatsapp.templates.list():
+        print(tpl.slug, tpl.status)
+
+
+async def _ex_154() -> None:
+    version = client.whatsapp.templates.versions.get("bird_otp", "wav_01ky4x8e4genzb7way45txfkm1")
+    print(version.id, list(version.languages))
+
+
+async def _ex_155() -> None:
+    language = client.whatsapp.templates.versions.languages.get(
+        "bird_otp", "wav_01ky4x8e4genzb7way45txfkm1", "nl-BE"
+    )
+    for component in language.components:
+        print(component.type)
+
+
+async def _ex_156() -> None:
+    languages = client.whatsapp.templates.versions.languages.list(
+        "bird_otp", "wav_01ky4x8e4genzb7way45txfkm1"
+    )
+    for language in languages.data:
+        print(language.language, language.status)
+
+
+async def _ex_157() -> None:
+    for version in client.whatsapp.templates.versions.list("bird_otp"):
+        print(version.id, version.version_number)
+
+
+async def _ex_158() -> None:
     workspace = client.workspace.get()
     print(workspace.id, workspace.name)

examples/reference/whatsapp.py

@@ -26,3 +26,39 @@ def whatsapp_list_events() -> None:
     events = client.whatsapp.list_events("wa_abc123")
     for event in events.data:
         print(event.type, event.occurred_at)
+
+
+def whatsapp_templates_list() -> None:
+    for tpl in client.whatsapp.templates.list():
+        print(tpl.slug, tpl.status)
+
+
+def whatsapp_templates_get() -> None:
+    tpl = client.whatsapp.templates.get("bird_otp")
+    print(tpl.default_language, tpl.available_languages)
+
+
+def whatsapp_templates_versions_list() -> None:
+    for version in client.whatsapp.templates.versions.list("bird_otp"):
+        print(version.id, version.version_number)
+
+
+def whatsapp_templates_versions_get() -> None:
+    version = client.whatsapp.templates.versions.get("bird_otp", "wav_01ky4x8e4genzb7way45txfkm1")
+    print(version.id, list(version.languages))
+
+
+def whatsapp_templates_versions_languages_list() -> None:
+    languages = client.whatsapp.templates.versions.languages.list(
+        "bird_otp", "wav_01ky4x8e4genzb7way45txfkm1"
+    )
+    for language in languages.data:
+        print(language.language, language.status)
+
+
+def whatsapp_templates_versions_languages_get() -> None:
+    language = client.whatsapp.templates.versions.languages.get(
+        "bird_otp", "wav_01ky4x8e4genzb7way45txfkm1", "nl-BE"
+    )
+    for component in language.components:
+        print(component.type)

scripts/surface_ops.py

@@ -53,6 +53,12 @@
     "/v1/whatsapp/messages/{message_id}": {"get"},
     "/v1/whatsapp/messages/{message_id}/events": {"get"},
     "/v1/whatsapp/messages/{message_id}/media/{media_id}": {"get"},
+    "/v1/whatsapp/templates": {"get"},
+    "/v1/whatsapp/templates/{template_ref}": {"get"},
+    "/v1/whatsapp/templates/{template_ref}/versions": {"get"},
+    "/v1/whatsapp/templates/{template_ref}/versions/{version_id}": {"get"},
+    "/v1/whatsapp/templates/{template_ref}/versions/{version_id}/languages": {"get"},
+    "/v1/whatsapp/templates/{template_ref}/versions/{version_id}/languages/{language}": {"get"},
     "/v1/voice/calls": {"get"},
     "/v1/voice/calls/{call_id}": {"get"},
     "/v1/verify/verifications": {"post"},

src/bird/__init__.py

@@ -89,6 +89,12 @@
     WhatsAppEvent,
     WhatsAppEventList,
     WhatsAppMessage,
+    WhatsAppTemplate,
+    WhatsAppTemplateLanguage,
+    WhatsAppTemplateLanguageList,
+    WhatsAppTemplateList,
+    WhatsAppTemplateVersion,
+    WhatsAppTemplateVersionSummary,
 )
 from bird.resources.audiences_gen import (
     AudienceAddContactsParams,
@@ -168,7 +174,10 @@
     WhatsAppInteractiveReplyType,
     WhatsAppInteractiveType,
     WhatsAppTemplateCategory,
+    WhatsAppTemplateLanguageStatus,
     WhatsAppTemplateParameterType,
+    WhatsAppTemplateQualityScore,
+    WhatsAppTemplateRejectionCategory,
 )
 from bird.resources.realtime import ChannelAuthorization
 from bird.resources.webhooks import GenericWebhookEvent
@@ -300,6 +309,12 @@
     "WhatsAppMessage",
     "WhatsAppEvent",
     "WhatsAppEventList",
+    "WhatsAppTemplate",
+    "WhatsAppTemplateList",
+    "WhatsAppTemplateVersion",
+    "WhatsAppTemplateVersionSummary",
+    "WhatsAppTemplateLanguage",
+    "WhatsAppTemplateLanguageList",
     "VerifyVerificationsCreateParams",
     "VerifyVerificationsCheckParams",
     "VerifyVerificationsNextChannelParams",
@@ -341,7 +356,10 @@
     "WhatsAppInteractiveReplyType",
     "WhatsAppInteractiveType",
     "WhatsAppTemplateCategory",
+    "WhatsAppTemplateLanguageStatus",
     "WhatsAppTemplateParameterType",
+    "WhatsAppTemplateQualityScore",
+    "WhatsAppTemplateRejectionCategory",
     "BirdError",
     "APIError",
     "APIStatusError",