Skip to content

Commit 9f4c932

Browse files
feat(api): api update
1 parent fe3cedb commit 9f4c932

File tree

201 files changed

+3736
-3552
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

201 files changed

+3736
-3552
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: 118
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-4f31d46f5ba187fc4d702c9f9f1573dacb891edbd086f935707578d7c4f5fed8.yml
3-
openapi_spec_hash: 25b1019f20a47b8af665aae5f8fd0025
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-6b2550b95f82872b3825619c109352352b9c92281c8b2470fce158e971142881.yml
3+
openapi_spec_hash: 379df18de1af6a9d0b50d3653aab4d44
44
config_hash: be9350529b910ec14bff0a30cd74a185

api.md

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,6 @@ from orb.types import (
1212
BillingCycleAnchorConfiguration,
1313
BillingCycleConfiguration,
1414
BillingCycleRelativeDate,
15-
BPSConfig,
16-
BPSTier,
17-
BulkBPSConfig,
18-
BulkBPSTier,
1915
BulkConfig,
2016
BulkTier,
2117
ChangedSubscriptionResources,
@@ -53,8 +49,6 @@ from orb.types import (
5349
NewAmountDiscount,
5450
NewBillingCycleConfiguration,
5551
NewDimensionalPriceConfiguration,
56-
NewFloatingBPSPrice,
57-
NewFloatingBulkBPSPrice,
5852
NewFloatingBulkPrice,
5953
NewFloatingBulkWithProrationPrice,
6054
NewFloatingCumulativeGroupedBulkPrice,
@@ -72,7 +66,6 @@ from orb.types import (
7266
NewFloatingScalableMatrixWithTieredPricingPrice,
7367
NewFloatingScalableMatrixWithUnitPricingPrice,
7468
NewFloatingThresholdTotalAmountPrice,
75-
NewFloatingTieredBPSPrice,
7669
NewFloatingTieredPackagePrice,
7770
NewFloatingTieredPackageWithMinimumPrice,
7871
NewFloatingTieredPrice,
@@ -84,8 +77,6 @@ from orb.types import (
8477
NewMaximum,
8578
NewMinimum,
8679
NewPercentageDiscount,
87-
NewPlanBPSPrice,
88-
NewPlanBulkBPSPrice,
8980
NewPlanBulkPrice,
9081
NewPlanBulkWithProrationPrice,
9182
NewPlanCumulativeGroupedBulkPrice,
@@ -104,7 +95,6 @@ from orb.types import (
10495
NewPlanScalableMatrixWithUnitPricingPrice,
10596
NewPlanThresholdTotalAmountPrice,
10697
NewPlanTierWithProrationPrice,
107-
NewPlanTieredBPSPrice,
10898
NewPlanTieredPackagePrice,
10999
NewPlanTieredPackageWithMinimumPrice,
110100
NewPlanTieredPrice,
@@ -135,7 +125,6 @@ from orb.types import (
135125
Tier,
136126
TierConfig,
137127
TierSubLineItem,
138-
TieredBPSConfig,
139128
TieredConfig,
140129
TieredConversionRateConfig,
141130
TransformPriceFilter,
@@ -506,8 +495,6 @@ Types:
506495
```python
507496
from orb.types import (
508497
DiscountOverride,
509-
NewSubscriptionBPSPrice,
510-
NewSubscriptionBulkBPSPrice,
511498
NewSubscriptionBulkPrice,
512499
NewSubscriptionBulkWithProrationPrice,
513500
NewSubscriptionCumulativeGroupedBulkPrice,
@@ -526,7 +513,6 @@ from orb.types import (
526513
NewSubscriptionScalableMatrixWithUnitPricingPrice,
527514
NewSubscriptionThresholdTotalAmountPrice,
528515
NewSubscriptionTierWithProrationPrice,
529-
NewSubscriptionTieredBPSPrice,
530516
NewSubscriptionTieredPackagePrice,
531517
NewSubscriptionTieredPackageWithMinimumPrice,
532518
NewSubscriptionTieredPrice,

src/orb/resources/alerts.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ def list(
155155
The request must specify one of `customer_id`, `external_customer_id`, or
156156
`subscription_id`.
157157
158-
If querying by subscripion_id, the endpoint will return the subscription level
158+
If querying by subscription_id, the endpoint will return the subscription level
159159
alerts as well as the plan level alerts associated with the subscription.
160160
161161
The list of alerts is ordered starting from the most recently created alert.
@@ -630,7 +630,7 @@ def list(
630630
The request must specify one of `customer_id`, `external_customer_id`, or
631631
`subscription_id`.
632632
633-
If querying by subscripion_id, the endpoint will return the subscription level
633+
If querying by subscription_id, the endpoint will return the subscription level
634634
alerts as well as the plan level alerts associated with the subscription.
635635
636636
The list of alerts is ordered starting from the most recently created alert.

src/orb/resources/customers/credits/ledger.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ def list(
142142
Note that for this entry type, `starting_balance` will equal `ending_balance`,
143143
and the `amount` represents the balance transferred. The credit block linked to
144144
the ledger entry is the source credit block from which there was an expiration
145-
change
145+
change.
146146
147147
## Credits expiry
148148
@@ -2088,7 +2088,7 @@ def list_by_external_id(
20882088
Note that for this entry type, `starting_balance` will equal `ending_balance`,
20892089
and the `amount` represents the balance transferred. The credit block linked to
20902090
the ledger entry is the source credit block from which there was an expiration
2091-
change
2091+
change.
20922092
20932093
## Credits expiry
20942094
@@ -2273,7 +2273,7 @@ def list(
22732273
Note that for this entry type, `starting_balance` will equal `ending_balance`,
22742274
and the `amount` represents the balance transferred. The credit block linked to
22752275
the ledger entry is the source credit block from which there was an expiration
2276-
change
2276+
change.
22772277
22782278
## Credits expiry
22792279
@@ -4219,7 +4219,7 @@ def list_by_external_id(
42194219
Note that for this entry type, `starting_balance` will equal `ending_balance`,
42204220
and the `amount` represents the balance transferred. The credit block linked to
42214221
the ledger entry is the source credit block from which there was an expiration
4222-
change
4222+
change.
42234223
42244224
## Credits expiry
42254225

src/orb/resources/customers/customers.py

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,7 @@ def create(
9696
accounting_sync_configuration: Optional[NewAccountingSyncConfigurationParam] | NotGiven = NOT_GIVEN,
9797
additional_emails: Optional[SequenceNotStr[str]] | NotGiven = NOT_GIVEN,
9898
auto_collection: Optional[bool] | NotGiven = NOT_GIVEN,
99+
auto_issuance: Optional[bool] | NotGiven = NOT_GIVEN,
99100
billing_address: Optional[AddressInputParam] | NotGiven = NOT_GIVEN,
100101
currency: Optional[str] | NotGiven = NOT_GIVEN,
101102
email_delivery: Optional[bool] | NotGiven = NOT_GIVEN,
@@ -146,6 +147,11 @@ def create(
146147
charge a saved payment method, if available. This parameter defaults to `True`
147148
when a payment provider is provided on customer creation.
148149
150+
auto_issuance: Used to determine if invoices for this customer will be automatically issued. If
151+
true, invoices will be automatically issued. If false, invoices will require
152+
manual approval. If `null` is specified, the customer's auto issuance setting
153+
will be inherited from the account-level setting.
154+
149155
currency: An ISO 4217 currency string used for the customer's invoices and balance. If not
150156
set at creation time, will be set at subscription creation time.
151157
@@ -334,6 +340,7 @@ def create(
334340
"accounting_sync_configuration": accounting_sync_configuration,
335341
"additional_emails": additional_emails,
336342
"auto_collection": auto_collection,
343+
"auto_issuance": auto_issuance,
337344
"billing_address": billing_address,
338345
"currency": currency,
339346
"email_delivery": email_delivery,
@@ -367,6 +374,7 @@ def update(
367374
accounting_sync_configuration: Optional[NewAccountingSyncConfigurationParam] | NotGiven = NOT_GIVEN,
368375
additional_emails: Optional[SequenceNotStr[str]] | NotGiven = NOT_GIVEN,
369376
auto_collection: Optional[bool] | NotGiven = NOT_GIVEN,
377+
auto_issuance: Optional[bool] | NotGiven = NOT_GIVEN,
370378
billing_address: Optional[AddressInputParam] | NotGiven = NOT_GIVEN,
371379
currency: Optional[str] | NotGiven = NOT_GIVEN,
372380
email: Optional[str] | NotGiven = NOT_GIVEN,
@@ -405,6 +413,11 @@ def update(
405413
charge a saved payment method, if available. This parameter defaults to `True`
406414
when a payment provider is provided on customer creation.
407415
416+
auto_issuance: Used to determine if invoices for this customer will be automatically issued. If
417+
true, invoices will be automatically issued. If false, invoices will require
418+
manual approval.If `null` is specified, the customer's auto issuance setting
419+
will be inherited from the account-level setting.
420+
408421
currency: An ISO 4217 currency string used for the customer's invoices and balance. If not
409422
set at creation time, will be set at subscription creation time.
410423
@@ -599,6 +612,7 @@ def update(
599612
"accounting_sync_configuration": accounting_sync_configuration,
600613
"additional_emails": additional_emails,
601614
"auto_collection": auto_collection,
615+
"auto_issuance": auto_issuance,
602616
"billing_address": billing_address,
603617
"currency": currency,
604618
"email": email,
@@ -919,6 +933,7 @@ def update_by_external_id(
919933
accounting_sync_configuration: Optional[NewAccountingSyncConfigurationParam] | NotGiven = NOT_GIVEN,
920934
additional_emails: Optional[SequenceNotStr[str]] | NotGiven = NOT_GIVEN,
921935
auto_collection: Optional[bool] | NotGiven = NOT_GIVEN,
936+
auto_issuance: Optional[bool] | NotGiven = NOT_GIVEN,
922937
billing_address: Optional[AddressInputParam] | NotGiven = NOT_GIVEN,
923938
currency: Optional[str] | NotGiven = NOT_GIVEN,
924939
email: Optional[str] | NotGiven = NOT_GIVEN,
@@ -956,6 +971,11 @@ def update_by_external_id(
956971
charge a saved payment method, if available. This parameter defaults to `True`
957972
when a payment provider is provided on customer creation.
958973
974+
auto_issuance: Used to determine if invoices for this customer will be automatically issued. If
975+
true, invoices will be automatically issued. If false, invoices will require
976+
manual approval.If `null` is specified, the customer's auto issuance setting
977+
will be inherited from the account-level setting.
978+
959979
currency: An ISO 4217 currency string used for the customer's invoices and balance. If not
960980
set at creation time, will be set at subscription creation time.
961981
@@ -1150,6 +1170,7 @@ def update_by_external_id(
11501170
"accounting_sync_configuration": accounting_sync_configuration,
11511171
"additional_emails": additional_emails,
11521172
"auto_collection": auto_collection,
1173+
"auto_issuance": auto_issuance,
11531174
"billing_address": billing_address,
11541175
"currency": currency,
11551176
"email": email,
@@ -1218,6 +1239,7 @@ async def create(
12181239
accounting_sync_configuration: Optional[NewAccountingSyncConfigurationParam] | NotGiven = NOT_GIVEN,
12191240
additional_emails: Optional[SequenceNotStr[str]] | NotGiven = NOT_GIVEN,
12201241
auto_collection: Optional[bool] | NotGiven = NOT_GIVEN,
1242+
auto_issuance: Optional[bool] | NotGiven = NOT_GIVEN,
12211243
billing_address: Optional[AddressInputParam] | NotGiven = NOT_GIVEN,
12221244
currency: Optional[str] | NotGiven = NOT_GIVEN,
12231245
email_delivery: Optional[bool] | NotGiven = NOT_GIVEN,
@@ -1268,6 +1290,11 @@ async def create(
12681290
charge a saved payment method, if available. This parameter defaults to `True`
12691291
when a payment provider is provided on customer creation.
12701292
1293+
auto_issuance: Used to determine if invoices for this customer will be automatically issued. If
1294+
true, invoices will be automatically issued. If false, invoices will require
1295+
manual approval. If `null` is specified, the customer's auto issuance setting
1296+
will be inherited from the account-level setting.
1297+
12711298
currency: An ISO 4217 currency string used for the customer's invoices and balance. If not
12721299
set at creation time, will be set at subscription creation time.
12731300
@@ -1456,6 +1483,7 @@ async def create(
14561483
"accounting_sync_configuration": accounting_sync_configuration,
14571484
"additional_emails": additional_emails,
14581485
"auto_collection": auto_collection,
1486+
"auto_issuance": auto_issuance,
14591487
"billing_address": billing_address,
14601488
"currency": currency,
14611489
"email_delivery": email_delivery,
@@ -1489,6 +1517,7 @@ async def update(
14891517
accounting_sync_configuration: Optional[NewAccountingSyncConfigurationParam] | NotGiven = NOT_GIVEN,
14901518
additional_emails: Optional[SequenceNotStr[str]] | NotGiven = NOT_GIVEN,
14911519
auto_collection: Optional[bool] | NotGiven = NOT_GIVEN,
1520+
auto_issuance: Optional[bool] | NotGiven = NOT_GIVEN,
14921521
billing_address: Optional[AddressInputParam] | NotGiven = NOT_GIVEN,
14931522
currency: Optional[str] | NotGiven = NOT_GIVEN,
14941523
email: Optional[str] | NotGiven = NOT_GIVEN,
@@ -1527,6 +1556,11 @@ async def update(
15271556
charge a saved payment method, if available. This parameter defaults to `True`
15281557
when a payment provider is provided on customer creation.
15291558
1559+
auto_issuance: Used to determine if invoices for this customer will be automatically issued. If
1560+
true, invoices will be automatically issued. If false, invoices will require
1561+
manual approval.If `null` is specified, the customer's auto issuance setting
1562+
will be inherited from the account-level setting.
1563+
15301564
currency: An ISO 4217 currency string used for the customer's invoices and balance. If not
15311565
set at creation time, will be set at subscription creation time.
15321566
@@ -1721,6 +1755,7 @@ async def update(
17211755
"accounting_sync_configuration": accounting_sync_configuration,
17221756
"additional_emails": additional_emails,
17231757
"auto_collection": auto_collection,
1758+
"auto_issuance": auto_issuance,
17241759
"billing_address": billing_address,
17251760
"currency": currency,
17261761
"email": email,
@@ -2041,6 +2076,7 @@ async def update_by_external_id(
20412076
accounting_sync_configuration: Optional[NewAccountingSyncConfigurationParam] | NotGiven = NOT_GIVEN,
20422077
additional_emails: Optional[SequenceNotStr[str]] | NotGiven = NOT_GIVEN,
20432078
auto_collection: Optional[bool] | NotGiven = NOT_GIVEN,
2079+
auto_issuance: Optional[bool] | NotGiven = NOT_GIVEN,
20442080
billing_address: Optional[AddressInputParam] | NotGiven = NOT_GIVEN,
20452081
currency: Optional[str] | NotGiven = NOT_GIVEN,
20462082
email: Optional[str] | NotGiven = NOT_GIVEN,
@@ -2078,6 +2114,11 @@ async def update_by_external_id(
20782114
charge a saved payment method, if available. This parameter defaults to `True`
20792115
when a payment provider is provided on customer creation.
20802116
2117+
auto_issuance: Used to determine if invoices for this customer will be automatically issued. If
2118+
true, invoices will be automatically issued. If false, invoices will require
2119+
manual approval.If `null` is specified, the customer's auto issuance setting
2120+
will be inherited from the account-level setting.
2121+
20812122
currency: An ISO 4217 currency string used for the customer's invoices and balance. If not
20822123
set at creation time, will be set at subscription creation time.
20832124
@@ -2272,6 +2313,7 @@ async def update_by_external_id(
22722313
"accounting_sync_configuration": accounting_sync_configuration,
22732314
"additional_emails": additional_emails,
22742315
"auto_collection": auto_collection,
2316+
"auto_issuance": auto_issuance,
22752317
"billing_address": billing_address,
22762318
"currency": currency,
22772319
"email": email,

src/orb/resources/dimensional_price_groups/dimensional_price_groups.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ def create(
7474
) -> DimensionalPriceGroup:
7575
"""
7676
A dimensional price group is used to partition the result of a billable metric
77-
by a set of dimensions. Prices in a price group must specify the parition used
77+
by a set of dimensions. Prices in a price group must specify the partition used
7878
to derive their usage.
7979
8080
For example, suppose we have a billable metric that measures the number of
@@ -310,7 +310,7 @@ async def create(
310310
) -> DimensionalPriceGroup:
311311
"""
312312
A dimensional price group is used to partition the result of a billable metric
313-
by a set of dimensions. Prices in a price group must specify the parition used
313+
by a set of dimensions. Prices in a price group must specify the partition used
314314
to derive their usage.
315315
316316
For example, suppose we have a billable metric that measures the number of

src/orb/resources/events/backfills.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -96,8 +96,8 @@ def create(
9696
9797
When `replace_existing_events` is `true`, this indicates that existing events in
9898
the timeframe should no longer be counted towards invoiced usage. In this
99-
scenario, the parameter `filter` can be optionally added which enables filtering
100-
using
99+
scenario, the parameter `deprecation_filter` can be optionally added which
100+
enables filtering using
101101
[computed properties](/extensibility/advanced-metrics#computed-properties). The
102102
expressiveness of computed properties allows you to deprecate existing events
103103
based on both a period of time and specific property values.
@@ -412,8 +412,8 @@ async def create(
412412
413413
When `replace_existing_events` is `true`, this indicates that existing events in
414414
the timeframe should no longer be counted towards invoiced usage. In this
415-
scenario, the parameter `filter` can be optionally added which enables filtering
416-
using
415+
scenario, the parameter `deprecation_filter` can be optionally added which
416+
enables filtering using
417417
[computed properties](/extensibility/advanced-metrics#computed-properties). The
418418
expressiveness of computed properties allows you to deprecate existing events
419419
based on both a period of time and specific property values.

0 commit comments

Comments
 (0)