feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 73
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/knock/knock-mapi-58321f620bf0bdfb4513c30fd185449659d0e25685a25198cf301837609a9141.yml
-openapi_spec_hash: e48c1ec498ba7f1eff10da98f619754e
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/knock/knock-mapi-d9a8f56bda3b292ce411b2e224166f5e91571a51683a353fcff2c472553c7d3a.yml
+openapi_spec_hash: 1dee9829c5853a1d103298568c6edb05
 config_hash: 1543050ac0815a90f8fc8158f853af03

src/knock_mapi/resources/data_sources.py

@@ -169,7 +169,7 @@ def list_logs(
         date: str | Omit = omit,
         ending_at: Union[str, datetime] | Omit = omit,
         event: str | Omit = omit,
-        includes: List[Literal["actions"]] | Omit = omit,
+        include: List[Literal["actions"]] | Omit = omit,
         limit: int | Omit = omit,
         starting_at: Union[str, datetime] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -199,7 +199,7 @@ def list_logs(
 
           event: The event name to filter by.
 
-          includes: Associated resources to include in the response. Accepts `actions` to include
+          include: Associated resources to include in the response. Accepts `actions` to include
               the actions executed after receiving each source event.
 
           limit: The number of entries to fetch per-page.
@@ -233,7 +233,7 @@ def list_logs(
                         "date": date,
                         "ending_at": ending_at,
                         "event": event,
-                        "includes": includes,
+                        "include": include,
                         "limit": limit,
                         "starting_at": starting_at,
                     },
@@ -265,7 +265,9 @@ def list_providers(
     def list_sources(
         self,
         *,
+        annotate: bool | Omit = omit,
         environment: str | Omit = omit,
+        include: List[Literal["environment_settings"]] | 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,
@@ -277,8 +279,12 @@ def list_sources(
         Returns connected sources for the project.
 
         Args:
+          annotate: Whether to annotate the resource. Only used in the Knock CLI.
+
           environment: The environment slug.
 
+          include: Associated resources to include in each source. Accepts `environment_settings`.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -295,7 +301,12 @@ def list_sources(
                 extra_body=extra_body,
                 timeout=timeout,
                 query=maybe_transform(
-                    {"environment": environment}, data_source_list_sources_params.DataSourceListSourcesParams
+                    {
+                        "annotate": annotate,
+                        "environment": environment,
+                        "include": include,
+                    },
+                    data_source_list_sources_params.DataSourceListSourcesParams,
                 ),
             ),
             cast_to=SourcesResponse,
@@ -354,7 +365,7 @@ def retrieve_provider(
         self,
         key: str,
         *,
-        includes: List[
+        include: List[
             Literal["branding", "default_action_mappings", "example_payloads", "preprocessing_script", "static_fields"]
         ]
         | Omit = omit,
@@ -369,7 +380,7 @@ def retrieve_provider(
         Returns a source provider template available for creating sources.
 
         Args:
-          includes: Associated resources to include in the response. Accepts `branding`,
+          include: Associated resources to include in the response. Accepts `branding`,
               `default_action_mappings`, `example_payloads`, `preprocessing_script`,
               `static_fields`.
 
@@ -391,7 +402,7 @@ def retrieve_provider(
                 extra_body=extra_body,
                 timeout=timeout,
                 query=maybe_transform(
-                    {"includes": includes}, data_source_retrieve_provider_params.DataSourceRetrieveProviderParams
+                    {"include": include}, data_source_retrieve_provider_params.DataSourceRetrieveProviderParams
                 ),
             ),
             cast_to=SourceProviderResponse,
@@ -621,7 +632,7 @@ def list_logs(
         date: str | Omit = omit,
         ending_at: Union[str, datetime] | Omit = omit,
         event: str | Omit = omit,
-        includes: List[Literal["actions"]] | Omit = omit,
+        include: List[Literal["actions"]] | Omit = omit,
         limit: int | Omit = omit,
         starting_at: Union[str, datetime] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -651,7 +662,7 @@ def list_logs(
 
           event: The event name to filter by.
 
-          includes: Associated resources to include in the response. Accepts `actions` to include
+          include: Associated resources to include in the response. Accepts `actions` to include
               the actions executed after receiving each source event.
 
           limit: The number of entries to fetch per-page.
@@ -685,7 +696,7 @@ def list_logs(
                         "date": date,
                         "ending_at": ending_at,
                         "event": event,
-                        "includes": includes,
+                        "include": include,
                         "limit": limit,
                         "starting_at": starting_at,
                     },
@@ -717,7 +728,9 @@ async def list_providers(
     async def list_sources(
         self,
         *,
+        annotate: bool | Omit = omit,
         environment: str | Omit = omit,
+        include: List[Literal["environment_settings"]] | 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,
@@ -729,8 +742,12 @@ async def list_sources(
         Returns connected sources for the project.
 
         Args:
+          annotate: Whether to annotate the resource. Only used in the Knock CLI.
+
           environment: The environment slug.
 
+          include: Associated resources to include in each source. Accepts `environment_settings`.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -747,7 +764,12 @@ async def list_sources(
                 extra_body=extra_body,
                 timeout=timeout,
                 query=await async_maybe_transform(
-                    {"environment": environment}, data_source_list_sources_params.DataSourceListSourcesParams
+                    {
+                        "annotate": annotate,
+                        "environment": environment,
+                        "include": include,
+                    },
+                    data_source_list_sources_params.DataSourceListSourcesParams,
                 ),
             ),
             cast_to=SourcesResponse,
@@ -808,7 +830,7 @@ async def retrieve_provider(
         self,
         key: str,
         *,
-        includes: List[
+        include: List[
             Literal["branding", "default_action_mappings", "example_payloads", "preprocessing_script", "static_fields"]
         ]
         | Omit = omit,
@@ -823,7 +845,7 @@ async def retrieve_provider(
         Returns a source provider template available for creating sources.
 
         Args:
-          includes: Associated resources to include in the response. Accepts `branding`,
+          include: Associated resources to include in the response. Accepts `branding`,
               `default_action_mappings`, `example_payloads`, `preprocessing_script`,
               `static_fields`.
 
@@ -845,7 +867,7 @@ async def retrieve_provider(
                 extra_body=extra_body,
                 timeout=timeout,
                 query=await async_maybe_transform(
-                    {"includes": includes}, data_source_retrieve_provider_params.DataSourceRetrieveProviderParams
+                    {"include": include}, data_source_retrieve_provider_params.DataSourceRetrieveProviderParams
                 ),
             ),
             cast_to=SourceProviderResponse,

src/knock_mapi/types/data_source_list_logs_params.py

@@ -33,7 +33,7 @@ class DataSourceListLogsParams(TypedDict, total=False):
     event: str
     """The event name to filter by."""
 
-    includes: List[Literal["actions"]]
+    include: List[Literal["actions"]]
     """Associated resources to include in the response.
 
     Accepts `actions` to include the actions executed after receiving each source

src/knock_mapi/types/data_source_list_sources_params.py

@@ -2,11 +2,18 @@
 
 from __future__ import annotations
 
-from typing_extensions import TypedDict
+from typing import List
+from typing_extensions import Literal, TypedDict
 
 __all__ = ["DataSourceListSourcesParams"]
 
 
 class DataSourceListSourcesParams(TypedDict, total=False):
+    annotate: bool
+    """Whether to annotate the resource. Only used in the Knock CLI."""
+
     environment: str
     """The environment slug."""
+
+    include: List[Literal["environment_settings"]]
+    """Associated resources to include in each source. Accepts `environment_settings`."""

src/knock_mapi/types/data_source_retrieve_provider_params.py

@@ -9,7 +9,7 @@
 
 
 class DataSourceRetrieveProviderParams(TypedDict, total=False):
-    includes: List[
+    include: List[
         Literal["branding", "default_action_mappings", "example_payloads", "preprocessing_script", "static_fields"]
     ]
     """Associated resources to include in the response.

src/knock_mapi/types/source_log.py

@@ -21,7 +21,7 @@ class SourceLog(BaseModel):
     actions: Optional[List[SourceLogAction]] = None
     """The actions executed after receiving the source event.
 
-    Only present when `includes` contains `actions`.
+    Only present when `include` contains `actions`.
     """
 
     data: Optional[Dict[str, object]] = None

src/knock_mapi/types/source_logs_response.py

@@ -12,7 +12,7 @@
 class SourceLogsResponse(BaseModel):
     """A paginated list of source logs.
 
-    Include `actions` in the `includes` query parameter to return action details for each log.
+    Include `actions` in the `include` query parameter to return action details for each log.
     """
 
     entries: List[SourceLog]

src/knock_mapi/types/source_provider_response.py

@@ -21,7 +21,7 @@
 class DefaultSettingsPreprocessingScript(BaseModel):
     """Verification script source code.
 
-    Only present when `includes` contains `preprocessing_script`.
+    Only present when `include` contains `preprocessing_script`.
     """
 
     language: Literal["javascript"]
@@ -46,7 +46,7 @@ class DefaultSettings(BaseModel):
     preprocessing_script: Optional[DefaultSettingsPreprocessingScript] = None
     """Verification script source code.
 
-    Only present when `includes` contains `preprocessing_script`.
+    Only present when `include` contains `preprocessing_script`.
     """
 
     timestamp_path: Optional[str] = None
@@ -70,7 +70,7 @@ class ProviderBrandingColors(BaseModel):
 
 
 class ProviderBranding(BaseModel):
-    """Provider branding assets. Only present when `includes` contains `branding`."""
+    """Provider branding assets. Only present when `include` contains `branding`."""
 
     icon_image: str
     """Provider icon image URL or path."""
@@ -101,7 +101,7 @@ class Provider(BaseModel):
     """Provider website URL."""
 
     branding: Optional[ProviderBranding] = None
-    """Provider branding assets. Only present when `includes` contains `branding`."""
+    """Provider branding assets. Only present when `include` contains `branding`."""
 
     knock_tutorial_url: Optional[str] = None
     """Knock tutorial URL for setting up the provider."""
@@ -159,7 +159,7 @@ class SourceProviderResponse(BaseModel):
     default_action_mappings: Optional[List[DefaultActionMapping]] = None
     """Default event action mappings for the provider.
 
-    Only present when `includes` contains `default_action_mappings`.
+    Only present when `include` contains `default_action_mappings`.
     """
 
     example_payloads: Optional[Dict[str, List[ExamplePayload]]] = None
@@ -168,5 +168,5 @@ class SourceProviderResponse(BaseModel):
     static_fields: Optional[Dict[str, object]] = None
     """JSON Schema fields needed to configure the source.
 
-    Only present when `includes` contains `static_fields`.
+    Only present when `include` contains `static_fields`.
     """

src/knock_mapi/types/sources_response.py

@@ -1,8 +1,9 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-from typing import List, Optional
+from typing import Dict, List, Optional
 
 from .._models import BaseModel
+from .source_environment_settings import SourceEnvironmentSettings
 
 __all__ = ["SourcesResponse", "Entry"]
 
@@ -22,6 +23,12 @@ class Entry(BaseModel):
     description: Optional[str] = None
     """Source description."""
 
+    environment_settings: Optional[Dict[str, SourceEnvironmentSettings]] = None
+    """Per-environment settings keyed by environment slug.
+
+    Present only when requested via `include`.
+    """
+
 
 class SourcesResponse(BaseModel):
     """Sources connected to the project."""

tests/api_resources/test_data_sources.py

@@ -157,7 +157,7 @@ def test_method_list_logs_with_all_params(self, client: KnockMgmt) -> None:
             date="date",
             ending_at=parse_datetime("2019-12-27T18:11:19.117Z"),
             event="event",
-            includes=["actions"],
+            include=["actions"],
             limit=0,
             starting_at=parse_datetime("2019-12-27T18:11:19.117Z"),
         )
@@ -238,7 +238,9 @@ def test_method_list_sources(self, client: KnockMgmt) -> None:
     @parametrize
     def test_method_list_sources_with_all_params(self, client: KnockMgmt) -> None:
         data_source = client.data_sources.list_sources(
+            annotate=True,
             environment="development",
+            include=["environment_settings"],
         )
         assert_matches_type(SourcesResponse, data_source, path=["response"])
 
@@ -339,7 +341,7 @@ def test_method_retrieve_provider(self, client: KnockMgmt) -> None:
     def test_method_retrieve_provider_with_all_params(self, client: KnockMgmt) -> None:
         data_source = client.data_sources.retrieve_provider(
             key="key",
-            includes=["branding"],
+            include=["branding"],
         )
         assert_matches_type(SourceProviderResponse, data_source, path=["response"])
 
@@ -651,7 +653,7 @@ async def test_method_list_logs_with_all_params(self, async_client: AsyncKnockMg
             date="date",
             ending_at=parse_datetime("2019-12-27T18:11:19.117Z"),
             event="event",
-            includes=["actions"],
+            include=["actions"],
             limit=0,
             starting_at=parse_datetime("2019-12-27T18:11:19.117Z"),
         )
@@ -732,7 +734,9 @@ async def test_method_list_sources(self, async_client: AsyncKnockMgmt) -> None:
     @parametrize
     async def test_method_list_sources_with_all_params(self, async_client: AsyncKnockMgmt) -> None:
         data_source = await async_client.data_sources.list_sources(
+            annotate=True,
             environment="development",
+            include=["environment_settings"],
         )
         assert_matches_type(SourcesResponse, data_source, path=["response"])
 
@@ -833,7 +837,7 @@ async def test_method_retrieve_provider(self, async_client: AsyncKnockMgmt) -> N
     async def test_method_retrieve_provider_with_all_params(self, async_client: AsyncKnockMgmt) -> None:
         data_source = await async_client.data_sources.retrieve_provider(
             key="key",
-            includes=["branding"],
+            include=["branding"],
         )
         assert_matches_type(SourceProviderResponse, data_source, path=["response"])