feat(api): api update (#440)

Author: stainless-app[bot]

.stats.yml

@@ -1,2 +1,2 @@
 configured_endpoints: 97
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-0f43f737c6520ed2a2407628511350362959997f89a868c50aa38d47d5791171.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-40a4e23dd482299a046fb62fd2b5a1e03d455156cb8cd4573e92e4132d74b243.yml

src/orb/resources/subscriptions.py

@@ -95,6 +95,7 @@ def create(
         external_marketplace: Optional[Literal["google", "aws", "azure"]] | NotGiven = NOT_GIVEN,
         external_marketplace_reporting_id: Optional[str] | NotGiven = NOT_GIVEN,
         external_plan_id: Optional[str] | NotGiven = NOT_GIVEN,
+        filter: Optional[str] | NotGiven = NOT_GIVEN,
         initial_phase_order: Optional[int] | NotGiven = NOT_GIVEN,
         invoicing_threshold: Optional[str] | NotGiven = NOT_GIVEN,
         metadata: Optional[Dict[str, Optional[str]]] | NotGiven = NOT_GIVEN,
@@ -395,6 +396,11 @@ def create(
           external_plan_id: The external_plan_id of the plan that the given subscription should be switched
               to. Note that either this property or `plan_id` must be specified.
 
+          filter: An additional filter to apply to usage queries. This filter must be expressed as
+              a boolean
+              [computed property](../guides/extensibility/advanced-metrics#computed-properties).
+              If null, usage queries will not include any additional filter.
+
           initial_phase_order: The phase of the plan to start with
 
           invoicing_threshold: When this subscription's accrued usage reaches this threshold, an invoice will
@@ -463,6 +469,7 @@ def create(
                     "external_marketplace": external_marketplace,
                     "external_marketplace_reporting_id": external_marketplace_reporting_id,
                     "external_plan_id": external_plan_id,
+                    "filter": filter,
                     "initial_phase_order": initial_phase_order,
                     "invoicing_threshold": invoicing_threshold,
                     "metadata": metadata,
@@ -1345,6 +1352,7 @@ def schedule_plan_change(
         credits_overage_rate: Optional[float] | NotGiven = NOT_GIVEN,
         default_invoice_memo: Optional[str] | NotGiven = NOT_GIVEN,
         external_plan_id: Optional[str] | NotGiven = NOT_GIVEN,
+        filter: Optional[str] | NotGiven = NOT_GIVEN,
         initial_phase_order: Optional[int] | NotGiven = NOT_GIVEN,
         invoicing_threshold: Optional[str] | NotGiven = NOT_GIVEN,
         net_terms: Optional[int] | NotGiven = NOT_GIVEN,
@@ -1582,6 +1590,11 @@ def schedule_plan_change(
           external_plan_id: The external_plan_id of the plan that the given subscription should be switched
               to. Note that either this property or `plan_id` must be specified.
 
+          filter: An additional filter to apply to usage queries. This filter must be expressed as
+              a boolean
+              [computed property](../guides/extensibility/advanced-metrics#computed-properties).
+              If null, usage queries will not include any additional filter.
+
           initial_phase_order: The phase of the plan to start with
 
           invoicing_threshold: When this subscription's accrued usage reaches this threshold, an invoice will
@@ -1645,6 +1658,7 @@ def schedule_plan_change(
                     "credits_overage_rate": credits_overage_rate,
                     "default_invoice_memo": default_invoice_memo,
                     "external_plan_id": external_plan_id,
+                    "filter": filter,
                     "initial_phase_order": initial_phase_order,
                     "invoicing_threshold": invoicing_threshold,
                     "net_terms": net_terms,
@@ -2044,6 +2058,7 @@ async def create(
         external_marketplace: Optional[Literal["google", "aws", "azure"]] | NotGiven = NOT_GIVEN,
         external_marketplace_reporting_id: Optional[str] | NotGiven = NOT_GIVEN,
         external_plan_id: Optional[str] | NotGiven = NOT_GIVEN,
+        filter: Optional[str] | NotGiven = NOT_GIVEN,
         initial_phase_order: Optional[int] | NotGiven = NOT_GIVEN,
         invoicing_threshold: Optional[str] | NotGiven = NOT_GIVEN,
         metadata: Optional[Dict[str, Optional[str]]] | NotGiven = NOT_GIVEN,
@@ -2344,6 +2359,11 @@ async def create(
           external_plan_id: The external_plan_id of the plan that the given subscription should be switched
               to. Note that either this property or `plan_id` must be specified.
 
+          filter: An additional filter to apply to usage queries. This filter must be expressed as
+              a boolean
+              [computed property](../guides/extensibility/advanced-metrics#computed-properties).
+              If null, usage queries will not include any additional filter.
+
           initial_phase_order: The phase of the plan to start with
 
           invoicing_threshold: When this subscription's accrued usage reaches this threshold, an invoice will
@@ -2412,6 +2432,7 @@ async def create(
                     "external_marketplace": external_marketplace,
                     "external_marketplace_reporting_id": external_marketplace_reporting_id,
                     "external_plan_id": external_plan_id,
+                    "filter": filter,
                     "initial_phase_order": initial_phase_order,
                     "invoicing_threshold": invoicing_threshold,
                     "metadata": metadata,
@@ -3294,6 +3315,7 @@ async def schedule_plan_change(
         credits_overage_rate: Optional[float] | NotGiven = NOT_GIVEN,
         default_invoice_memo: Optional[str] | NotGiven = NOT_GIVEN,
         external_plan_id: Optional[str] | NotGiven = NOT_GIVEN,
+        filter: Optional[str] | NotGiven = NOT_GIVEN,
         initial_phase_order: Optional[int] | NotGiven = NOT_GIVEN,
         invoicing_threshold: Optional[str] | NotGiven = NOT_GIVEN,
         net_terms: Optional[int] | NotGiven = NOT_GIVEN,
@@ -3531,6 +3553,11 @@ async def schedule_plan_change(
           external_plan_id: The external_plan_id of the plan that the given subscription should be switched
               to. Note that either this property or `plan_id` must be specified.
 
+          filter: An additional filter to apply to usage queries. This filter must be expressed as
+              a boolean
+              [computed property](../guides/extensibility/advanced-metrics#computed-properties).
+              If null, usage queries will not include any additional filter.
+
           initial_phase_order: The phase of the plan to start with
 
           invoicing_threshold: When this subscription's accrued usage reaches this threshold, an invoice will
@@ -3594,6 +3621,7 @@ async def schedule_plan_change(
                     "credits_overage_rate": credits_overage_rate,
                     "default_invoice_memo": default_invoice_memo,
                     "external_plan_id": external_plan_id,
+                    "filter": filter,
                     "initial_phase_order": initial_phase_order,
                     "invoicing_threshold": invoicing_threshold,
                     "net_terms": net_terms,

src/orb/types/subscription_create_params.py

@@ -228,6 +228,14 @@ class SubscriptionCreateParams(TypedDict, total=False):
     to. Note that either this property or `plan_id` must be specified.
     """
 
+    filter: Optional[str]
+    """An additional filter to apply to usage queries.
+
+    This filter must be expressed as a boolean
+    [computed property](../guides/extensibility/advanced-metrics#computed-properties).
+    If null, usage queries will not include any additional filter.
+    """
+
     initial_phase_order: Optional[int]
     """The phase of the plan to start with"""
 

src/orb/types/subscription_schedule_plan_change_params.py

@@ -235,6 +235,14 @@ class SubscriptionSchedulePlanChangeParams(TypedDict, total=False):
     to. Note that either this property or `plan_id` must be specified.
     """
 
+    filter: Optional[str]
+    """An additional filter to apply to usage queries.
+
+    This filter must be expressed as a boolean
+    [computed property](../guides/extensibility/advanced-metrics#computed-properties).
+    If null, usage queries will not include any additional filter.
+    """
+
     initial_phase_order: Optional[int]
     """The phase of the plan to start with"""
 

tests/api_resources/test_subscriptions.py

@@ -114,6 +114,7 @@ def test_method_create_with_all_params(self, client: Orb) -> None:
             external_marketplace="google",
             external_marketplace_reporting_id="external_marketplace_reporting_id",
             external_plan_id="ZMwNQefe7J3ecf7W",
+            filter="my_property > 100 AND my_other_property = 'bar'",
             initial_phase_order=2,
             invoicing_threshold="10.00",
             metadata={"foo": "string"},
@@ -759,6 +760,7 @@ def test_method_schedule_plan_change_with_all_params(self, client: Orb) -> None:
             credits_overage_rate=0,
             default_invoice_memo="default_invoice_memo",
             external_plan_id="ZMwNQefe7J3ecf7W",
+            filter="my_property > 100 AND my_other_property = 'bar'",
             initial_phase_order=2,
             invoicing_threshold="10.00",
             net_terms=0,
@@ -1219,6 +1221,7 @@ async def test_method_create_with_all_params(self, async_client: AsyncOrb) -> No
             external_marketplace="google",
             external_marketplace_reporting_id="external_marketplace_reporting_id",
             external_plan_id="ZMwNQefe7J3ecf7W",
+            filter="my_property > 100 AND my_other_property = 'bar'",
             initial_phase_order=2,
             invoicing_threshold="10.00",
             metadata={"foo": "string"},
@@ -1864,6 +1867,7 @@ async def test_method_schedule_plan_change_with_all_params(self, async_client: A
             credits_overage_rate=0,
             default_invoice_memo="default_invoice_memo",
             external_plan_id="ZMwNQefe7J3ecf7W",
+            filter="my_property > 100 AND my_other_property = 'bar'",
             initial_phase_order=2,
             invoicing_threshold="10.00",
             net_terms=0,