diff --git a/.github/workflows/create_asana_task.yaml b/.github/workflows/create_asana_task.yaml deleted file mode 100644 index d3ef6e7d..00000000 --- a/.github/workflows/create_asana_task.yaml +++ /dev/null @@ -1,24 +0,0 @@ -name: Asana -on: - issues: - types: [opened] - -jobs: - create_task: - name: Create Asana task - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v3 - - - uses: orbcorp/gha-create-asana-task@main - with: - asana-secret: ${{ secrets.ASANA_PAT }} - asana-project-id: ${{ secrets.ASANA_PROJECT_ID }} - asana-workspace-id: ${{ secrets.ASANA_WORKSPACE_ID }} - asana-task-name: ${{ github.event.issue.title }} - asana-task-description: ${{ github.event.issue.body }} - asana-custom-fields: |- - { - "1205809189288915": "1205809189288916", - "1205809189288926": "${{ github.event.issue.html_url }}" - } diff --git a/.release-please-manifest.json b/.release-please-manifest.json index dd88ece2..bf0d0361 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "3.4.1" + ".": "3.5.0" } \ No newline at end of file diff --git a/.stats.yml b/.stats.yml index e5439953..a16642c4 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,2 +1,2 @@ configured_endpoints: 103 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-4dede72b827939939b5386cda07c3bc1fa2eea79901819792c1820e8531718d6.yml +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-99ab2def905df4700d0555a61c3e6f3e378664df85756fc0ff604aed8f8c5f8b.yml diff --git a/CHANGELOG.md b/CHANGELOG.md index d4198084..4461a772 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,25 @@ # Changelog +## 3.5.0 (2025-02-20) + +Full Changelog: [v3.4.1...v3.5.0](https://github.com/orbcorp/orb-python/compare/v3.4.1...v3.5.0) + +### Features + +* **api:** api update ([#543](https://github.com/orbcorp/orb-python/issues/543)) ([7bd608e](https://github.com/orbcorp/orb-python/commit/7bd608e2f10290c7ca754737127dc821bda7e08c)) +* **api:** api update ([#545](https://github.com/orbcorp/orb-python/issues/545)) ([b309efd](https://github.com/orbcorp/orb-python/commit/b309efd0ff24740c47ad0423f409b6d2c29992cd)) +* **client:** allow passing `NotGiven` for body ([#544](https://github.com/orbcorp/orb-python/issues/544)) ([d8b593c](https://github.com/orbcorp/orb-python/commit/d8b593cb7f57f9c4a7d2ad7a0a9461908c1adecf)) + + +### Bug Fixes + +* **client:** mark some request bodies as optional ([d8b593c](https://github.com/orbcorp/orb-python/commit/d8b593cb7f57f9c4a7d2ad7a0a9461908c1adecf)) + + +### Chores + +* **internal:** codegen related update ([#541](https://github.com/orbcorp/orb-python/issues/541)) ([c30d716](https://github.com/orbcorp/orb-python/commit/c30d716e16300e0b421e7d510455cf5714c07346)) + ## 3.4.1 (2025-02-15) Full Changelog: [v3.4.0...v3.4.1](https://github.com/orbcorp/orb-python/compare/v3.4.0...v3.4.1) diff --git a/pyproject.toml b/pyproject.toml index a3b0ee9c..9caf9ee2 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "orb-billing" -version = "3.4.1" +version = "3.5.0" description = "The official Python library for the orb API" dynamic = ["readme"] license = "Apache-2.0" diff --git a/src/orb/_base_client.py b/src/orb/_base_client.py index 49374230..f1c51f3d 100644 --- a/src/orb/_base_client.py +++ b/src/orb/_base_client.py @@ -519,7 +519,7 @@ def _build_request( # so that passing a `TypedDict` doesn't cause an error. # https://github.com/microsoft/pyright/issues/3526#event-6715453066 params=self.qs.stringify(cast(Mapping[str, Any], params)) if params else None, - json=json_data, + json=json_data if is_given(json_data) else None, files=files, **kwargs, ) diff --git a/src/orb/_version.py b/src/orb/_version.py index 0713e4a1..7591cf2d 100644 --- a/src/orb/_version.py +++ b/src/orb/_version.py @@ -1,4 +1,4 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. __title__ = "orb" -__version__ = "3.4.1" # x-release-please-version +__version__ = "3.5.0" # x-release-please-version diff --git a/src/orb/resources/events/events.py b/src/orb/resources/events/events.py index c90bfef1..8b5569bb 100644 --- a/src/orb/resources/events/events.py +++ b/src/orb/resources/events/events.py @@ -362,6 +362,8 @@ def ingest( flexible query engine to determine usage. - Logging a region or cluster with each event can help you provide customers more granular visibility into their usage. + - If you are using matrix pricing and matching a matrix price key with a + property, you should ensure the value for that property is sent as a string. We encourage logging this metadata with an eye towards future use cases to ensure full coverage for historical data. The datatype of the value in the @@ -911,6 +913,8 @@ async def ingest( flexible query engine to determine usage. - Logging a region or cluster with each event can help you provide customers more granular visibility into their usage. + - If you are using matrix pricing and matching a matrix price key with a + property, you should ensure the value for that property is sent as a string. We encourage logging this metadata with an eye towards future use cases to ensure full coverage for historical data. The datatype of the value in the diff --git a/src/orb/resources/prices/prices.py b/src/orb/resources/prices/prices.py index 49421320..608900f9 100644 --- a/src/orb/resources/prices/prices.py +++ b/src/orb/resources/prices/prices.py @@ -105,7 +105,7 @@ def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -192,7 +192,7 @@ def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -279,7 +279,7 @@ def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -370,7 +370,7 @@ def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -457,7 +457,7 @@ def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -546,7 +546,7 @@ def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -633,7 +633,7 @@ def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -720,7 +720,7 @@ def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -807,7 +807,7 @@ def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -898,7 +898,7 @@ def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -989,7 +989,7 @@ def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -1080,7 +1080,7 @@ def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -1171,7 +1171,7 @@ def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -1262,7 +1262,7 @@ def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -1353,7 +1353,7 @@ def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -1444,7 +1444,7 @@ def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -1535,7 +1535,7 @@ def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -1626,7 +1626,7 @@ def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -1717,7 +1717,7 @@ def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -1808,7 +1808,7 @@ def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -1899,7 +1899,7 @@ def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -1990,7 +1990,7 @@ def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -2081,7 +2081,7 @@ def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -2172,7 +2172,7 @@ def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -2263,7 +2263,7 @@ def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -2354,7 +2354,7 @@ def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -2445,7 +2445,7 @@ def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -2536,7 +2536,7 @@ def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -3053,7 +3053,7 @@ async def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -3140,7 +3140,7 @@ async def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -3227,7 +3227,7 @@ async def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -3318,7 +3318,7 @@ async def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -3405,7 +3405,7 @@ async def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -3494,7 +3494,7 @@ async def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -3581,7 +3581,7 @@ async def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -3668,7 +3668,7 @@ async def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -3755,7 +3755,7 @@ async def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -3846,7 +3846,7 @@ async def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -3937,7 +3937,7 @@ async def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -4028,7 +4028,7 @@ async def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -4119,7 +4119,7 @@ async def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -4210,7 +4210,7 @@ async def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -4301,7 +4301,7 @@ async def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -4392,7 +4392,7 @@ async def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -4483,7 +4483,7 @@ async def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -4574,7 +4574,7 @@ async def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -4665,7 +4665,7 @@ async def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -4756,7 +4756,7 @@ async def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -4847,7 +4847,7 @@ async def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -4938,7 +4938,7 @@ async def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -5029,7 +5029,7 @@ async def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -5120,7 +5120,7 @@ async def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -5211,7 +5211,7 @@ async def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -5302,7 +5302,7 @@ async def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -5393,7 +5393,7 @@ async def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. @@ -5484,7 +5484,7 @@ async def create( currency: An ISO 4217 currency string for which this price is billed in. - item_id: The id of the item the plan will be associated with. + item_id: The id of the item the price will be associated with. name: The name of the price. diff --git a/src/orb/resources/subscriptions.py b/src/orb/resources/subscriptions.py index a0f7140e..0b5272bc 100644 --- a/src/orb/resources/subscriptions.py +++ b/src/orb/resources/subscriptions.py @@ -1455,9 +1455,9 @@ def schedule_plan_change( `plan_phase_order` key to indicate which phase the price should be added to. An object in the list can specify an optional `start_date` and optional - `end_date`. This is equivalent to creating a price interval with the - [add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals). - If unspecified, the start or end date of the phase or subscription will be used. + `end_date`. If `start_date` is unspecified, the start of the phase / plan change + time will be used. If `end_date` is unspecified, it will finish at the end of + the phase / have no end time. An object in the list can specify an optional `minimum_amount`, `maximum_amount`, or `discounts`. This will create adjustments which apply only @@ -1516,8 +1516,9 @@ def schedule_plan_change( to. An object in the list can specify an optional `start_date` and optional - `end_date`. If unspecified, the start or end date of the phase or subscription - will be used. + `end_date`. If `start_date` is unspecified, the start of the phase / plan change + time will be used. If `end_date` is unspecified, it will finish at the end of + the phase / have no end time. ### Removing adjustments @@ -3450,9 +3451,9 @@ async def schedule_plan_change( `plan_phase_order` key to indicate which phase the price should be added to. An object in the list can specify an optional `start_date` and optional - `end_date`. This is equivalent to creating a price interval with the - [add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals). - If unspecified, the start or end date of the phase or subscription will be used. + `end_date`. If `start_date` is unspecified, the start of the phase / plan change + time will be used. If `end_date` is unspecified, it will finish at the end of + the phase / have no end time. An object in the list can specify an optional `minimum_amount`, `maximum_amount`, or `discounts`. This will create adjustments which apply only @@ -3511,8 +3512,9 @@ async def schedule_plan_change( to. An object in the list can specify an optional `start_date` and optional - `end_date`. If unspecified, the start or end date of the phase or subscription - will be used. + `end_date`. If `start_date` is unspecified, the start of the phase / plan change + time will be used. If `end_date` is unspecified, it will finish at the end of + the phase / have no end time. ### Removing adjustments diff --git a/src/orb/types/credit_note.py b/src/orb/types/credit_note.py index d883c425..ac789c61 100644 --- a/src/orb/types/credit_note.py +++ b/src/orb/types/credit_note.py @@ -59,6 +59,9 @@ class LineItem(BaseModel): amount: str """The amount of the line item, including any line item minimums and discounts.""" + item_id: str + """The id of the item associated with this line item.""" + name: str """The name of the corresponding invoice line item.""" diff --git a/src/orb/types/plan_create_params.py b/src/orb/types/plan_create_params.py index 7dc6c0f5..817ea7f3 100644 --- a/src/orb/types/plan_create_params.py +++ b/src/orb/types/plan_create_params.py @@ -168,7 +168,7 @@ class PriceNewPlanUnitPrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["unit"]] @@ -263,7 +263,7 @@ class PriceNewPlanPackagePrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["package"]] @@ -369,7 +369,7 @@ class PriceNewPlanMatrixPrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" matrix_config: Required[PriceNewPlanMatrixPriceMatrixConfig] @@ -468,7 +468,7 @@ class PriceNewPlanTieredPrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["tiered"]] @@ -573,7 +573,7 @@ class PriceNewPlanTieredBpsPrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["tiered_bps"]] @@ -666,7 +666,7 @@ class PriceNewPlanBpsPrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["bps"]] @@ -768,7 +768,7 @@ class PriceNewPlanBulkBpsPrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["bulk_bps"]] @@ -864,7 +864,7 @@ class PriceNewPlanBulkPrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["bulk"]] @@ -945,7 +945,7 @@ class PriceNewPlanThresholdTotalAmountPrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["threshold_total_amount"]] @@ -1028,7 +1028,7 @@ class PriceNewPlanTieredPackagePrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["tiered_package"]] @@ -1111,7 +1111,7 @@ class PriceNewPlanTieredWithMinimumPrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["tiered_with_minimum"]] @@ -1194,7 +1194,7 @@ class PriceNewPlanUnitWithPercentPrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["unit_with_percent"]] @@ -1277,7 +1277,7 @@ class PriceNewPlanPackageWithAllocationPrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["package_with_allocation"]] @@ -1360,7 +1360,7 @@ class PriceNewPlanTierWithProrationPrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["tiered_with_proration"]] @@ -1443,7 +1443,7 @@ class PriceNewPlanUnitWithProrationPrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["unit_with_proration"]] @@ -1528,7 +1528,7 @@ class PriceNewPlanGroupedAllocationPrice(TypedDict, total=False): grouped_allocation_config: Required[Dict[str, object]] item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["grouped_allocation"]] @@ -1611,7 +1611,7 @@ class PriceNewPlanGroupedWithProratedMinimumPrice(TypedDict, total=False): grouped_with_prorated_minimum_config: Required[Dict[str, object]] item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["grouped_with_prorated_minimum"]] @@ -1694,7 +1694,7 @@ class PriceNewPlanGroupedWithMeteredMinimumPrice(TypedDict, total=False): grouped_with_metered_minimum_config: Required[Dict[str, object]] item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["grouped_with_metered_minimum"]] @@ -1775,7 +1775,7 @@ class PriceNewPlanMatrixWithDisplayNamePrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" matrix_with_display_name_config: Required[Dict[str, object]] @@ -1860,7 +1860,7 @@ class PriceNewPlanBulkWithProrationPrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["bulk_with_proration"]] @@ -1943,7 +1943,7 @@ class PriceNewPlanGroupedTieredPackagePrice(TypedDict, total=False): grouped_tiered_package_config: Required[Dict[str, object]] item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["grouped_tiered_package"]] @@ -2024,7 +2024,7 @@ class PriceNewPlanMaxGroupTieredPackagePrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" max_group_tiered_package_config: Required[Dict[str, object]] @@ -2107,7 +2107,7 @@ class PriceNewPlanScalableMatrixWithUnitPricingPrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["scalable_matrix_with_unit_pricing"]] @@ -2190,7 +2190,7 @@ class PriceNewPlanScalableMatrixWithTieredPricingPrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["scalable_matrix_with_tiered_pricing"]] @@ -2275,7 +2275,7 @@ class PriceNewPlanCumulativeGroupedBulkPrice(TypedDict, total=False): cumulative_grouped_bulk_config: Required[Dict[str, object]] item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["cumulative_grouped_bulk"]] diff --git a/src/orb/types/price_create_params.py b/src/orb/types/price_create_params.py index 2107a3cb..3c41a7db 100644 --- a/src/orb/types/price_create_params.py +++ b/src/orb/types/price_create_params.py @@ -117,7 +117,7 @@ class NewFloatingUnitPrice(TypedDict, total=False): """An ISO 4217 currency string for which this price is billed in.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["unit"]] @@ -202,7 +202,7 @@ class NewFloatingPackagePrice(TypedDict, total=False): """An ISO 4217 currency string for which this price is billed in.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["package"]] @@ -294,7 +294,7 @@ class NewFloatingMatrixPrice(TypedDict, total=False): """An ISO 4217 currency string for which this price is billed in.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" matrix_config: Required[NewFloatingMatrixPriceMatrixConfig] @@ -397,7 +397,7 @@ class NewFloatingMatrixWithAllocationPrice(TypedDict, total=False): """An ISO 4217 currency string for which this price is billed in.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" matrix_with_allocation_config: Required[NewFloatingMatrixWithAllocationPriceMatrixWithAllocationConfig] @@ -503,7 +503,7 @@ class NewFloatingTieredPrice(TypedDict, total=False): """An ISO 4217 currency string for which this price is billed in.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["tiered"]] @@ -599,7 +599,7 @@ class NewFloatingTieredBpsPrice(TypedDict, total=False): """An ISO 4217 currency string for which this price is billed in.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["tiered_bps"]] @@ -703,7 +703,7 @@ class NewFloatingBpsPrice(TypedDict, total=False): """An ISO 4217 currency string for which this price is billed in.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["bps"]] @@ -791,7 +791,7 @@ class NewFloatingBulkBpsPrice(TypedDict, total=False): """An ISO 4217 currency string for which this price is billed in.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["bulk_bps"]] @@ -890,7 +890,7 @@ class NewFloatingBulkPrice(TypedDict, total=False): """An ISO 4217 currency string for which this price is billed in.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["bulk"]] @@ -981,7 +981,7 @@ class NewFloatingThresholdTotalAmountPrice(TypedDict, total=False): """An ISO 4217 currency string for which this price is billed in.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["threshold_total_amount"]] @@ -1061,7 +1061,7 @@ class NewFloatingTieredPackagePrice(TypedDict, total=False): """An ISO 4217 currency string for which this price is billed in.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["tiered_package"]] @@ -1143,7 +1143,7 @@ class NewFloatingGroupedTieredPrice(TypedDict, total=False): grouped_tiered_config: Required[Dict[str, object]] item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["grouped_tiered"]] @@ -1221,7 +1221,7 @@ class NewFloatingMaxGroupTieredPackagePrice(TypedDict, total=False): """An ISO 4217 currency string for which this price is billed in.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" max_group_tiered_package_config: Required[Dict[str, object]] @@ -1301,7 +1301,7 @@ class NewFloatingTieredWithMinimumPrice(TypedDict, total=False): """An ISO 4217 currency string for which this price is billed in.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["tiered_with_minimum"]] @@ -1381,7 +1381,7 @@ class NewFloatingPackageWithAllocationPrice(TypedDict, total=False): """An ISO 4217 currency string for which this price is billed in.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["package_with_allocation"]] @@ -1461,7 +1461,7 @@ class NewFloatingTieredPackageWithMinimumPrice(TypedDict, total=False): """An ISO 4217 currency string for which this price is billed in.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["tiered_package_with_minimum"]] @@ -1541,7 +1541,7 @@ class NewFloatingUnitWithPercentPrice(TypedDict, total=False): """An ISO 4217 currency string for which this price is billed in.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["unit_with_percent"]] @@ -1621,7 +1621,7 @@ class NewFloatingTieredWithProrationPrice(TypedDict, total=False): """An ISO 4217 currency string for which this price is billed in.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["tiered_with_proration"]] @@ -1701,7 +1701,7 @@ class NewFloatingUnitWithProrationPrice(TypedDict, total=False): """An ISO 4217 currency string for which this price is billed in.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["unit_with_proration"]] @@ -1783,7 +1783,7 @@ class NewFloatingGroupedAllocationPrice(TypedDict, total=False): grouped_allocation_config: Required[Dict[str, object]] item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["grouped_allocation"]] @@ -1863,7 +1863,7 @@ class NewFloatingGroupedWithProratedMinimumPrice(TypedDict, total=False): grouped_with_prorated_minimum_config: Required[Dict[str, object]] item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["grouped_with_prorated_minimum"]] @@ -1943,7 +1943,7 @@ class NewFloatingGroupedWithMeteredMinimumPrice(TypedDict, total=False): grouped_with_metered_minimum_config: Required[Dict[str, object]] item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["grouped_with_metered_minimum"]] @@ -2021,7 +2021,7 @@ class NewFloatingMatrixWithDisplayNamePrice(TypedDict, total=False): """An ISO 4217 currency string for which this price is billed in.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" matrix_with_display_name_config: Required[Dict[str, object]] @@ -2103,7 +2103,7 @@ class NewFloatingBulkWithProrationPrice(TypedDict, total=False): """An ISO 4217 currency string for which this price is billed in.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["bulk_with_proration"]] @@ -2183,7 +2183,7 @@ class NewFloatingGroupedTieredPackagePrice(TypedDict, total=False): grouped_tiered_package_config: Required[Dict[str, object]] item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["grouped_tiered_package"]] @@ -2261,7 +2261,7 @@ class NewFloatingScalableMatrixWithUnitPricingPrice(TypedDict, total=False): """An ISO 4217 currency string for which this price is billed in.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["scalable_matrix_with_unit_pricing"]] @@ -2341,7 +2341,7 @@ class NewFloatingScalableMatrixWithTieredPricingPrice(TypedDict, total=False): """An ISO 4217 currency string for which this price is billed in.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["scalable_matrix_with_tiered_pricing"]] @@ -2423,7 +2423,7 @@ class NewFloatingCumulativeGroupedBulkPrice(TypedDict, total=False): """An ISO 4217 currency string for which this price is billed in.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["cumulative_grouped_bulk"]] diff --git a/src/orb/types/subscription_create_params.py b/src/orb/types/subscription_create_params.py index 925ed3f3..f9df6679 100644 --- a/src/orb/types/subscription_create_params.py +++ b/src/orb/types/subscription_create_params.py @@ -494,7 +494,7 @@ class AddPricePriceNewSubscriptionUnitPrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["unit"]] @@ -595,7 +595,7 @@ class AddPricePriceNewSubscriptionPackagePrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["package"]] @@ -707,7 +707,7 @@ class AddPricePriceNewSubscriptionMatrixPrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" matrix_config: Required[AddPricePriceNewSubscriptionMatrixPriceMatrixConfig] @@ -812,7 +812,7 @@ class AddPricePriceNewSubscriptionTieredPrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["tiered"]] @@ -923,7 +923,7 @@ class AddPricePriceNewSubscriptionTieredBpsPrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["tiered_bps"]] @@ -1022,7 +1022,7 @@ class AddPricePriceNewSubscriptionBpsPrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["bps"]] @@ -1130,7 +1130,7 @@ class AddPricePriceNewSubscriptionBulkBpsPrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["bulk_bps"]] @@ -1232,7 +1232,7 @@ class AddPricePriceNewSubscriptionBulkPrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["bulk"]] @@ -1319,7 +1319,7 @@ class AddPricePriceNewSubscriptionThresholdTotalAmountPrice(TypedDict, total=Fal """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["threshold_total_amount"]] @@ -1412,7 +1412,7 @@ class AddPricePriceNewSubscriptionTieredPackagePrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["tiered_package"]] @@ -1501,7 +1501,7 @@ class AddPricePriceNewSubscriptionTieredWithMinimumPrice(TypedDict, total=False) """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["tiered_with_minimum"]] @@ -1592,7 +1592,7 @@ class AddPricePriceNewSubscriptionUnitWithPercentPrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["unit_with_percent"]] @@ -1681,7 +1681,7 @@ class AddPricePriceNewSubscriptionPackageWithAllocationPrice(TypedDict, total=Fa """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["package_with_allocation"]] @@ -1774,7 +1774,7 @@ class AddPricePriceNewSubscriptionTierWithProrationPrice(TypedDict, total=False) """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["tiered_with_proration"]] @@ -1865,7 +1865,7 @@ class AddPricePriceNewSubscriptionUnitWithProrationPrice(TypedDict, total=False) """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["unit_with_proration"]] @@ -1958,7 +1958,7 @@ class AddPricePriceNewSubscriptionGroupedAllocationPrice(TypedDict, total=False) grouped_allocation_config: Required[Dict[str, object]] item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["grouped_allocation"]] @@ -2049,7 +2049,7 @@ class AddPricePriceNewSubscriptionGroupedWithProratedMinimumPrice(TypedDict, tot grouped_with_prorated_minimum_config: Required[Dict[str, object]] item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["grouped_with_prorated_minimum"]] @@ -2142,7 +2142,7 @@ class AddPricePriceNewSubscriptionBulkWithProrationPrice(TypedDict, total=False) """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["bulk_with_proration"]] @@ -2478,7 +2478,7 @@ class ReplacePricePriceNewSubscriptionUnitPrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["unit"]] @@ -2579,7 +2579,7 @@ class ReplacePricePriceNewSubscriptionPackagePrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["package"]] @@ -2691,7 +2691,7 @@ class ReplacePricePriceNewSubscriptionMatrixPrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" matrix_config: Required[ReplacePricePriceNewSubscriptionMatrixPriceMatrixConfig] @@ -2796,7 +2796,7 @@ class ReplacePricePriceNewSubscriptionTieredPrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["tiered"]] @@ -2907,7 +2907,7 @@ class ReplacePricePriceNewSubscriptionTieredBpsPrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["tiered_bps"]] @@ -3006,7 +3006,7 @@ class ReplacePricePriceNewSubscriptionBpsPrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["bps"]] @@ -3114,7 +3114,7 @@ class ReplacePricePriceNewSubscriptionBulkBpsPrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["bulk_bps"]] @@ -3216,7 +3216,7 @@ class ReplacePricePriceNewSubscriptionBulkPrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["bulk"]] @@ -3303,7 +3303,7 @@ class ReplacePricePriceNewSubscriptionThresholdTotalAmountPrice(TypedDict, total """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["threshold_total_amount"]] @@ -3396,7 +3396,7 @@ class ReplacePricePriceNewSubscriptionTieredPackagePrice(TypedDict, total=False) """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["tiered_package"]] @@ -3487,7 +3487,7 @@ class ReplacePricePriceNewSubscriptionTieredWithMinimumPrice(TypedDict, total=Fa """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["tiered_with_minimum"]] @@ -3580,7 +3580,7 @@ class ReplacePricePriceNewSubscriptionUnitWithPercentPrice(TypedDict, total=Fals """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["unit_with_percent"]] @@ -3671,7 +3671,7 @@ class ReplacePricePriceNewSubscriptionPackageWithAllocationPrice(TypedDict, tota """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["package_with_allocation"]] @@ -3764,7 +3764,7 @@ class ReplacePricePriceNewSubscriptionTierWithProrationPrice(TypedDict, total=Fa """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["tiered_with_proration"]] @@ -3857,7 +3857,7 @@ class ReplacePricePriceNewSubscriptionUnitWithProrationPrice(TypedDict, total=Fa """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["unit_with_proration"]] @@ -3952,7 +3952,7 @@ class ReplacePricePriceNewSubscriptionGroupedAllocationPrice(TypedDict, total=Fa grouped_allocation_config: Required[Dict[str, object]] item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["grouped_allocation"]] @@ -4047,7 +4047,7 @@ class ReplacePricePriceNewSubscriptionGroupedWithProratedMinimumPrice(TypedDict, grouped_with_prorated_minimum_config: Required[Dict[str, object]] item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["grouped_with_prorated_minimum"]] @@ -4140,7 +4140,7 @@ class ReplacePricePriceNewSubscriptionBulkWithProrationPrice(TypedDict, total=Fa """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["bulk_with_proration"]] diff --git a/src/orb/types/subscription_price_intervals_params.py b/src/orb/types/subscription_price_intervals_params.py index 16e71a74..49e58257 100644 --- a/src/orb/types/subscription_price_intervals_params.py +++ b/src/orb/types/subscription_price_intervals_params.py @@ -243,7 +243,7 @@ class AddPriceNewFloatingUnitPrice(TypedDict, total=False): """An ISO 4217 currency string for which this price is billed in.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["unit"]] @@ -335,7 +335,7 @@ class AddPriceNewFloatingPackagePrice(TypedDict, total=False): """An ISO 4217 currency string for which this price is billed in.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["package"]] @@ -438,7 +438,7 @@ class AddPriceNewFloatingMatrixPrice(TypedDict, total=False): """An ISO 4217 currency string for which this price is billed in.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" matrix_config: Required[AddPriceNewFloatingMatrixPriceMatrixConfig] @@ -544,7 +544,7 @@ class AddPriceNewFloatingMatrixWithAllocationPrice(TypedDict, total=False): """An ISO 4217 currency string for which this price is billed in.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" matrix_with_allocation_config: Required[AddPriceNewFloatingMatrixWithAllocationPriceMatrixWithAllocationConfig] @@ -640,7 +640,7 @@ class AddPriceNewFloatingTieredPrice(TypedDict, total=False): """An ISO 4217 currency string for which this price is billed in.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["tiered"]] @@ -742,7 +742,7 @@ class AddPriceNewFloatingTieredBpsPrice(TypedDict, total=False): """An ISO 4217 currency string for which this price is billed in.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["tiered_bps"]] @@ -832,7 +832,7 @@ class AddPriceNewFloatingBpsPrice(TypedDict, total=False): """An ISO 4217 currency string for which this price is billed in.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["bps"]] @@ -931,7 +931,7 @@ class AddPriceNewFloatingBulkBpsPrice(TypedDict, total=False): """An ISO 4217 currency string for which this price is billed in.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["bulk_bps"]] @@ -1024,7 +1024,7 @@ class AddPriceNewFloatingBulkPrice(TypedDict, total=False): """An ISO 4217 currency string for which this price is billed in.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["bulk"]] @@ -1102,7 +1102,7 @@ class AddPriceNewFloatingThresholdTotalAmountPrice(TypedDict, total=False): """An ISO 4217 currency string for which this price is billed in.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["threshold_total_amount"]] @@ -1182,7 +1182,7 @@ class AddPriceNewFloatingTieredPackagePrice(TypedDict, total=False): """An ISO 4217 currency string for which this price is billed in.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["tiered_package"]] @@ -1264,7 +1264,7 @@ class AddPriceNewFloatingGroupedTieredPrice(TypedDict, total=False): grouped_tiered_config: Required[Dict[str, object]] item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["grouped_tiered"]] @@ -1342,7 +1342,7 @@ class AddPriceNewFloatingMaxGroupTieredPackagePrice(TypedDict, total=False): """An ISO 4217 currency string for which this price is billed in.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" max_group_tiered_package_config: Required[Dict[str, object]] @@ -1422,7 +1422,7 @@ class AddPriceNewFloatingTieredWithMinimumPrice(TypedDict, total=False): """An ISO 4217 currency string for which this price is billed in.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["tiered_with_minimum"]] @@ -1502,7 +1502,7 @@ class AddPriceNewFloatingPackageWithAllocationPrice(TypedDict, total=False): """An ISO 4217 currency string for which this price is billed in.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["package_with_allocation"]] @@ -1582,7 +1582,7 @@ class AddPriceNewFloatingTieredPackageWithMinimumPrice(TypedDict, total=False): """An ISO 4217 currency string for which this price is billed in.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["tiered_package_with_minimum"]] @@ -1662,7 +1662,7 @@ class AddPriceNewFloatingUnitWithPercentPrice(TypedDict, total=False): """An ISO 4217 currency string for which this price is billed in.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["unit_with_percent"]] @@ -1742,7 +1742,7 @@ class AddPriceNewFloatingTieredWithProrationPrice(TypedDict, total=False): """An ISO 4217 currency string for which this price is billed in.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["tiered_with_proration"]] @@ -1822,7 +1822,7 @@ class AddPriceNewFloatingUnitWithProrationPrice(TypedDict, total=False): """An ISO 4217 currency string for which this price is billed in.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["unit_with_proration"]] @@ -1904,7 +1904,7 @@ class AddPriceNewFloatingGroupedAllocationPrice(TypedDict, total=False): grouped_allocation_config: Required[Dict[str, object]] item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["grouped_allocation"]] @@ -1984,7 +1984,7 @@ class AddPriceNewFloatingGroupedWithProratedMinimumPrice(TypedDict, total=False) grouped_with_prorated_minimum_config: Required[Dict[str, object]] item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["grouped_with_prorated_minimum"]] @@ -2066,7 +2066,7 @@ class AddPriceNewFloatingGroupedWithMeteredMinimumPrice(TypedDict, total=False): grouped_with_metered_minimum_config: Required[Dict[str, object]] item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["grouped_with_metered_minimum"]] @@ -2146,7 +2146,7 @@ class AddPriceNewFloatingMatrixWithDisplayNamePrice(TypedDict, total=False): """An ISO 4217 currency string for which this price is billed in.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" matrix_with_display_name_config: Required[Dict[str, object]] @@ -2228,7 +2228,7 @@ class AddPriceNewFloatingBulkWithProrationPrice(TypedDict, total=False): """An ISO 4217 currency string for which this price is billed in.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["bulk_with_proration"]] @@ -2308,7 +2308,7 @@ class AddPriceNewFloatingGroupedTieredPackagePrice(TypedDict, total=False): grouped_tiered_package_config: Required[Dict[str, object]] item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["grouped_tiered_package"]] @@ -2386,7 +2386,7 @@ class AddPriceNewFloatingScalableMatrixWithUnitPricingPrice(TypedDict, total=Fal """An ISO 4217 currency string for which this price is billed in.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["scalable_matrix_with_unit_pricing"]] @@ -2470,7 +2470,7 @@ class AddPriceNewFloatingScalableMatrixWithTieredPricingPrice(TypedDict, total=F """An ISO 4217 currency string for which this price is billed in.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["scalable_matrix_with_tiered_pricing"]] @@ -2556,7 +2556,7 @@ class AddPriceNewFloatingCumulativeGroupedBulkPrice(TypedDict, total=False): """An ISO 4217 currency string for which this price is billed in.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["cumulative_grouped_bulk"]] diff --git a/src/orb/types/subscription_schedule_plan_change_params.py b/src/orb/types/subscription_schedule_plan_change_params.py index b2fd7dff..8fd8776b 100644 --- a/src/orb/types/subscription_schedule_plan_change_params.py +++ b/src/orb/types/subscription_schedule_plan_change_params.py @@ -494,7 +494,7 @@ class AddPricePriceNewSubscriptionUnitPrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["unit"]] @@ -595,7 +595,7 @@ class AddPricePriceNewSubscriptionPackagePrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["package"]] @@ -707,7 +707,7 @@ class AddPricePriceNewSubscriptionMatrixPrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" matrix_config: Required[AddPricePriceNewSubscriptionMatrixPriceMatrixConfig] @@ -812,7 +812,7 @@ class AddPricePriceNewSubscriptionTieredPrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["tiered"]] @@ -923,7 +923,7 @@ class AddPricePriceNewSubscriptionTieredBpsPrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["tiered_bps"]] @@ -1022,7 +1022,7 @@ class AddPricePriceNewSubscriptionBpsPrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["bps"]] @@ -1130,7 +1130,7 @@ class AddPricePriceNewSubscriptionBulkBpsPrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["bulk_bps"]] @@ -1232,7 +1232,7 @@ class AddPricePriceNewSubscriptionBulkPrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["bulk"]] @@ -1319,7 +1319,7 @@ class AddPricePriceNewSubscriptionThresholdTotalAmountPrice(TypedDict, total=Fal """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["threshold_total_amount"]] @@ -1412,7 +1412,7 @@ class AddPricePriceNewSubscriptionTieredPackagePrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["tiered_package"]] @@ -1501,7 +1501,7 @@ class AddPricePriceNewSubscriptionTieredWithMinimumPrice(TypedDict, total=False) """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["tiered_with_minimum"]] @@ -1592,7 +1592,7 @@ class AddPricePriceNewSubscriptionUnitWithPercentPrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["unit_with_percent"]] @@ -1681,7 +1681,7 @@ class AddPricePriceNewSubscriptionPackageWithAllocationPrice(TypedDict, total=Fa """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["package_with_allocation"]] @@ -1774,7 +1774,7 @@ class AddPricePriceNewSubscriptionTierWithProrationPrice(TypedDict, total=False) """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["tiered_with_proration"]] @@ -1865,7 +1865,7 @@ class AddPricePriceNewSubscriptionUnitWithProrationPrice(TypedDict, total=False) """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["unit_with_proration"]] @@ -1958,7 +1958,7 @@ class AddPricePriceNewSubscriptionGroupedAllocationPrice(TypedDict, total=False) grouped_allocation_config: Required[Dict[str, object]] item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["grouped_allocation"]] @@ -2049,7 +2049,7 @@ class AddPricePriceNewSubscriptionGroupedWithProratedMinimumPrice(TypedDict, tot grouped_with_prorated_minimum_config: Required[Dict[str, object]] item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["grouped_with_prorated_minimum"]] @@ -2142,7 +2142,7 @@ class AddPricePriceNewSubscriptionBulkWithProrationPrice(TypedDict, total=False) """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["bulk_with_proration"]] @@ -2478,7 +2478,7 @@ class ReplacePricePriceNewSubscriptionUnitPrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["unit"]] @@ -2579,7 +2579,7 @@ class ReplacePricePriceNewSubscriptionPackagePrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["package"]] @@ -2691,7 +2691,7 @@ class ReplacePricePriceNewSubscriptionMatrixPrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" matrix_config: Required[ReplacePricePriceNewSubscriptionMatrixPriceMatrixConfig] @@ -2796,7 +2796,7 @@ class ReplacePricePriceNewSubscriptionTieredPrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["tiered"]] @@ -2907,7 +2907,7 @@ class ReplacePricePriceNewSubscriptionTieredBpsPrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["tiered_bps"]] @@ -3006,7 +3006,7 @@ class ReplacePricePriceNewSubscriptionBpsPrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["bps"]] @@ -3114,7 +3114,7 @@ class ReplacePricePriceNewSubscriptionBulkBpsPrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["bulk_bps"]] @@ -3216,7 +3216,7 @@ class ReplacePricePriceNewSubscriptionBulkPrice(TypedDict, total=False): """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["bulk"]] @@ -3303,7 +3303,7 @@ class ReplacePricePriceNewSubscriptionThresholdTotalAmountPrice(TypedDict, total """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["threshold_total_amount"]] @@ -3396,7 +3396,7 @@ class ReplacePricePriceNewSubscriptionTieredPackagePrice(TypedDict, total=False) """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["tiered_package"]] @@ -3487,7 +3487,7 @@ class ReplacePricePriceNewSubscriptionTieredWithMinimumPrice(TypedDict, total=Fa """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["tiered_with_minimum"]] @@ -3580,7 +3580,7 @@ class ReplacePricePriceNewSubscriptionUnitWithPercentPrice(TypedDict, total=Fals """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["unit_with_percent"]] @@ -3671,7 +3671,7 @@ class ReplacePricePriceNewSubscriptionPackageWithAllocationPrice(TypedDict, tota """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["package_with_allocation"]] @@ -3764,7 +3764,7 @@ class ReplacePricePriceNewSubscriptionTierWithProrationPrice(TypedDict, total=Fa """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["tiered_with_proration"]] @@ -3857,7 +3857,7 @@ class ReplacePricePriceNewSubscriptionUnitWithProrationPrice(TypedDict, total=Fa """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["unit_with_proration"]] @@ -3952,7 +3952,7 @@ class ReplacePricePriceNewSubscriptionGroupedAllocationPrice(TypedDict, total=Fa grouped_allocation_config: Required[Dict[str, object]] item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["grouped_allocation"]] @@ -4047,7 +4047,7 @@ class ReplacePricePriceNewSubscriptionGroupedWithProratedMinimumPrice(TypedDict, grouped_with_prorated_minimum_config: Required[Dict[str, object]] item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["grouped_with_prorated_minimum"]] @@ -4140,7 +4140,7 @@ class ReplacePricePriceNewSubscriptionBulkWithProrationPrice(TypedDict, total=Fa """The cadence to bill for this price on.""" item_id: Required[str] - """The id of the item the plan will be associated with.""" + """The id of the item the price will be associated with.""" model_type: Required[Literal["bulk_with_proration"]]