fix(types): loosen most List params types to Iterable (#167)

stainless-bot · stainless-bot · commit 1a6d3036ef8c · 2024-02-06T15:26:01.000Z
diff --git a/src/orb/resources/customers/usage.py b/src/orb/resources/customers/usage.py
@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import List, Union, Optional
+from typing import Union, Iterable, Optional
 from datetime import datetime
 
 import httpx
@@ -39,7 +39,7 @@ def update(
         self,
         id: Optional[str],
         *,
-        events: List[usage_update_params.Event],
+        events: Iterable[usage_update_params.Event],
         timeframe_end: Union[str, datetime] | NotGiven = NOT_GIVEN,
         timeframe_start: Union[str, datetime] | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -192,7 +192,7 @@ def update_by_external_id(
         self,
         id: Optional[str],
         *,
-        events: List[usage_update_by_external_id_params.Event],
+        events: Iterable[usage_update_by_external_id_params.Event],
         timeframe_end: Union[str, datetime] | NotGiven = NOT_GIVEN,
         timeframe_start: Union[str, datetime] | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -355,7 +355,7 @@ async def update(
         self,
         id: Optional[str],
         *,
-        events: List[usage_update_params.Event],
+        events: Iterable[usage_update_params.Event],
         timeframe_end: Union[str, datetime] | NotGiven = NOT_GIVEN,
         timeframe_start: Union[str, datetime] | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -508,7 +508,7 @@ async def update_by_external_id(
         self,
         id: Optional[str],
         *,
-        events: List[usage_update_by_external_id_params.Event],
+        events: Iterable[usage_update_by_external_id_params.Event],
         timeframe_end: Union[str, datetime] | NotGiven = NOT_GIVEN,
         timeframe_start: Union[str, datetime] | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
diff --git a/src/orb/resources/events/events.py b/src/orb/resources/events/events.py
@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import List, Union, Optional
+from typing import List, Union, Iterable, Optional
 from datetime import datetime
 
 import httpx
@@ -240,7 +240,7 @@ def deprecate(
     def ingest(
         self,
         *,
-        events: List[event_ingest_params.Event],
+        events: Iterable[event_ingest_params.Event],
         backfill_id: Optional[str] | NotGiven = NOT_GIVEN,
         debug: bool | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -765,7 +765,7 @@ async def deprecate(
     async def ingest(
         self,
         *,
-        events: List[event_ingest_params.Event],
+        events: Iterable[event_ingest_params.Event],
         backfill_id: Optional[str] | NotGiven = NOT_GIVEN,
         debug: bool | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
diff --git a/src/orb/resources/invoices.py b/src/orb/resources/invoices.py
@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import List, Union, Optional
+from typing import List, Union, Iterable, Optional
 from datetime import date, datetime
 from typing_extensions import Literal
 
@@ -45,7 +45,7 @@ def create(
         *,
         currency: str,
         invoice_date: Union[str, datetime],
-        line_items: List[invoice_create_params.LineItem],
+        line_items: Iterable[invoice_create_params.LineItem],
         net_terms: int,
         customer_id: Optional[str] | NotGiven = NOT_GIVEN,
         external_customer_id: Optional[str] | NotGiven = NOT_GIVEN,
@@ -450,7 +450,7 @@ async def create(
         *,
         currency: str,
         invoice_date: Union[str, datetime],
-        line_items: List[invoice_create_params.LineItem],
+        line_items: Iterable[invoice_create_params.LineItem],
         net_terms: int,
         customer_id: Optional[str] | NotGiven = NOT_GIVEN,
         external_customer_id: Optional[str] | NotGiven = NOT_GIVEN,
diff --git a/src/orb/resources/plans/plans.py b/src/orb/resources/plans/plans.py
@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Dict, List, Union, Optional
+from typing import Dict, Union, Iterable, Optional
 from datetime import datetime
 from typing_extensions import Literal
 
@@ -50,7 +50,7 @@ def create(
         *,
         currency: str,
         name: str,
-        prices: List[plan_create_params.Price],
+        prices: Iterable[plan_create_params.Price],
         default_invoice_memo: Optional[str] | NotGiven = NOT_GIVEN,
         external_plan_id: Optional[str] | NotGiven = NOT_GIVEN,
         metadata: Optional[Dict[str, Optional[str]]] | NotGiven = NOT_GIVEN,
@@ -309,7 +309,7 @@ async def create(
         *,
         currency: str,
         name: str,
-        prices: List[plan_create_params.Price],
+        prices: Iterable[plan_create_params.Price],
         default_invoice_memo: Optional[str] | NotGiven = NOT_GIVEN,
         external_plan_id: Optional[str] | NotGiven = NOT_GIVEN,
         metadata: Optional[Dict[str, Optional[str]]] | NotGiven = NOT_GIVEN,
diff --git a/src/orb/resources/subscriptions.py b/src/orb/resources/subscriptions.py
@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Any, Dict, List, Union, Optional, cast
+from typing import Any, Dict, Union, Iterable, Optional, cast
 from datetime import date, datetime
 from typing_extensions import Literal
 
@@ -70,7 +70,7 @@ def create(
         net_terms: Optional[int] | NotGiven = NOT_GIVEN,
         per_credit_overage_amount: Optional[str] | NotGiven = NOT_GIVEN,
         plan_id: Optional[str] | NotGiven = NOT_GIVEN,
-        price_overrides: Optional[List[subscription_create_params.PriceOverride]] | NotGiven = NOT_GIVEN,
+        price_overrides: Optional[Iterable[subscription_create_params.PriceOverride]] | NotGiven = NOT_GIVEN,
         start_date: Union[str, datetime, None] | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -1166,8 +1166,8 @@ def price_intervals(
         self,
         subscription_id: str,
         *,
-        add: List[subscription_price_intervals_params.Add] | NotGiven = NOT_GIVEN,
-        edit: List[subscription_price_intervals_params.Edit] | NotGiven = NOT_GIVEN,
+        add: Iterable[subscription_price_intervals_params.Add] | NotGiven = NOT_GIVEN,
+        edit: Iterable[subscription_price_intervals_params.Edit] | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -1287,7 +1287,8 @@ def schedule_plan_change(
         invoicing_threshold: Optional[str] | NotGiven = NOT_GIVEN,
         per_credit_overage_amount: Optional[str] | NotGiven = NOT_GIVEN,
         plan_id: Optional[str] | NotGiven = NOT_GIVEN,
-        price_overrides: Optional[List[subscription_schedule_plan_change_params.PriceOverride]] | NotGiven = NOT_GIVEN,
+        price_overrides: Optional[Iterable[subscription_schedule_plan_change_params.PriceOverride]]
+        | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -1699,7 +1700,7 @@ async def create(
         net_terms: Optional[int] | NotGiven = NOT_GIVEN,
         per_credit_overage_amount: Optional[str] | NotGiven = NOT_GIVEN,
         plan_id: Optional[str] | NotGiven = NOT_GIVEN,
-        price_overrides: Optional[List[subscription_create_params.PriceOverride]] | NotGiven = NOT_GIVEN,
+        price_overrides: Optional[Iterable[subscription_create_params.PriceOverride]] | NotGiven = NOT_GIVEN,
         start_date: Union[str, datetime, None] | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -2795,8 +2796,8 @@ async def price_intervals(
         self,
         subscription_id: str,
         *,
-        add: List[subscription_price_intervals_params.Add] | NotGiven = NOT_GIVEN,
-        edit: List[subscription_price_intervals_params.Edit] | NotGiven = NOT_GIVEN,
+        add: Iterable[subscription_price_intervals_params.Add] | NotGiven = NOT_GIVEN,
+        edit: Iterable[subscription_price_intervals_params.Edit] | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -2916,7 +2917,8 @@ async def schedule_plan_change(
         invoicing_threshold: Optional[str] | NotGiven = NOT_GIVEN,
         per_credit_overage_amount: Optional[str] | NotGiven = NOT_GIVEN,
         plan_id: Optional[str] | NotGiven = NOT_GIVEN,
-        price_overrides: Optional[List[subscription_schedule_plan_change_params.PriceOverride]] | NotGiven = NOT_GIVEN,
+        price_overrides: Optional[Iterable[subscription_schedule_plan_change_params.PriceOverride]]
+        | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
diff --git a/src/orb/types/customer_create_params.py b/src/orb/types/customer_create_params.py
@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Dict, List, Optional
+from typing import Dict, List, Iterable, Optional
 from typing_extensions import Literal, Required, TypedDict
 
 __all__ = [
@@ -187,7 +187,7 @@ class AccountingSyncConfigurationAccountingProvider(TypedDict, total=False):
 
 
 class AccountingSyncConfiguration(TypedDict, total=False):
-    accounting_providers: Optional[List[AccountingSyncConfigurationAccountingProvider]]
+    accounting_providers: Optional[Iterable[AccountingSyncConfigurationAccountingProvider]]
 
     excluded: Optional[bool]
 
diff --git a/src/orb/types/customer_update_by_external_id_params.py b/src/orb/types/customer_update_by_external_id_params.py
@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Dict, List, Optional
+from typing import Dict, List, Iterable, Optional
 from typing_extensions import Literal, Required, TypedDict
 
 __all__ = [
@@ -180,7 +180,7 @@ class AccountingSyncConfigurationAccountingProvider(TypedDict, total=False):
 
 
 class AccountingSyncConfiguration(TypedDict, total=False):
-    accounting_providers: Optional[List[AccountingSyncConfigurationAccountingProvider]]
+    accounting_providers: Optional[Iterable[AccountingSyncConfigurationAccountingProvider]]
 
     excluded: Optional[bool]
 
diff --git a/src/orb/types/customer_update_params.py b/src/orb/types/customer_update_params.py
@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Dict, List, Optional
+from typing import Dict, List, Iterable, Optional
 from typing_extensions import Literal, Required, TypedDict
 
 __all__ = [
@@ -180,7 +180,7 @@ class AccountingSyncConfigurationAccountingProvider(TypedDict, total=False):
 
 
 class AccountingSyncConfiguration(TypedDict, total=False):
-    accounting_providers: Optional[List[AccountingSyncConfigurationAccountingProvider]]
+    accounting_providers: Optional[Iterable[AccountingSyncConfigurationAccountingProvider]]
 
     excluded: Optional[bool]
 
diff --git a/src/orb/types/customers/usage_update_by_external_id_params.py b/src/orb/types/customers/usage_update_by_external_id_params.py
@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import List, Union, Optional
+from typing import Union, Iterable, Optional
 from datetime import datetime
 from typing_extensions import Required, Annotated, TypedDict
 
@@ -12,7 +12,7 @@
 
 
 class UsageUpdateByExternalIDParams(TypedDict, total=False):
-    events: Required[List[Event]]
+    events: Required[Iterable[Event]]
     """Events to update"""
 
     timeframe_end: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
diff --git a/src/orb/types/customers/usage_update_params.py b/src/orb/types/customers/usage_update_params.py
@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import List, Union, Optional
+from typing import Union, Iterable, Optional
 from datetime import datetime
 from typing_extensions import Required, Annotated, TypedDict
 
@@ -12,7 +12,7 @@
 
 
 class UsageUpdateParams(TypedDict, total=False):
-    events: Required[List[Event]]
+    events: Required[Iterable[Event]]
     """Events to update"""
 
     timeframe_end: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
diff --git a/src/orb/types/event_ingest_params.py b/src/orb/types/event_ingest_params.py
@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import List, Union, Optional
+from typing import Union, Iterable, Optional
 from datetime import datetime
 from typing_extensions import Required, Annotated, TypedDict
 
@@ -12,7 +12,7 @@
 
 
 class EventIngestParams(TypedDict, total=False):
-    events: Required[List[Event]]
+    events: Required[Iterable[Event]]
 
     backfill_id: Optional[str]
     """
diff --git a/src/orb/types/invoice_create_params.py b/src/orb/types/invoice_create_params.py
@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import List, Union, Optional
+from typing import Union, Iterable, Optional
 from datetime import date, datetime
 from typing_extensions import Literal, Required, Annotated, TypedDict
 
@@ -25,7 +25,7 @@ class InvoiceCreateParams(TypedDict, total=False):
     the customer's timezone.
     """
 
-    line_items: Required[List[LineItem]]
+    line_items: Required[Iterable[LineItem]]
 
     net_terms: Required[int]
     """
diff --git a/src/orb/types/plan_create_params.py b/src/orb/types/plan_create_params.py
@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Dict, List, Union, Optional
+from typing import Dict, List, Union, Iterable, Optional
 from typing_extensions import Literal, Required, TypedDict
 
 __all__ = [
@@ -45,7 +45,7 @@ class PlanCreateParams(TypedDict, total=False):
 
     name: Required[str]
 
-    prices: Required[List[Price]]
+    prices: Required[Iterable[Price]]
     """Prices for this plan.
 
     If the plan has phases, this includes prices across all phases of the plan.
@@ -193,7 +193,7 @@ class PriceNewPlanMatrixPriceMatrixConfig(TypedDict, total=False):
     dimensions: Required[List[Optional[str]]]
     """One or two event property values to evaluate matrix groups by"""
 
-    matrix_values: Required[List[PriceNewPlanMatrixPriceMatrixConfigMatrixValue]]
+    matrix_values: Required[Iterable[PriceNewPlanMatrixPriceMatrixConfigMatrixValue]]
     """Matrix values for specified matrix grouping keys"""
 
     scaling_factor: Optional[float]
@@ -254,7 +254,7 @@ class PriceNewPlanTieredPriceTieredConfigTier(TypedDict, total=False):
 
 
 class PriceNewPlanTieredPriceTieredConfig(TypedDict, total=False):
-    tiers: Required[List[PriceNewPlanTieredPriceTieredConfigTier]]
+    tiers: Required[Iterable[PriceNewPlanTieredPriceTieredConfigTier]]
     """Tiers for rating based on total usage quantities into the specified tier"""
 
 
@@ -312,7 +312,7 @@ class PriceNewPlanTieredBpsPriceTieredBpsConfigTier(TypedDict, total=False):
 
 
 class PriceNewPlanTieredBpsPriceTieredBpsConfig(TypedDict, total=False):
-    tiers: Required[List[PriceNewPlanTieredBpsPriceTieredBpsConfigTier]]
+    tiers: Required[Iterable[PriceNewPlanTieredBpsPriceTieredBpsConfigTier]]
     """
     Tiers for a Graduated BPS pricing model, where usage is bucketed into specified
     tiers
@@ -417,7 +417,7 @@ class PriceNewPlanBulkBpsPriceBulkBpsConfigTier(TypedDict, total=False):
 
 
 class PriceNewPlanBulkBpsPriceBulkBpsConfig(TypedDict, total=False):
-    tiers: Required[List[PriceNewPlanBulkBpsPriceBulkBpsConfigTier]]
+    tiers: Required[Iterable[PriceNewPlanBulkBpsPriceBulkBpsConfigTier]]
     """
     Tiers for a bulk BPS pricing model where all usage is aggregated to a single
     tier based on total volume
@@ -472,7 +472,7 @@ class PriceNewPlanBulkPriceBulkConfigTier(TypedDict, total=False):
 
 
 class PriceNewPlanBulkPriceBulkConfig(TypedDict, total=False):
-    tiers: Required[List[PriceNewPlanBulkPriceBulkConfigTier]]
+    tiers: Required[Iterable[PriceNewPlanBulkPriceBulkConfigTier]]
     """Bulk tiers for rating based on total usage volume"""
 
 
diff --git a/src/orb/types/price_create_params.py b/src/orb/types/price_create_params.py
diff --git a/src/orb/types/subscription_create_params.py b/src/orb/types/subscription_create_params.py
diff --git a/src/orb/types/subscription_price_intervals_params.py b/src/orb/types/subscription_price_intervals_params.py
diff --git a/src/orb/types/subscription_schedule_plan_change_params.py b/src/orb/types/subscription_schedule_plan_change_params.py
