feat(api): add support for broadcasts

It is now possible to send, validate, list, retrieve, upsert, and cancel [broadcasts](https://docs.knock.app/concepts/broadcasts).

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 45
+configured_endpoints: 51
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/knock%2Fknock-mapi-3ecceed264a62adba59c787f105549f62109739328db523366159f22c2ed1ee6.yml
 openapi_spec_hash: 80b5362bf4f1ce98bc016406dc7e1bed
-config_hash: 34780c6a4340e5f9ddfb18f6b534eea5
+config_hash: 2d70cc65ea0584a49b00c63529ca6799

api.md

@@ -284,3 +284,27 @@ Methods:
 - <code title="get /v1/branches/{branch_slug}">client.branches.<a href="./src/knock_mapi/resources/branches.py">retrieve</a>(branch_slug, \*\*<a href="src/knock_mapi/types/branch_retrieve_params.py">params</a>) -> <a href="./src/knock_mapi/types/branch.py">Branch</a></code>
 - <code title="get /v1/branches">client.branches.<a href="./src/knock_mapi/resources/branches.py">list</a>(\*\*<a href="src/knock_mapi/types/branch_list_params.py">params</a>) -> <a href="./src/knock_mapi/types/branch.py">SyncEntriesCursor[Branch]</a></code>
 - <code title="delete /v1/branches/{branch_slug}">client.branches.<a href="./src/knock_mapi/resources/branches.py">delete</a>(branch_slug, \*\*<a href="src/knock_mapi/types/branch_delete_params.py">params</a>) -> None</code>
+
+# Broadcasts
+
+Types:
+
+```python
+from knock_mapi.types import (
+    Broadcast,
+    BroadcastRequest,
+    BroadcastCancelResponse,
+    BroadcastSendResponse,
+    BroadcastUpsertResponse,
+    BroadcastValidateResponse,
+)
+```
+
+Methods:
+
+- <code title="get /v1/broadcasts/{broadcast_key}">client.broadcasts.<a href="./src/knock_mapi/resources/broadcasts.py">retrieve</a>(broadcast_key, \*\*<a href="src/knock_mapi/types/broadcast_retrieve_params.py">params</a>) -> <a href="./src/knock_mapi/types/broadcast.py">Broadcast</a></code>
+- <code title="get /v1/broadcasts">client.broadcasts.<a href="./src/knock_mapi/resources/broadcasts.py">list</a>(\*\*<a href="src/knock_mapi/types/broadcast_list_params.py">params</a>) -> <a href="./src/knock_mapi/types/broadcast.py">SyncEntriesCursor[Broadcast]</a></code>
+- <code title="put /v1/broadcasts/{broadcast_key}/cancel">client.broadcasts.<a href="./src/knock_mapi/resources/broadcasts.py">cancel</a>(broadcast_key, \*\*<a href="src/knock_mapi/types/broadcast_cancel_params.py">params</a>) -> <a href="./src/knock_mapi/types/broadcast_cancel_response.py">BroadcastCancelResponse</a></code>
+- <code title="put /v1/broadcasts/{broadcast_key}/send">client.broadcasts.<a href="./src/knock_mapi/resources/broadcasts.py">send</a>(broadcast_key, \*\*<a href="src/knock_mapi/types/broadcast_send_params.py">params</a>) -> <a href="./src/knock_mapi/types/broadcast_send_response.py">BroadcastSendResponse</a></code>
+- <code title="put /v1/broadcasts/{broadcast_key}">client.broadcasts.<a href="./src/knock_mapi/resources/broadcasts.py">upsert</a>(broadcast_key, \*\*<a href="src/knock_mapi/types/broadcast_upsert_params.py">params</a>) -> <a href="./src/knock_mapi/types/broadcast_upsert_response.py">BroadcastUpsertResponse</a></code>
+- <code title="put /v1/broadcasts/{broadcast_key}/validate">client.broadcasts.<a href="./src/knock_mapi/resources/broadcasts.py">validate</a>(broadcast_key, \*\*<a href="src/knock_mapi/types/broadcast_validate_params.py">params</a>) -> <a href="./src/knock_mapi/types/broadcast_validate_response.py">BroadcastValidateResponse</a></code>

src/knock_mapi/_client.py

@@ -30,6 +30,7 @@
     channels,
     partials,
     variables,
+    broadcasts,
     environments,
     translations,
     email_layouts,
@@ -72,6 +73,7 @@ class KnockMgmt(SyncAPIClient):
     variables: variables.VariablesResource
     guides: guides.GuidesResource
     branches: branches.BranchesResource
+    broadcasts: broadcasts.BroadcastsResource
     with_raw_response: KnockMgmtWithRawResponse
     with_streaming_response: KnockMgmtWithStreamedResponse
 
@@ -143,6 +145,7 @@ def __init__(
         self.variables = variables.VariablesResource(self)
         self.guides = guides.GuidesResource(self)
         self.branches = branches.BranchesResource(self)
+        self.broadcasts = broadcasts.BroadcastsResource(self)
         self.with_raw_response = KnockMgmtWithRawResponse(self)
         self.with_streaming_response = KnockMgmtWithStreamedResponse(self)
 
@@ -266,6 +269,7 @@ class AsyncKnockMgmt(AsyncAPIClient):
     variables: variables.AsyncVariablesResource
     guides: guides.AsyncGuidesResource
     branches: branches.AsyncBranchesResource
+    broadcasts: broadcasts.AsyncBroadcastsResource
     with_raw_response: AsyncKnockMgmtWithRawResponse
     with_streaming_response: AsyncKnockMgmtWithStreamedResponse
 
@@ -337,6 +341,7 @@ def __init__(
         self.variables = variables.AsyncVariablesResource(self)
         self.guides = guides.AsyncGuidesResource(self)
         self.branches = branches.AsyncBranchesResource(self)
+        self.broadcasts = broadcasts.AsyncBroadcastsResource(self)
         self.with_raw_response = AsyncKnockMgmtWithRawResponse(self)
         self.with_streaming_response = AsyncKnockMgmtWithStreamedResponse(self)
 
@@ -461,6 +466,7 @@ def __init__(self, client: KnockMgmt) -> None:
         self.variables = variables.VariablesResourceWithRawResponse(client.variables)
         self.guides = guides.GuidesResourceWithRawResponse(client.guides)
         self.branches = branches.BranchesResourceWithRawResponse(client.branches)
+        self.broadcasts = broadcasts.BroadcastsResourceWithRawResponse(client.broadcasts)
 
 
 class AsyncKnockMgmtWithRawResponse:
@@ -479,6 +485,7 @@ def __init__(self, client: AsyncKnockMgmt) -> None:
         self.variables = variables.AsyncVariablesResourceWithRawResponse(client.variables)
         self.guides = guides.AsyncGuidesResourceWithRawResponse(client.guides)
         self.branches = branches.AsyncBranchesResourceWithRawResponse(client.branches)
+        self.broadcasts = broadcasts.AsyncBroadcastsResourceWithRawResponse(client.broadcasts)
 
 
 class KnockMgmtWithStreamedResponse:
@@ -497,6 +504,7 @@ def __init__(self, client: KnockMgmt) -> None:
         self.variables = variables.VariablesResourceWithStreamingResponse(client.variables)
         self.guides = guides.GuidesResourceWithStreamingResponse(client.guides)
         self.branches = branches.BranchesResourceWithStreamingResponse(client.branches)
+        self.broadcasts = broadcasts.BroadcastsResourceWithStreamingResponse(client.broadcasts)
 
 
 class AsyncKnockMgmtWithStreamedResponse:
@@ -515,6 +523,7 @@ def __init__(self, client: AsyncKnockMgmt) -> None:
         self.variables = variables.AsyncVariablesResourceWithStreamingResponse(client.variables)
         self.guides = guides.AsyncGuidesResourceWithStreamingResponse(client.guides)
         self.branches = branches.AsyncBranchesResourceWithStreamingResponse(client.branches)
+        self.broadcasts = broadcasts.AsyncBroadcastsResourceWithStreamingResponse(client.broadcasts)
 
 
 Client = KnockMgmt

src/knock_mapi/resources/__init__.py

@@ -72,6 +72,14 @@
     WorkflowsResourceWithStreamingResponse,
     AsyncWorkflowsResourceWithStreamingResponse,
 )
+from .broadcasts import (
+    BroadcastsResource,
+    AsyncBroadcastsResource,
+    BroadcastsResourceWithRawResponse,
+    AsyncBroadcastsResourceWithRawResponse,
+    BroadcastsResourceWithStreamingResponse,
+    AsyncBroadcastsResourceWithStreamingResponse,
+)
 from .environments import (
     EnvironmentsResource,
     AsyncEnvironmentsResource,
@@ -198,4 +206,10 @@
     "AsyncBranchesResourceWithRawResponse",
     "BranchesResourceWithStreamingResponse",
     "AsyncBranchesResourceWithStreamingResponse",
+    "BroadcastsResource",
+    "AsyncBroadcastsResource",
+    "BroadcastsResourceWithRawResponse",
+    "AsyncBroadcastsResourceWithRawResponse",
+    "BroadcastsResourceWithStreamingResponse",
+    "AsyncBroadcastsResourceWithStreamingResponse",
 ]