feat(api): api update

stainless-app[bot] · stainless-app[bot] · commit 3b0de8f5166e · 2025-05-31T02:42:13.000Z
diff --git a/.stats.yml b/.stats.yml
@@ -1,4 +1,4 @@
 configured_endpoints: 114
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-6d2a5b5d2cfb485e1a548aa15e1e36844e1f14f42553033822e1c570c8aa0825.yml
-openapi_spec_hash: 0266a5aaced5e768bcf6a70924d69799
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-faced218bf2dee89c8449bdb209e7090452d26c0646f0b998f84fe5bd3c4b7cb.yml
+openapi_spec_hash: b3a957e9c012fad5093545f65614ea42
 config_hash: e63f2d098e5d12f63ae4cd8270aa5c3c
diff --git a/src/orb/resources/events/events.py b/src/orb/resources/events/events.py
@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import List, Union, Iterable, Optional
+from typing import Dict, List, Union, Iterable, Optional
 from datetime import datetime
 
 import httpx
@@ -72,7 +72,7 @@ def update(
         event_id: str,
         *,
         event_name: str,
-        properties: object,
+        properties: Dict[str, object],
         timestamp: Union[str, datetime],
         customer_id: Optional[str] | NotGiven = NOT_GIVEN,
         external_customer_id: Optional[str] | NotGiven = NOT_GIVEN,
@@ -623,7 +623,7 @@ async def update(
         event_id: str,
         *,
         event_name: str,
-        properties: object,
+        properties: Dict[str, object],
         timestamp: Union[str, datetime],
         customer_id: Optional[str] | NotGiven = NOT_GIVEN,
         external_customer_id: Optional[str] | NotGiven = NOT_GIVEN,
diff --git a/src/orb/types/customers/credits/top_up_create_by_external_id_params.py b/src/orb/types/customers/credits/top_up_create_by_external_id_params.py
@@ -70,6 +70,8 @@ class InvoiceSettings(TypedDict, total=False):
 
     require_successful_payment: bool
     """
-    If true, new credit blocks created by this top-up will require that the
-    corresponding invoice is paid before they can be drawn down from.
+    When true, credit blocks created by this top-up will require that the
+    corresponding invoice is paid before they are drawn down from. If any topup
+    block is pending payment, further automatic top-ups will be paused until the
+    invoice is paid or voided.
     """
diff --git a/src/orb/types/customers/credits/top_up_create_by_external_id_response.py b/src/orb/types/customers/credits/top_up_create_by_external_id_response.py
@@ -27,8 +27,10 @@ class InvoiceSettings(BaseModel):
 
     require_successful_payment: Optional[bool] = None
     """
-    If true, new credit blocks created by this top-up will require that the
-    corresponding invoice is paid before they can be drawn down from.
+    When true, credit blocks created by this top-up will require that the
+    corresponding invoice is paid before they are drawn down from. If any topup
+    block is pending payment, further automatic top-ups will be paused until the
+    invoice is paid or voided.
     """
 
 
diff --git a/src/orb/types/customers/credits/top_up_create_params.py b/src/orb/types/customers/credits/top_up_create_params.py
@@ -70,6 +70,8 @@ class InvoiceSettings(TypedDict, total=False):
 
     require_successful_payment: bool
     """
-    If true, new credit blocks created by this top-up will require that the
-    corresponding invoice is paid before they can be drawn down from.
+    When true, credit blocks created by this top-up will require that the
+    corresponding invoice is paid before they are drawn down from. If any topup
+    block is pending payment, further automatic top-ups will be paused until the
+    invoice is paid or voided.
     """
diff --git a/src/orb/types/customers/credits/top_up_create_response.py b/src/orb/types/customers/credits/top_up_create_response.py
@@ -27,8 +27,10 @@ class InvoiceSettings(BaseModel):
 
     require_successful_payment: Optional[bool] = None
     """
-    If true, new credit blocks created by this top-up will require that the
-    corresponding invoice is paid before they can be drawn down from.
+    When true, credit blocks created by this top-up will require that the
+    corresponding invoice is paid before they are drawn down from. If any topup
+    block is pending payment, further automatic top-ups will be paused until the
+    invoice is paid or voided.
     """
 
 
diff --git a/src/orb/types/customers/credits/top_up_list_by_external_id_response.py b/src/orb/types/customers/credits/top_up_list_by_external_id_response.py
@@ -27,8 +27,10 @@ class InvoiceSettings(BaseModel):
 
     require_successful_payment: Optional[bool] = None
     """
-    If true, new credit blocks created by this top-up will require that the
-    corresponding invoice is paid before they can be drawn down from.
+    When true, credit blocks created by this top-up will require that the
+    corresponding invoice is paid before they are drawn down from. If any topup
+    block is pending payment, further automatic top-ups will be paused until the
+    invoice is paid or voided.
     """
 
 
diff --git a/src/orb/types/customers/credits/top_up_list_response.py b/src/orb/types/customers/credits/top_up_list_response.py
@@ -27,8 +27,10 @@ class InvoiceSettings(BaseModel):
 
     require_successful_payment: Optional[bool] = None
     """
-    If true, new credit blocks created by this top-up will require that the
-    corresponding invoice is paid before they can be drawn down from.
+    When true, credit blocks created by this top-up will require that the
+    corresponding invoice is paid before they are drawn down from. If any topup
+    block is pending payment, further automatic top-ups will be paused until the
+    invoice is paid or voided.
     """
 
 
diff --git a/src/orb/types/event_ingest_params.py b/src/orb/types/event_ingest_params.py
@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Union, Iterable, Optional
+from typing import Dict, Union, Iterable, Optional
 from datetime import datetime
 from typing_extensions import Required, Annotated, TypedDict
 
@@ -35,7 +35,7 @@ class Event(TypedDict, total=False):
     for safe request retries.
     """
 
-    properties: Required[object]
+    properties: Required[Dict[str, object]]
     """A dictionary of custom properties.
 
     Values in this dictionary must be numeric, boolean, or strings. Nested
diff --git a/src/orb/types/event_search_response.py b/src/orb/types/event_search_response.py
@@ -1,6 +1,6 @@
 # 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 datetime import datetime
 
 from .._models import BaseModel
@@ -31,7 +31,7 @@ class Data(BaseModel):
     customer
     """
 
-    properties: object
+    properties: Dict[str, object]
     """A dictionary of custom properties.
 
     Values in this dictionary must be numeric, boolean, or strings. Nested
diff --git a/src/orb/types/event_update_params.py b/src/orb/types/event_update_params.py
@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Union, Optional
+from typing import Dict, Union, Optional
 from datetime import datetime
 from typing_extensions import Required, Annotated, TypedDict
 
@@ -15,7 +15,7 @@ class EventUpdateParams(TypedDict, total=False):
     event_name: Required[str]
     """A name to meaningfully identify the action or event type."""
 
-    properties: Required[object]
+    properties: Required[Dict[str, object]]
     """A dictionary of custom properties.
 
     Values in this dictionary must be numeric, boolean, or strings. Nested
diff --git a/src/orb/types/price_evaluate_multiple_params.py b/src/orb/types/price_evaluate_multiple_params.py
@@ -167,7 +167,7 @@ class Event(TypedDict, total=False):
     event_name: Required[str]
     """A name to meaningfully identify the action or event type."""
 
-    properties: Required[object]
+    properties: Required[Dict[str, object]]
     """A dictionary of custom properties.
 
     Values in this dictionary must be numeric, boolean, or strings. Nested
diff --git a/tests/api_resources/test_events.py b/tests/api_resources/test_events.py
@@ -28,7 +28,7 @@ def test_method_update(self, client: Orb) -> None:
         event = client.events.update(
             event_id="event_id",
             event_name="event_name",
-            properties={},
+            properties={"foo": "bar"},
             timestamp=parse_datetime("2020-12-09T16:09:53Z"),
         )
         assert_matches_type(EventUpdateResponse, event, path=["response"])
@@ -38,7 +38,7 @@ def test_method_update_with_all_params(self, client: Orb) -> None:
         event = client.events.update(
             event_id="event_id",
             event_name="event_name",
-            properties={},
+            properties={"foo": "bar"},
             timestamp=parse_datetime("2020-12-09T16:09:53Z"),
             customer_id="customer_id",
             external_customer_id="external_customer_id",
@@ -50,7 +50,7 @@ def test_raw_response_update(self, client: Orb) -> None:
         response = client.events.with_raw_response.update(
             event_id="event_id",
             event_name="event_name",
-            properties={},
+            properties={"foo": "bar"},
             timestamp=parse_datetime("2020-12-09T16:09:53Z"),
         )
 
@@ -64,7 +64,7 @@ def test_streaming_response_update(self, client: Orb) -> None:
         with client.events.with_streaming_response.update(
             event_id="event_id",
             event_name="event_name",
-            properties={},
+            properties={"foo": "bar"},
             timestamp=parse_datetime("2020-12-09T16:09:53Z"),
         ) as response:
             assert not response.is_closed
@@ -81,7 +81,7 @@ def test_path_params_update(self, client: Orb) -> None:
             client.events.with_raw_response.update(
                 event_id="",
                 event_name="event_name",
-                properties={},
+                properties={"foo": "bar"},
                 timestamp=parse_datetime("2020-12-09T16:09:53Z"),
             )
 
@@ -130,7 +130,7 @@ def test_method_ingest(self, client: Orb) -> None:
                 {
                     "event_name": "event_name",
                     "idempotency_key": "idempotency_key",
-                    "properties": {},
+                    "properties": {"foo": "bar"},
                     "timestamp": parse_datetime("2020-12-09T16:09:53Z"),
                 }
             ],
@@ -144,7 +144,7 @@ def test_method_ingest_with_all_params(self, client: Orb) -> None:
                 {
                     "event_name": "event_name",
                     "idempotency_key": "idempotency_key",
-                    "properties": {},
+                    "properties": {"foo": "bar"},
                     "timestamp": parse_datetime("2020-12-09T16:09:53Z"),
                     "customer_id": "customer_id",
                     "external_customer_id": "external_customer_id",
@@ -162,7 +162,7 @@ def test_raw_response_ingest(self, client: Orb) -> None:
                 {
                     "event_name": "event_name",
                     "idempotency_key": "idempotency_key",
-                    "properties": {},
+                    "properties": {"foo": "bar"},
                     "timestamp": parse_datetime("2020-12-09T16:09:53Z"),
                 }
             ],
@@ -180,7 +180,7 @@ def test_streaming_response_ingest(self, client: Orb) -> None:
                 {
                     "event_name": "event_name",
                     "idempotency_key": "idempotency_key",
-                    "properties": {},
+                    "properties": {"foo": "bar"},
                     "timestamp": parse_datetime("2020-12-09T16:09:53Z"),
                 }
             ],
@@ -242,7 +242,7 @@ async def test_method_update(self, async_client: AsyncOrb) -> None:
         event = await async_client.events.update(
             event_id="event_id",
             event_name="event_name",
-            properties={},
+            properties={"foo": "bar"},
             timestamp=parse_datetime("2020-12-09T16:09:53Z"),
         )
         assert_matches_type(EventUpdateResponse, event, path=["response"])
@@ -252,7 +252,7 @@ async def test_method_update_with_all_params(self, async_client: AsyncOrb) -> No
         event = await async_client.events.update(
             event_id="event_id",
             event_name="event_name",
-            properties={},
+            properties={"foo": "bar"},
             timestamp=parse_datetime("2020-12-09T16:09:53Z"),
             customer_id="customer_id",
             external_customer_id="external_customer_id",
@@ -264,7 +264,7 @@ async def test_raw_response_update(self, async_client: AsyncOrb) -> None:
         response = await async_client.events.with_raw_response.update(
             event_id="event_id",
             event_name="event_name",
-            properties={},
+            properties={"foo": "bar"},
             timestamp=parse_datetime("2020-12-09T16:09:53Z"),
         )
 
@@ -278,7 +278,7 @@ async def test_streaming_response_update(self, async_client: AsyncOrb) -> None:
         async with async_client.events.with_streaming_response.update(
             event_id="event_id",
             event_name="event_name",
-            properties={},
+            properties={"foo": "bar"},
             timestamp=parse_datetime("2020-12-09T16:09:53Z"),
         ) as response:
             assert not response.is_closed
@@ -295,7 +295,7 @@ async def test_path_params_update(self, async_client: AsyncOrb) -> None:
             await async_client.events.with_raw_response.update(
                 event_id="",
                 event_name="event_name",
-                properties={},
+                properties={"foo": "bar"},
                 timestamp=parse_datetime("2020-12-09T16:09:53Z"),
             )
 
@@ -344,7 +344,7 @@ async def test_method_ingest(self, async_client: AsyncOrb) -> None:
                 {
                     "event_name": "event_name",
                     "idempotency_key": "idempotency_key",
-                    "properties": {},
+                    "properties": {"foo": "bar"},
                     "timestamp": parse_datetime("2020-12-09T16:09:53Z"),
                 }
             ],
@@ -358,7 +358,7 @@ async def test_method_ingest_with_all_params(self, async_client: AsyncOrb) -> No
                 {
                     "event_name": "event_name",
                     "idempotency_key": "idempotency_key",
-                    "properties": {},
+                    "properties": {"foo": "bar"},
                     "timestamp": parse_datetime("2020-12-09T16:09:53Z"),
                     "customer_id": "customer_id",
                     "external_customer_id": "external_customer_id",
@@ -376,7 +376,7 @@ async def test_raw_response_ingest(self, async_client: AsyncOrb) -> None:
                 {
                     "event_name": "event_name",
                     "idempotency_key": "idempotency_key",
-                    "properties": {},
+                    "properties": {"foo": "bar"},
                     "timestamp": parse_datetime("2020-12-09T16:09:53Z"),
                 }
             ],
@@ -394,7 +394,7 @@ async def test_streaming_response_ingest(self, async_client: AsyncOrb) -> None:
                 {
                     "event_name": "event_name",
                     "idempotency_key": "idempotency_key",
-                    "properties": {},
+                    "properties": {"foo": "bar"},
                     "timestamp": parse_datetime("2020-12-09T16:09:53Z"),
                 }
             ],
diff --git a/tests/api_resources/test_prices.py b/tests/api_resources/test_prices.py
@@ -2527,7 +2527,7 @@ def test_method_evaluate_multiple_with_all_params(self, client: Orb) -> None:
             events=[
                 {
                     "event_name": "event_name",
-                    "properties": {},
+                    "properties": {"foo": "bar"},
                     "timestamp": parse_datetime("2020-12-09T16:09:53Z"),
                     "customer_id": "customer_id",
                     "external_customer_id": "external_customer_id",
@@ -5144,7 +5144,7 @@ async def test_method_evaluate_multiple_with_all_params(self, async_client: Asyn
             events=[
                 {
                     "event_name": "event_name",
-                    "properties": {},
+                    "properties": {"foo": "bar"},
                     "timestamp": parse_datetime("2020-12-09T16:09:53Z"),
                     "customer_id": "customer_id",
                     "external_customer_id": "external_customer_id",
