diff --git a/.release-please-manifest.json b/.release-please-manifest.json index e1a2442..f7014c3 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "0.10.1" + ".": "0.11.0" } \ No newline at end of file diff --git a/.stats.yml b/.stats.yml index 190a1ac..43af8ad 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ -configured_endpoints: 35 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/zavu%2Fzavudev-85dfcb4cc3f8dc232241dbb9a4ac493e076382453af15bf5a1915141381b6f0f.yml -openapi_spec_hash: 7ee3ffc9cd38e0a05837a67dfb382214 -config_hash: c5064558e83c1689ffeee7ef09f5d03a +configured_endpoints: 36 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/zavu%2Fzavudev-578694e0208b4129909ee690abbebfb5ac9e5738768a009c9bfb7aa638a3c984.yml +openapi_spec_hash: 842323c611aa7ea50f039e852d1594cf +config_hash: ff624ca864b3c882a793f2af6b971127 diff --git a/CHANGELOG.md b/CHANGELOG.md index 94a1ad1..7726314 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,17 @@ # Changelog +## 0.11.0 (2025-12-16) + +Full Changelog: [v0.10.1...v0.11.0](https://github.com/zavudev/sdk-python/compare/v0.10.1...v0.11.0) + +### Features + +* **api:** api update ([bb8af00](https://github.com/zavudev/sdk-python/commit/bb8af003e952918262b8502959de28520de6ed10)) +* **api:** api update ([39a0632](https://github.com/zavudev/sdk-python/commit/39a0632944c04190ccaf8b56db9dc245d758c5c6)) +* **api:** api update ([69c25f3](https://github.com/zavudev/sdk-python/commit/69c25f337070ddc7756fe61a6324f1b1d4eb2dd8)) +* **api:** api update ([575e5ea](https://github.com/zavudev/sdk-python/commit/575e5eaa04124422b74f4268410f010a37908c6e)) +* **api:** manual updates ([8fedeac](https://github.com/zavudev/sdk-python/commit/8fedeac87ef5a5f1b6fa9781e9cfbbe80a50ab74)) + ## 0.10.1 (2025-12-09) Full Changelog: [v0.10.0...v0.10.1](https://github.com/zavudev/sdk-python/compare/v0.10.0...v0.10.1) diff --git a/api.md b/api.md index a7f8cde..1cf9fc1 100644 --- a/api.md +++ b/api.md @@ -40,7 +40,7 @@ Methods: Types: ```python -from zavudev.types import Sender +from zavudev.types import Sender, SenderWebhook, WebhookEvent, WebhookSecretResponse ``` Methods: @@ -50,6 +50,7 @@ Methods: - client.senders.update(sender_id, \*\*params) -> Sender - client.senders.list(\*\*params) -> SyncCursor[Sender] - client.senders.delete(sender_id) -> None +- client.senders.regenerate_webhook_secret(sender_id) -> WebhookSecretResponse # Contacts diff --git a/pyproject.toml b/pyproject.toml index 461d8a2..efb74b1 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "zavudev" -version = "0.10.1" +version = "0.11.0" description = "The official Python library for the zavudev API" dynamic = ["readme"] license = "Apache-2.0" diff --git a/src/zavudev/_version.py b/src/zavudev/_version.py index c54b92b..dd3c25c 100644 --- a/src/zavudev/_version.py +++ b/src/zavudev/_version.py @@ -1,4 +1,4 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. __title__ = "zavudev" -__version__ = "0.10.1" # x-release-please-version +__version__ = "0.11.0" # x-release-please-version diff --git a/src/zavudev/resources/senders.py b/src/zavudev/resources/senders.py index e219733..10d881a 100644 --- a/src/zavudev/resources/senders.py +++ b/src/zavudev/resources/senders.py @@ -2,6 +2,8 @@ from __future__ import annotations +from typing import List, Optional + import httpx from ..types import sender_list_params, sender_create_params, sender_update_params @@ -18,6 +20,8 @@ from ..pagination import SyncCursor, AsyncCursor from .._base_client import AsyncPaginator, make_request_options from ..types.sender import Sender +from ..types.webhook_event import WebhookEvent +from ..types.webhook_secret_response import WebhookSecretResponse __all__ = ["SendersResource", "AsyncSendersResource"] @@ -48,6 +52,8 @@ def create( name: str, phone_number: str, set_as_default: bool | Omit = omit, + webhook_events: List[WebhookEvent] | Omit = omit, + webhook_url: str | Omit = omit, # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. # The extra values given here take precedence over values defined on the client or passed to this method. extra_headers: Headers | None = None, @@ -59,6 +65,10 @@ def create( Create sender Args: + webhook_events: Events to subscribe to. + + webhook_url: HTTPS URL for webhook events. + extra_headers: Send extra headers extra_query: Add additional query parameters to the request @@ -74,6 +84,8 @@ def create( "name": name, "phone_number": phone_number, "set_as_default": set_as_default, + "webhook_events": webhook_events, + "webhook_url": webhook_url, }, sender_create_params.SenderCreateParams, ), @@ -122,6 +134,9 @@ def update( *, name: str | Omit = omit, set_as_default: bool | Omit = omit, + webhook_active: bool | Omit = omit, + webhook_events: List[WebhookEvent] | Omit = omit, + webhook_url: Optional[str] | Omit = omit, # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. # The extra values given here take precedence over values defined on the client or passed to this method. extra_headers: Headers | None = None, @@ -133,6 +148,12 @@ def update( Update sender Args: + webhook_active: Whether the webhook is active. + + webhook_events: Events to subscribe to. + + webhook_url: HTTPS URL for webhook events. Set to null to remove webhook. + extra_headers: Send extra headers extra_query: Add additional query parameters to the request @@ -149,6 +170,9 @@ def update( { "name": name, "set_as_default": set_as_default, + "webhook_active": webhook_active, + "webhook_events": webhook_events, + "webhook_url": webhook_url, }, sender_update_params.SenderUpdateParams, ), @@ -235,6 +259,41 @@ def delete( cast_to=NoneType, ) + def regenerate_webhook_secret( + self, + sender_id: str, + *, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> WebhookSecretResponse: + """Regenerate the webhook secret for a sender. + + The old secret will be invalidated + immediately. + + Args: + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not sender_id: + raise ValueError(f"Expected a non-empty value for `sender_id` but received {sender_id!r}") + return self._post( + f"/v1/senders/{sender_id}/webhook/secret", + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=WebhookSecretResponse, + ) + class AsyncSendersResource(AsyncAPIResource): @cached_property @@ -262,6 +321,8 @@ async def create( name: str, phone_number: str, set_as_default: bool | Omit = omit, + webhook_events: List[WebhookEvent] | Omit = omit, + webhook_url: str | Omit = omit, # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. # The extra values given here take precedence over values defined on the client or passed to this method. extra_headers: Headers | None = None, @@ -273,6 +334,10 @@ async def create( Create sender Args: + webhook_events: Events to subscribe to. + + webhook_url: HTTPS URL for webhook events. + extra_headers: Send extra headers extra_query: Add additional query parameters to the request @@ -288,6 +353,8 @@ async def create( "name": name, "phone_number": phone_number, "set_as_default": set_as_default, + "webhook_events": webhook_events, + "webhook_url": webhook_url, }, sender_create_params.SenderCreateParams, ), @@ -336,6 +403,9 @@ async def update( *, name: str | Omit = omit, set_as_default: bool | Omit = omit, + webhook_active: bool | Omit = omit, + webhook_events: List[WebhookEvent] | Omit = omit, + webhook_url: Optional[str] | Omit = omit, # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. # The extra values given here take precedence over values defined on the client or passed to this method. extra_headers: Headers | None = None, @@ -347,6 +417,12 @@ async def update( Update sender Args: + webhook_active: Whether the webhook is active. + + webhook_events: Events to subscribe to. + + webhook_url: HTTPS URL for webhook events. Set to null to remove webhook. + extra_headers: Send extra headers extra_query: Add additional query parameters to the request @@ -363,6 +439,9 @@ async def update( { "name": name, "set_as_default": set_as_default, + "webhook_active": webhook_active, + "webhook_events": webhook_events, + "webhook_url": webhook_url, }, sender_update_params.SenderUpdateParams, ), @@ -449,6 +528,41 @@ async def delete( cast_to=NoneType, ) + async def regenerate_webhook_secret( + self, + sender_id: str, + *, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> WebhookSecretResponse: + """Regenerate the webhook secret for a sender. + + The old secret will be invalidated + immediately. + + Args: + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not sender_id: + raise ValueError(f"Expected a non-empty value for `sender_id` but received {sender_id!r}") + return await self._post( + f"/v1/senders/{sender_id}/webhook/secret", + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=WebhookSecretResponse, + ) + class SendersResourceWithRawResponse: def __init__(self, senders: SendersResource) -> None: @@ -469,6 +583,9 @@ def __init__(self, senders: SendersResource) -> None: self.delete = to_raw_response_wrapper( senders.delete, ) + self.regenerate_webhook_secret = to_raw_response_wrapper( + senders.regenerate_webhook_secret, + ) class AsyncSendersResourceWithRawResponse: @@ -490,6 +607,9 @@ def __init__(self, senders: AsyncSendersResource) -> None: self.delete = async_to_raw_response_wrapper( senders.delete, ) + self.regenerate_webhook_secret = async_to_raw_response_wrapper( + senders.regenerate_webhook_secret, + ) class SendersResourceWithStreamingResponse: @@ -511,6 +631,9 @@ def __init__(self, senders: SendersResource) -> None: self.delete = to_streamed_response_wrapper( senders.delete, ) + self.regenerate_webhook_secret = to_streamed_response_wrapper( + senders.regenerate_webhook_secret, + ) class AsyncSendersResourceWithStreamingResponse: @@ -532,3 +655,6 @@ def __init__(self, senders: AsyncSendersResource) -> None: self.delete = async_to_streamed_response_wrapper( senders.delete, ) + self.regenerate_webhook_secret = async_to_streamed_response_wrapper( + senders.regenerate_webhook_secret, + ) diff --git a/src/zavudev/types/__init__.py b/src/zavudev/types/__init__.py index b29ae4f..4e4ca73 100644 --- a/src/zavudev/types/__init__.py +++ b/src/zavudev/types/__init__.py @@ -10,7 +10,9 @@ from .broadcast import Broadcast as Broadcast from .line_type import LineType as LineType from .message_type import MessageType as MessageType +from .webhook_event import WebhookEvent as WebhookEvent from .message_status import MessageStatus as MessageStatus +from .sender_webhook import SenderWebhook as SenderWebhook from .message_content import MessageContent as MessageContent from .broadcast_status import BroadcastStatus as BroadcastStatus from .message_response import MessageResponse as MessageResponse @@ -42,6 +44,7 @@ from .broadcast_create_params import BroadcastCreateParams as BroadcastCreateParams from .broadcast_send_response import BroadcastSendResponse as BroadcastSendResponse from .broadcast_update_params import BroadcastUpdateParams as BroadcastUpdateParams +from .webhook_secret_response import WebhookSecretResponse as WebhookSecretResponse from .broadcast_contact_status import BroadcastContactStatus as BroadcastContactStatus from .phone_number_list_params import PhoneNumberListParams as PhoneNumberListParams from .broadcast_cancel_response import BroadcastCancelResponse as BroadcastCancelResponse diff --git a/src/zavudev/types/contact.py b/src/zavudev/types/contact.py index 76df5a2..11f391d 100644 --- a/src/zavudev/types/contact.py +++ b/src/zavudev/types/contact.py @@ -29,6 +29,9 @@ class Contact(BaseModel): metadata: Optional[Dict[str, str]] = None + profile_name: Optional[str] = FieldInfo(alias="profileName", default=None) + """Contact's WhatsApp profile name. Only available for WhatsApp contacts.""" + updated_at: Optional[datetime] = FieldInfo(alias="updatedAt", default=None) verified: Optional[bool] = None diff --git a/src/zavudev/types/sender.py b/src/zavudev/types/sender.py index daacd97..8dd927e 100644 --- a/src/zavudev/types/sender.py +++ b/src/zavudev/types/sender.py @@ -6,6 +6,7 @@ from pydantic import Field as FieldInfo from .._models import BaseModel +from .sender_webhook import SenderWebhook __all__ = ["Sender"] @@ -24,3 +25,6 @@ class Sender(BaseModel): """Whether this sender is the project's default.""" updated_at: Optional[datetime] = FieldInfo(alias="updatedAt", default=None) + + webhook: Optional[SenderWebhook] = None + """Webhook configuration for the sender.""" diff --git a/src/zavudev/types/sender_create_params.py b/src/zavudev/types/sender_create_params.py index 9dc6c1a..6204c76 100644 --- a/src/zavudev/types/sender_create_params.py +++ b/src/zavudev/types/sender_create_params.py @@ -2,9 +2,11 @@ from __future__ import annotations +from typing import List from typing_extensions import Required, Annotated, TypedDict from .._utils import PropertyInfo +from .webhook_event import WebhookEvent __all__ = ["SenderCreateParams"] @@ -15,3 +17,9 @@ class SenderCreateParams(TypedDict, total=False): phone_number: Required[Annotated[str, PropertyInfo(alias="phoneNumber")]] set_as_default: Annotated[bool, PropertyInfo(alias="setAsDefault")] + + webhook_events: Annotated[List[WebhookEvent], PropertyInfo(alias="webhookEvents")] + """Events to subscribe to.""" + + webhook_url: Annotated[str, PropertyInfo(alias="webhookUrl")] + """HTTPS URL for webhook events.""" diff --git a/src/zavudev/types/sender_update_params.py b/src/zavudev/types/sender_update_params.py index 4889d60..6edcec8 100644 --- a/src/zavudev/types/sender_update_params.py +++ b/src/zavudev/types/sender_update_params.py @@ -2,9 +2,11 @@ from __future__ import annotations +from typing import List, Optional from typing_extensions import Annotated, TypedDict from .._utils import PropertyInfo +from .webhook_event import WebhookEvent __all__ = ["SenderUpdateParams"] @@ -13,3 +15,12 @@ class SenderUpdateParams(TypedDict, total=False): name: str set_as_default: Annotated[bool, PropertyInfo(alias="setAsDefault")] + + webhook_active: Annotated[bool, PropertyInfo(alias="webhookActive")] + """Whether the webhook is active.""" + + webhook_events: Annotated[List[WebhookEvent], PropertyInfo(alias="webhookEvents")] + """Events to subscribe to.""" + + webhook_url: Annotated[Optional[str], PropertyInfo(alias="webhookUrl")] + """HTTPS URL for webhook events. Set to null to remove webhook.""" diff --git a/src/zavudev/types/sender_webhook.py b/src/zavudev/types/sender_webhook.py new file mode 100644 index 0000000..e6ef71c --- /dev/null +++ b/src/zavudev/types/sender_webhook.py @@ -0,0 +1,27 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List, Optional + +from .._models import BaseModel +from .webhook_event import WebhookEvent + +__all__ = ["SenderWebhook"] + + +class SenderWebhook(BaseModel): + """Webhook configuration for the sender.""" + + active: bool + """Whether the webhook is active.""" + + events: List[WebhookEvent] + """List of events the webhook is subscribed to.""" + + url: str + """HTTPS URL that will receive webhook events.""" + + secret: Optional[str] = None + """Webhook secret for signature verification. + + Only returned on create or regenerate. + """ diff --git a/src/zavudev/types/webhook_event.py b/src/zavudev/types/webhook_event.py new file mode 100644 index 0000000..5d606e6 --- /dev/null +++ b/src/zavudev/types/webhook_event.py @@ -0,0 +1,16 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing_extensions import Literal, TypeAlias + +__all__ = ["WebhookEvent"] + +WebhookEvent: TypeAlias = Literal[ + "message.queued", + "message.sent", + "message.delivered", + "message.failed", + "message.inbound", + "message.unsupported", + "conversation.new", + "template.status_changed", +] diff --git a/src/zavudev/types/webhook_secret_response.py b/src/zavudev/types/webhook_secret_response.py new file mode 100644 index 0000000..a382b87 --- /dev/null +++ b/src/zavudev/types/webhook_secret_response.py @@ -0,0 +1,10 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from .._models import BaseModel + +__all__ = ["WebhookSecretResponse"] + + +class WebhookSecretResponse(BaseModel): + secret: str + """The new webhook secret.""" diff --git a/tests/api_resources/test_senders.py b/tests/api_resources/test_senders.py index eac13fa..5811de8 100644 --- a/tests/api_resources/test_senders.py +++ b/tests/api_resources/test_senders.py @@ -9,7 +9,7 @@ from zavudev import Zavudev, AsyncZavudev from tests.utils import assert_matches_type -from zavudev.types import Sender +from zavudev.types import Sender, WebhookSecretResponse from zavudev.pagination import SyncCursor, AsyncCursor base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") @@ -34,6 +34,8 @@ def test_method_create_with_all_params(self, client: Zavudev) -> None: name="name", phone_number="phoneNumber", set_as_default=True, + webhook_events=["message.queued"], + webhook_url="https://example.com", ) assert_matches_type(Sender, sender, path=["response"]) @@ -122,6 +124,9 @@ def test_method_update_with_all_params(self, client: Zavudev) -> None: sender_id="senderId", name="name", set_as_default=True, + webhook_active=True, + webhook_events=["message.queued"], + webhook_url="https://example.com", ) assert_matches_type(Sender, sender, path=["response"]) @@ -238,6 +243,48 @@ def test_path_params_delete(self, client: Zavudev) -> None: "", ) + @pytest.mark.skip(reason="Prism tests are disabled") + @parametrize + def test_method_regenerate_webhook_secret(self, client: Zavudev) -> None: + sender = client.senders.regenerate_webhook_secret( + "senderId", + ) + assert_matches_type(WebhookSecretResponse, sender, path=["response"]) + + @pytest.mark.skip(reason="Prism tests are disabled") + @parametrize + def test_raw_response_regenerate_webhook_secret(self, client: Zavudev) -> None: + response = client.senders.with_raw_response.regenerate_webhook_secret( + "senderId", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + sender = response.parse() + assert_matches_type(WebhookSecretResponse, sender, path=["response"]) + + @pytest.mark.skip(reason="Prism tests are disabled") + @parametrize + def test_streaming_response_regenerate_webhook_secret(self, client: Zavudev) -> None: + with client.senders.with_streaming_response.regenerate_webhook_secret( + "senderId", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + sender = response.parse() + assert_matches_type(WebhookSecretResponse, sender, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @pytest.mark.skip(reason="Prism tests are disabled") + @parametrize + def test_path_params_regenerate_webhook_secret(self, client: Zavudev) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `sender_id` but received ''"): + client.senders.with_raw_response.regenerate_webhook_secret( + "", + ) + class TestAsyncSenders: parametrize = pytest.mark.parametrize( @@ -260,6 +307,8 @@ async def test_method_create_with_all_params(self, async_client: AsyncZavudev) - name="name", phone_number="phoneNumber", set_as_default=True, + webhook_events=["message.queued"], + webhook_url="https://example.com", ) assert_matches_type(Sender, sender, path=["response"]) @@ -348,6 +397,9 @@ async def test_method_update_with_all_params(self, async_client: AsyncZavudev) - sender_id="senderId", name="name", set_as_default=True, + webhook_active=True, + webhook_events=["message.queued"], + webhook_url="https://example.com", ) assert_matches_type(Sender, sender, path=["response"]) @@ -463,3 +515,45 @@ async def test_path_params_delete(self, async_client: AsyncZavudev) -> None: await async_client.senders.with_raw_response.delete( "", ) + + @pytest.mark.skip(reason="Prism tests are disabled") + @parametrize + async def test_method_regenerate_webhook_secret(self, async_client: AsyncZavudev) -> None: + sender = await async_client.senders.regenerate_webhook_secret( + "senderId", + ) + assert_matches_type(WebhookSecretResponse, sender, path=["response"]) + + @pytest.mark.skip(reason="Prism tests are disabled") + @parametrize + async def test_raw_response_regenerate_webhook_secret(self, async_client: AsyncZavudev) -> None: + response = await async_client.senders.with_raw_response.regenerate_webhook_secret( + "senderId", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + sender = await response.parse() + assert_matches_type(WebhookSecretResponse, sender, path=["response"]) + + @pytest.mark.skip(reason="Prism tests are disabled") + @parametrize + async def test_streaming_response_regenerate_webhook_secret(self, async_client: AsyncZavudev) -> None: + async with async_client.senders.with_streaming_response.regenerate_webhook_secret( + "senderId", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + sender = await response.parse() + assert_matches_type(WebhookSecretResponse, sender, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @pytest.mark.skip(reason="Prism tests are disabled") + @parametrize + async def test_path_params_regenerate_webhook_secret(self, async_client: AsyncZavudev) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `sender_id` but received ''"): + await async_client.senders.with_raw_response.regenerate_webhook_secret( + "", + )