Skip to content

Commit 3686dc6

Browse files
feat(api): api update
1 parent 2fbc2b1 commit 3686dc6

12 files changed

+98
-5
lines changed

.stats.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 139
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-77e112caf7b2a2c7b0248b7245b5730bc72ab0ea84ba5d0777e7d0604ae04d26.yml
3-
openapi_spec_hash: 966568dd08f34db64ba0ebace678268a
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-3c7ee3ec9931aaeeb5e015a598812cde9edc09f114adb8759ef4c2054c90f7dc.yml
3+
openapi_spec_hash: a14720041156fe4f353449142edacf0d
44
config_hash: 3279841440b02d4e8303c961d6983492

src/orb/resources/prices/prices.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3503,6 +3503,7 @@ def evaluate(
35033503
external_customer_id: Optional[str] | Omit = omit,
35043504
filter: Optional[str] | Omit = omit,
35053505
grouping_keys: SequenceNotStr[str] | Omit = omit,
3506+
metric_parameter_overrides: Optional[Dict[str, object]] | Omit = omit,
35063507
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
35073508
# The extra values given here take precedence over values defined on the client or passed to this method.
35083509
extra_headers: Headers | None = None,
@@ -3555,6 +3556,9 @@ def evaluate(
35553556
[computed properties](/extensibility/advanced-metrics#computed-properties)) used
35563557
to group the underlying billable metric
35573558
3559+
metric_parameter_overrides: Optional overrides for parameterized billable metric parameters. If the metric
3560+
has parameter definitions and no overrides are provided, defaults will be used.
3561+
35583562
extra_headers: Send extra headers
35593563
35603564
extra_query: Add additional query parameters to the request
@@ -3577,6 +3581,7 @@ def evaluate(
35773581
"external_customer_id": external_customer_id,
35783582
"filter": filter,
35793583
"grouping_keys": grouping_keys,
3584+
"metric_parameter_overrides": metric_parameter_overrides,
35803585
},
35813586
price_evaluate_params.PriceEvaluateParams,
35823587
),
@@ -7255,6 +7260,7 @@ async def evaluate(
72557260
external_customer_id: Optional[str] | Omit = omit,
72567261
filter: Optional[str] | Omit = omit,
72577262
grouping_keys: SequenceNotStr[str] | Omit = omit,
7263+
metric_parameter_overrides: Optional[Dict[str, object]] | Omit = omit,
72587264
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
72597265
# The extra values given here take precedence over values defined on the client or passed to this method.
72607266
extra_headers: Headers | None = None,
@@ -7307,6 +7313,9 @@ async def evaluate(
73077313
[computed properties](/extensibility/advanced-metrics#computed-properties)) used
73087314
to group the underlying billable metric
73097315
7316+
metric_parameter_overrides: Optional overrides for parameterized billable metric parameters. If the metric
7317+
has parameter definitions and no overrides are provided, defaults will be used.
7318+
73107319
extra_headers: Send extra headers
73117320
73127321
extra_query: Add additional query parameters to the request
@@ -7329,6 +7338,7 @@ async def evaluate(
73297338
"external_customer_id": external_customer_id,
73307339
"filter": filter,
73317340
"grouping_keys": grouping_keys,
7341+
"metric_parameter_overrides": metric_parameter_overrides,
73327342
},
73337343
price_evaluate_params.PriceEvaluateParams,
73347344
),

src/orb/types/billable_metric.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
22

3-
from typing import Dict, Optional
3+
from typing import Dict, List, Optional
44
from typing_extensions import Literal
55

66
from .item import Item
@@ -38,3 +38,5 @@ class BillableMetric(BaseModel):
3838
name: str
3939

4040
status: Literal["active", "draft", "archived"]
41+
42+
parameter_definitions: Optional[List[Dict[str, object]]] = None

src/orb/types/price_evaluate_multiple_params.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -638,6 +638,13 @@ class PriceEvaluation(TypedDict, total=False):
638638
to group the underlying billable metric
639639
"""
640640

641+
metric_parameter_overrides: Optional[Dict[str, object]]
642+
"""Optional overrides for parameterized billable metric parameters.
643+
644+
If the metric has parameter definitions and no overrides are provided, defaults
645+
will be used.
646+
"""
647+
641648
price: Optional[PriceEvaluationPrice]
642649
"""New floating price request body params."""
643650

src/orb/types/price_evaluate_params.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
from __future__ import annotations
44

5-
from typing import Union, Optional
5+
from typing import Dict, Union, Optional
66
from datetime import datetime
77
from typing_extensions import Required, Annotated, TypedDict
88

@@ -38,3 +38,10 @@ class PriceEvaluateParams(TypedDict, total=False):
3838
[computed properties](/extensibility/advanced-metrics#computed-properties)) used
3939
to group the underlying billable metric
4040
"""
41+
42+
metric_parameter_overrides: Optional[Dict[str, object]]
43+
"""Optional overrides for parameterized billable metric parameters.
44+
45+
If the metric has parameter definitions and no overrides are provided, defaults
46+
will be used.
47+
"""

src/orb/types/price_evaluate_preview_events_params.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -670,6 +670,13 @@ class PriceEvaluation(TypedDict, total=False):
670670
to group the underlying billable metric
671671
"""
672672

673+
metric_parameter_overrides: Optional[Dict[str, object]]
674+
"""Optional overrides for parameterized billable metric parameters.
675+
676+
If the metric has parameter definitions and no overrides are provided, defaults
677+
will be used.
678+
"""
679+
673680
price: Optional[PriceEvaluationPrice]
674681
"""New floating price request body params."""
675682

src/orb/types/shared/price_interval.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
22

3-
from typing import List, Optional
3+
from typing import Dict, List, Optional
44
from datetime import datetime
55

66
from .price import Price
@@ -83,3 +83,9 @@ class PriceInterval(BaseModel):
8383
A list of customer IDs whose usage events will be aggregated and billed under
8484
this price interval.
8585
"""
86+
87+
metric_parameter_overrides: Optional[Dict[str, object]] = None
88+
"""Override values for parameterized billable metric variables.
89+
90+
Keys are parameter names, values are the override values.
91+
"""

src/orb/types/subscription_create_params.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1022,6 +1022,12 @@ class AddPrice(TypedDict, total=False):
10221022
The subscription's maximum amount for this price.
10231023
"""
10241024

1025+
metric_parameter_overrides: Optional[Dict[str, object]]
1026+
"""Override values for parameterized billable metric variables.
1027+
1028+
Keys are parameter names, values are the override values.
1029+
"""
1030+
10251031
minimum_amount: Optional[str]
10261032
"""[DEPRECATED] Use add_adjustments instead.
10271033
@@ -1788,6 +1794,12 @@ class ReplacePrice(TypedDict, total=False):
17881794
The subscription's maximum amount for the replacement price.
17891795
"""
17901796

1797+
metric_parameter_overrides: Optional[Dict[str, object]]
1798+
"""Override values for parameterized billable metric variables.
1799+
1800+
Keys are parameter names, values are the override values.
1801+
"""
1802+
17911803
minimum_amount: Optional[str]
17921804
"""[DEPRECATED] Use add_adjustments instead.
17931805

src/orb/types/subscription_price_intervals_params.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -729,6 +729,12 @@ class Add(TypedDict, total=False):
729729
billing period.
730730
"""
731731

732+
metric_parameter_overrides: Optional[Dict[str, object]]
733+
"""Override values for parameterized billable metric variables.
734+
735+
Keys are parameter names, values are the override values (number or string).
736+
"""
737+
732738
minimum_amount: Optional[float]
733739
"""
734740
The minimum amount that will be billed for this price interval for a given
@@ -836,6 +842,12 @@ class Edit(TypedDict, total=False):
836842
on the price interval.
837843
"""
838844

845+
metric_parameter_overrides: Optional[Dict[str, object]]
846+
"""Override values for parameterized billable metric variables.
847+
848+
Keys are parameter names, values are the override values (number or string).
849+
"""
850+
839851
start_date: Annotated[Union[Union[str, datetime], BillingCycleRelativeDate], PropertyInfo(format="iso8601")]
840852
"""The updated start date of this price interval.
841853

src/orb/types/subscription_schedule_plan_change_params.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1010,6 +1010,12 @@ class AddPrice(TypedDict, total=False):
10101010
The subscription's maximum amount for this price.
10111011
"""
10121012

1013+
metric_parameter_overrides: Optional[Dict[str, object]]
1014+
"""Override values for parameterized billable metric variables.
1015+
1016+
Keys are parameter names, values are the override values.
1017+
"""
1018+
10131019
minimum_amount: Optional[str]
10141020
"""[DEPRECATED] Use add_adjustments instead.
10151021
@@ -1776,6 +1782,12 @@ class ReplacePrice(TypedDict, total=False):
17761782
The subscription's maximum amount for the replacement price.
17771783
"""
17781784

1785+
metric_parameter_overrides: Optional[Dict[str, object]]
1786+
"""Override values for parameterized billable metric variables.
1787+
1788+
Keys are parameter names, values are the override values.
1789+
"""
1790+
17791791
minimum_amount: Optional[str]
17801792
"""[DEPRECATED] Use add_adjustments instead.
17811793

0 commit comments

Comments
 (0)