telnyx 3.7.0__py3-none-any.whl → 3.8.0__py3-none-any.whl

telnyx/__init__.py

@@ -24,6 +24,7 @@ from ._exceptions import (
     InternalServerError,
     PermissionDeniedError,
     UnprocessableEntityError,
+    APIWebhookValidationError,
     APIResponseValidationError,
 )
 from ._base_client import DefaultHttpxClient, DefaultAioHttpClient, DefaultAsyncHttpxClient
@@ -47,6 +48,7 @@ __all__ = [
     "APITimeoutError",
     "APIConnectionError",
     "APIResponseValidationError",
+    "APIWebhookValidationError",
     "BadRequestError",
     "AuthenticationError",
     "PermissionDeniedError",

telnyx/_client.py

@@ -346,11 +346,13 @@ class Telnyx(SyncAPIClient):
 
     # client options
     api_key: str
+    public_key: str | None
 
     def __init__(
         self,
         *,
         api_key: str | None = None,
+        public_key: str | None = None,
         base_url: str | httpx.URL | None = None,
         timeout: float | Timeout | None | NotGiven = not_given,
         max_retries: int = DEFAULT_MAX_RETRIES,
@@ -372,7 +374,9 @@ class Telnyx(SyncAPIClient):
     ) -> None:
         """Construct a new synchronous Telnyx client instance.
 
-        This automatically infers the `api_key` argument from the `TELNYX_API_KEY` environment variable if it is not provided.
+        This automatically infers the following arguments from their corresponding environment variables if they are not provided:
+        - `api_key` from `TELNYX_API_KEY`
+        - `public_key` from `TELNYX_PUBLIC_KEY`
         """
         if api_key is None:
             api_key = os.environ.get("TELNYX_API_KEY")
@@ -382,6 +386,10 @@ class Telnyx(SyncAPIClient):
             )
         self.api_key = api_key
 
+        if public_key is None:
+            public_key = os.environ.get("TELNYX_PUBLIC_KEY")
+        self.public_key = public_key
+
         if base_url is None:
             base_url = os.environ.get("TELNYX_BASE_URL")
         self._base_url_overridden = base_url is not None
@@ -586,6 +594,7 @@ class Telnyx(SyncAPIClient):
         self,
         *,
         api_key: str | None = None,
+        public_key: str | None = None,
         base_url: str | httpx.URL | None = None,
         timeout: float | Timeout | None | NotGiven = not_given,
         http_client: httpx.Client | None = None,
@@ -620,6 +629,7 @@ class Telnyx(SyncAPIClient):
         http_client = http_client or self._client
         client = self.__class__(
             api_key=api_key or self.api_key,
+            public_key=public_key or self.public_key,
             base_url=base_url or self.base_url,
             timeout=self.timeout if isinstance(timeout, NotGiven) else timeout,
             http_client=http_client,
@@ -829,11 +839,13 @@ class AsyncTelnyx(AsyncAPIClient):
 
     # client options
     api_key: str
+    public_key: str | None
 
     def __init__(
         self,
         *,
         api_key: str | None = None,
+        public_key: str | None = None,
         base_url: str | httpx.URL | None = None,
         timeout: float | Timeout | None | NotGiven = not_given,
         max_retries: int = DEFAULT_MAX_RETRIES,
@@ -855,7 +867,9 @@ class AsyncTelnyx(AsyncAPIClient):
     ) -> None:
         """Construct a new async AsyncTelnyx client instance.
 
-        This automatically infers the `api_key` argument from the `TELNYX_API_KEY` environment variable if it is not provided.
+        This automatically infers the following arguments from their corresponding environment variables if they are not provided:
+        - `api_key` from `TELNYX_API_KEY`
+        - `public_key` from `TELNYX_PUBLIC_KEY`
         """
         if api_key is None:
             api_key = os.environ.get("TELNYX_API_KEY")
@@ -865,6 +879,10 @@ class AsyncTelnyx(AsyncAPIClient):
             )
         self.api_key = api_key
 
+        if public_key is None:
+            public_key = os.environ.get("TELNYX_PUBLIC_KEY")
+        self.public_key = public_key
+
         if base_url is None:
             base_url = os.environ.get("TELNYX_BASE_URL")
         self._base_url_overridden = base_url is not None
@@ -1075,6 +1093,7 @@ class AsyncTelnyx(AsyncAPIClient):
         self,
         *,
         api_key: str | None = None,
+        public_key: str | None = None,
         base_url: str | httpx.URL | None = None,
         timeout: float | Timeout | None | NotGiven = not_given,
         http_client: httpx.AsyncClient | None = None,
@@ -1109,6 +1128,7 @@ class AsyncTelnyx(AsyncAPIClient):
         http_client = http_client or self._client
         client = self.__class__(
             api_key=api_key or self.api_key,
+            public_key=public_key or self.public_key,
             base_url=base_url or self.base_url,
             timeout=self.timeout if isinstance(timeout, NotGiven) else timeout,
             http_client=http_client,

telnyx/_exceptions.py

@@ -54,6 +54,10 @@ class APIResponseValidationError(APIError):
         self.status_code = response.status_code
 
 
+class APIWebhookValidationError(APIError):
+    pass
+
+
 class APIStatusError(APIError):
     """Raised when an API response has a status code of 4xx or 5xx."""
 

telnyx/_version.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__ = "telnyx"
-__version__ = "3.7.0"  # x-release-please-version
+__version__ = "3.8.0"  # x-release-please-version

telnyx/resources/webhooks.py

@@ -3,10 +3,11 @@
 from __future__ import annotations
 
 import json
-from typing import cast
+from typing import Mapping, cast
 
 from .._models import construct_type
 from .._resource import SyncAPIResource, AsyncAPIResource
+from .._exceptions import TelnyxError
 from ..types.unwrap_webhook_event import UnwrapWebhookEvent
 from ..types.unsafe_unwrap_webhook_event import UnsafeUnwrapWebhookEvent
 
@@ -23,7 +24,24 @@ class WebhooksResource(SyncAPIResource):
             ),
         )
 
-    def unwrap(self, payload: str) -> UnwrapWebhookEvent:
+    def unwrap(self, payload: str, *, headers: Mapping[str, str], key: str | bytes | None = None) -> UnwrapWebhookEvent:
+        try:
+            from standardwebhooks import Webhook
+        except ImportError as exc:
+            raise TelnyxError("You need to install `telnyx[webhooks]` to use this method") from exc
+
+        if key is None:
+            key = self._client.public_key
+            if key is None:
+                raise ValueError(
+                    "Cannot verify a webhook without a key on either the client's public_key or passed in as an argument"
+                )
+
+        if not isinstance(headers, dict):
+            headers = dict(headers)
+
+        Webhook(key).verify(payload, headers)
+
         return cast(
             UnwrapWebhookEvent,
             construct_type(
@@ -43,7 +61,24 @@ class AsyncWebhooksResource(AsyncAPIResource):
             ),
         )
 
-    def unwrap(self, payload: str) -> UnwrapWebhookEvent:
+    def unwrap(self, payload: str, *, headers: Mapping[str, str], key: str | bytes | None = None) -> UnwrapWebhookEvent:
+        try:
+            from standardwebhooks import Webhook
+        except ImportError as exc:
+            raise TelnyxError("You need to install `telnyx[webhooks]` to use this method") from exc
+
+        if key is None:
+            key = self._client.public_key
+            if key is None:
+                raise ValueError(
+                    "Cannot verify a webhook without a key on either the client's public_key or passed in as an argument"
+                )
+
+        if not isinstance(headers, dict):
+            headers = dict(headers)
+
+        Webhook(key).verify(payload, headers)
+
         return cast(
             UnwrapWebhookEvent,
             construct_type(

{telnyx-3.7.0.dist-info → telnyx-3.8.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: telnyx
-Version: 3.7.0
+Version: 3.8.0
 Summary: The official Python library for the telnyx API
 Project-URL: Homepage, https://github.com/team-telnyx/telnyx-python
 Project-URL: Repository, https://github.com/team-telnyx/telnyx-python
@@ -31,6 +31,8 @@ Requires-Dist: typing-extensions<5,>=4.10
 Provides-Extra: aiohttp
 Requires-Dist: aiohttp; extra == 'aiohttp'
 Requires-Dist: httpx-aiohttp>=0.1.9; extra == 'aiohttp'
+Provides-Extra: webhooks
+Requires-Dist: standardwebhooks; extra == 'webhooks'
 Description-Content-Type: text/markdown
 
 # Telnyx Python API library

{telnyx-3.7.0.dist-info → telnyx-3.8.0.dist-info}/RECORD

@@ -1,9 +1,9 @@
-telnyx/__init__.py,sha256=3-DgWAbbqhu1tue85Ax20QcixYIXWHkCM4hjXNG62YU,2624
+telnyx/__init__.py,sha256=8Oaoo-GIP7ZrRHTmGXjXOzx75x18QdsuDdeLrueG4C4,2688
 telnyx/_base_client.py,sha256=NudksDGruga_s-IhQR4dYAEz7mc3QDOJfZPLjFdOghI,67047
-telnyx/_client.py,sha256=ounZy7ojuyvcyvhMPW2egrx54a-KkKlcVwDlnzAV56Y,144540
+telnyx/_client.py,sha256=hHoAlmLBsyYgAmo27xXYySwlmjBn_R5d_jZFt14LA9Q,145306
 telnyx/_compat.py,sha256=DQBVORjFb33zch24jzkhM14msvnzY7mmSmgDLaVFUM8,6562
 telnyx/_constants.py,sha256=S14PFzyN9-I31wiV7SmIlL5Ga0MLHxdvegInGdXH7tM,462
-telnyx/_exceptions.py,sha256=D9kyl_aKwKQ1618MjC8SZPmL5qLUyfnZzyO9TTKS3mo,3220
+telnyx/_exceptions.py,sha256=SbhO_R6Bai0lSqs0McbW7wl1iAyoBX1uYNjvX77hwKk,3274
 telnyx/_files.py,sha256=sDy00jrSguKZf-dx9WnJzRyQplNz_b-_zMIVL31CjIo,3619
 telnyx/_models.py,sha256=lKnskYPONAWDvWo8tmbbVk7HmG7UOsI0Nve0vSMmkRc,30452
 telnyx/_qs.py,sha256=craIKyvPktJ94cvf9zn8j8ekG9dWJzhWv0ob34lIOv4,4828
@@ -11,7 +11,7 @@ telnyx/_resource.py,sha256=B4Qg-uO2a34FQHHZskn89eVURqMuSvv1TdeBJH1z1rU,1100
 telnyx/_response.py,sha256=4X24wr7uQn2hnM_b0xqQ92zSgxRFFfWG2lTg93-KzNo,28788
 telnyx/_streaming.py,sha256=OfSFcMQJ_mnvfkbIdOG7Ajp0SMbXnOJSga4xXHjNAJk,10100
 telnyx/_types.py,sha256=Du3G2vdqeLhhdJZ4Jtck4vOqEvAKI9rB1FnrwB1b_k8,7236
-telnyx/_version.py,sha256=6difl5H15TQ-x-ufn7wQ7HirApSV9w0UJDrTiDz2BJA,158
+telnyx/_version.py,sha256=lwpU2hAJbxRw1J5zKphT95CVY5KhP9FxxxnGrX2ydns,158
 telnyx/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 telnyx/_utils/__init__.py,sha256=7fch0GT9zpNnErbciSpUNa-SjTxxjY6kxHxKMOM4AGs,2305
 telnyx/_utils/_compat.py,sha256=D8gtAvjJQrDWt9upS0XaG9Rr5l1QhiAx_I_1utT_tt0,1195
@@ -134,7 +134,7 @@ telnyx/resources/verify_profiles.py,sha256=p04zuJk1_we5Ez6OyRVq-KE1EALdgVjzmXukG
 telnyx/resources/virtual_cross_connects.py,sha256=JDAXB9dhVNn-qAiTyNDAgYELHdFwGoqS6yM5l4NrDZA,34715
 telnyx/resources/virtual_cross_connects_coverage.py,sha256=LE0l4hJJCO8jsaanpA85fa_wGNHgsZO4yPpf1RoNRCQ,9320
 telnyx/resources/webhook_deliveries.py,sha256=PKo-2i1Ndhe3i7zozog3d0Ko5dznDshsOqLeogdXah0,11174
-telnyx/resources/webhooks.py,sha256=3efI08Km5S3XwumQ57JlVQqnwSBIJ2OVEVNyP8aOh1s,1585
+telnyx/resources/webhooks.py,sha256=Z25U-Umbj3DlGMsoSozv_ULe_dwmoL9oZ2FuuuQNkbA,2944
 telnyx/resources/well_known.py,sha256=3Nm9gDqj9nDawaMoSj-yy3z_3dhDdBjK0NqOR0NJg4I,8881
 telnyx/resources/wireguard_interfaces.py,sha256=wxfoFKlIQ4We6Zi9huXfN2Y_xAYZN5_IK6ziEGggM4I,18414
 telnyx/resources/wireguard_peers.py,sha256=FefL6ivnxn6uq2vJY6hvzCzTm1wlqWiifc4D81QYSSE,24615
@@ -2096,7 +2096,7 @@ telnyx/types/wireless/detail_records_report_list_params.py,sha256=cfjsh4L_8mpDkg
 telnyx/types/wireless/detail_records_report_list_response.py,sha256=S_6nD0fm5EseRIZHnML-UN0-g8Q_0J1cXfg_eLNUev8,331
 telnyx/types/wireless/detail_records_report_retrieve_response.py,sha256=f0C8z8uo_QeCyi3nSDME4f4F3vqcy7o0MpinwDIqe_s,327
 telnyx/types/wireless/wdr_report.py,sha256=bxRr-dc_IW6D0E3i_PUHK-bbu9w114Qql1uoJ_znxEE,1068
-telnyx-3.7.0.dist-info/METADATA,sha256=armfTqG7VrMuWHf3Dxkj3Z7WymvYKXoXg3otWiIkOxo,15530
-telnyx-3.7.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-telnyx-3.7.0.dist-info/licenses/LICENSE,sha256=PprdXvskBJR41_t2uhgs5rHYGME_Ek-lh2PAxKtdZs8,1046
-telnyx-3.7.0.dist-info/RECORD,,
+telnyx-3.8.0.dist-info/METADATA,sha256=ODFtLiKVlZYhyzYvN7SI5CyEl3lra5IFqZK2W8rr2pM,15608
+telnyx-3.8.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+telnyx-3.8.0.dist-info/licenses/LICENSE,sha256=PprdXvskBJR41_t2uhgs5rHYGME_Ek-lh2PAxKtdZs8,1046
+telnyx-3.8.0.dist-info/RECORD,,