feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 139
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-0186c0310e2a9f40302cc35f4248fca335b7ec8069502f684ba6f2fa37793033.yml
-openapi_spec_hash: 4fb1d2837ad3794864a7d59d393d6ff6
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-5bb582f84f0b4cf7bef84833fefd48a5f2734dc25805da2028fd8a6f1198da07.yml
+openapi_spec_hash: ced0e30dc67faa2414df511819408f12
 config_hash: 3279841440b02d4e8303c961d6983492

src/orb/resources/invoices.py

@@ -68,6 +68,7 @@ def create(
         currency: str,
         invoice_date: Union[str, datetime],
         line_items: Iterable[invoice_create_params.LineItem],
+        auto_collection: Optional[bool] | Omit = omit,
         customer_id: Optional[str] | Omit = omit,
         discount: Optional[Discount] | Omit = omit,
         due_date: Union[Union[str, date], Union[str, datetime], None] | Omit = omit,
@@ -94,6 +95,10 @@ def create(
           invoice_date: Optional invoice date to set. Must be in the past, if not set, `invoice_date` is
               set to the current time in the customer's timezone.
 
+          auto_collection: Determines whether this invoice will automatically attempt to charge a saved
+              payment method, if any. If not specified, the invoice inherits the customer's
+              auto_collection setting.
+
           customer_id: The id of the `Customer` to create this invoice for. One of `customer_id` and
               `external_customer_id` are required.
 
@@ -139,6 +144,7 @@ def create(
                     "currency": currency,
                     "invoice_date": invoice_date,
                     "line_items": line_items,
+                    "auto_collection": auto_collection,
                     "customer_id": customer_id,
                     "discount": discount,
                     "due_date": due_date,
@@ -164,6 +170,7 @@ def update(
         self,
         invoice_id: str,
         *,
+        auto_collection: Optional[bool] | Omit = omit,
         due_date: Union[Union[str, date], Union[str, datetime], None] | Omit = omit,
         invoice_date: Union[Union[str, date], Union[str, datetime], None] | Omit = omit,
         metadata: Optional[Dict[str, Optional[str]]] | Omit = omit,
@@ -177,15 +184,20 @@ def update(
         idempotency_key: str | None = None,
     ) -> Invoice:
         """
-        This endpoint allows you to update the `metadata`, `net_terms`, `due_date`, and
-        `invoice_date` properties on an invoice. If you pass null for the metadata
-        value, it will clear any existing metadata for that invoice.
+        This endpoint allows you to update the `metadata`, `net_terms`, `due_date`,
+        `invoice_date`, and `auto_collection` properties on an invoice. If you pass null
+        for the metadata value, it will clear any existing metadata for that invoice.
 
         `metadata` can be modified regardless of invoice state. `net_terms`, `due_date`,
-        and `invoice_date` can only be modified if the invoice is in a `draft` state.
-        `invoice_date` can only be modified for non-subscription invoices.
+        `invoice_date`, and `auto_collection` can only be modified if the invoice is in
+        a `draft` state. `invoice_date` can only be modified for non-subscription
+        invoices.
 
         Args:
+          auto_collection: Determines whether this invoice will automatically attempt to charge a saved
+              payment method, if any. Can only be modified on draft invoices. If not
+              specified, the invoice's existing setting is unchanged.
+
           due_date: An optional custom due date for the invoice. If not set, the due date will be
               calculated based on the `net_terms` value.
 
@@ -217,6 +229,7 @@ def update(
             f"/invoices/{invoice_id}",
             body=maybe_transform(
                 {
+                    "auto_collection": auto_collection,
                     "due_date": due_date,
                     "invoice_date": invoice_date,
                     "metadata": metadata,
@@ -852,6 +865,7 @@ async def create(
         currency: str,
         invoice_date: Union[str, datetime],
         line_items: Iterable[invoice_create_params.LineItem],
+        auto_collection: Optional[bool] | Omit = omit,
         customer_id: Optional[str] | Omit = omit,
         discount: Optional[Discount] | Omit = omit,
         due_date: Union[Union[str, date], Union[str, datetime], None] | Omit = omit,
@@ -878,6 +892,10 @@ async def create(
           invoice_date: Optional invoice date to set. Must be in the past, if not set, `invoice_date` is
               set to the current time in the customer's timezone.
 
+          auto_collection: Determines whether this invoice will automatically attempt to charge a saved
+              payment method, if any. If not specified, the invoice inherits the customer's
+              auto_collection setting.
+
           customer_id: The id of the `Customer` to create this invoice for. One of `customer_id` and
               `external_customer_id` are required.
 
@@ -923,6 +941,7 @@ async def create(
                     "currency": currency,
                     "invoice_date": invoice_date,
                     "line_items": line_items,
+                    "auto_collection": auto_collection,
                     "customer_id": customer_id,
                     "discount": discount,
                     "due_date": due_date,
@@ -948,6 +967,7 @@ async def update(
         self,
         invoice_id: str,
         *,
+        auto_collection: Optional[bool] | Omit = omit,
         due_date: Union[Union[str, date], Union[str, datetime], None] | Omit = omit,
         invoice_date: Union[Union[str, date], Union[str, datetime], None] | Omit = omit,
         metadata: Optional[Dict[str, Optional[str]]] | Omit = omit,
@@ -961,15 +981,20 @@ async def update(
         idempotency_key: str | None = None,
     ) -> Invoice:
         """
-        This endpoint allows you to update the `metadata`, `net_terms`, `due_date`, and
-        `invoice_date` properties on an invoice. If you pass null for the metadata
-        value, it will clear any existing metadata for that invoice.
+        This endpoint allows you to update the `metadata`, `net_terms`, `due_date`,
+        `invoice_date`, and `auto_collection` properties on an invoice. If you pass null
+        for the metadata value, it will clear any existing metadata for that invoice.
 
         `metadata` can be modified regardless of invoice state. `net_terms`, `due_date`,
-        and `invoice_date` can only be modified if the invoice is in a `draft` state.
-        `invoice_date` can only be modified for non-subscription invoices.
+        `invoice_date`, and `auto_collection` can only be modified if the invoice is in
+        a `draft` state. `invoice_date` can only be modified for non-subscription
+        invoices.
 
         Args:
+          auto_collection: Determines whether this invoice will automatically attempt to charge a saved
+              payment method, if any. Can only be modified on draft invoices. If not
+              specified, the invoice's existing setting is unchanged.
+
           due_date: An optional custom due date for the invoice. If not set, the due date will be
               calculated based on the `net_terms` value.
 
@@ -1001,6 +1026,7 @@ async def update(
             f"/invoices/{invoice_id}",
             body=await async_maybe_transform(
                 {
+                    "auto_collection": auto_collection,
                     "due_date": due_date,
                     "invoice_date": invoice_date,
                     "metadata": metadata,

src/orb/types/invoice_create_params.py

@@ -29,6 +29,13 @@ class InvoiceCreateParams(TypedDict, total=False):
 
     line_items: Required[Iterable[LineItem]]
 
+    auto_collection: Optional[bool]
+    """
+    Determines whether this invoice will automatically attempt to charge a saved
+    payment method, if any. If not specified, the invoice inherits the customer's
+    auto_collection setting.
+    """
+
     customer_id: Optional[str]
     """The id of the `Customer` to create this invoice for.
 

src/orb/types/invoice_update_params.py

@@ -12,6 +12,13 @@
 
 
 class InvoiceUpdateParams(TypedDict, total=False):
+    auto_collection: Optional[bool]
+    """
+    Determines whether this invoice will automatically attempt to charge a saved
+    payment method, if any. Can only be modified on draft invoices. If not
+    specified, the invoice's existing setting is unchanged.
+    """
+
     due_date: Annotated[Union[Union[str, date], Union[str, datetime], None], PropertyInfo(format="iso8601")]
     """An optional custom due date for the invoice.
 

tests/api_resources/test_invoices.py

@@ -62,6 +62,7 @@ def test_method_create_with_all_params(self, client: Orb) -> None:
                     },
                 }
             ],
+            auto_collection=True,
             customer_id="4khy3nwzktxv7",
             discount={
                 "discount_type": "percentage",
@@ -144,6 +145,7 @@ def test_method_update(self, client: Orb) -> None:
     def test_method_update_with_all_params(self, client: Orb) -> None:
         invoice = client.invoices.update(
             invoice_id="invoice_id",
+            auto_collection=True,
             due_date=parse_date("2023-09-22"),
             invoice_date=parse_date("2023-09-22"),
             metadata={"foo": "string"},
@@ -663,6 +665,7 @@ async def test_method_create_with_all_params(self, async_client: AsyncOrb) -> No
                     },
                 }
             ],
+            auto_collection=True,
             customer_id="4khy3nwzktxv7",
             discount={
                 "discount_type": "percentage",
@@ -745,6 +748,7 @@ async def test_method_update(self, async_client: AsyncOrb) -> None:
     async def test_method_update_with_all_params(self, async_client: AsyncOrb) -> None:
         invoice = await async_client.invoices.update(
             invoice_id="invoice_id",
+            auto_collection=True,
             due_date=parse_date("2023-09-22"),
             invoice_date=parse_date("2023-09-22"),
             metadata={"foo": "string"},