feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 115
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-028b94908fa562ed9c31c1137078f958f859e79b33b8fddbd64934e1bb4ffd32.yml
-openapi_spec_hash: e9a8403fd1da4edf627451a88ba27a55
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-baf431485e9392b6fbff7c2f4d53d0dc3d1e49e2bec417501c924231c95dc09d.yml
+openapi_spec_hash: f80f4798ac7266ef21a9c069ccfef259
 config_hash: 1e2186b09e57d7d27b6ab5c8e6410b31

src/orb/resources/subscriptions.py

@@ -1368,9 +1368,10 @@ def redeem_coupon(
         subscription_id: str,
         *,
         change_option: Literal["requested_date", "end_of_subscription_term", "immediate"],
-        coupon_id: str,
         allow_invoice_credit_or_void: Optional[bool] | NotGiven = NOT_GIVEN,
         change_date: Union[str, datetime, None] | NotGiven = NOT_GIVEN,
+        coupon_id: Optional[str] | NotGiven = NOT_GIVEN,
+        coupon_redemption_code: Optional[str] | 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,
@@ -1383,15 +1384,17 @@ def redeem_coupon(
         Redeem a coupon effective at a given time.
 
         Args:
-          coupon_id: Coupon ID to be redeemed for this subscription.
-
           allow_invoice_credit_or_void: If false, this request will fail if it would void an issued invoice or create a
               credit note. Consider using this as a safety mechanism if you do not expect
               existing invoices to be changed.
 
           change_date: The date that the coupon discount should take effect. This parameter can only be
               passed if the `change_option` is `requested_date`.
 
+          coupon_id: Coupon ID to be redeemed for this subscription.
+
+          coupon_redemption_code: Redemption code of the coupon to be redeemed for this subscription.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -1409,9 +1412,10 @@ def redeem_coupon(
             body=maybe_transform(
                 {
                     "change_option": change_option,
-                    "coupon_id": coupon_id,
                     "allow_invoice_credit_or_void": allow_invoice_credit_or_void,
                     "change_date": change_date,
+                    "coupon_id": coupon_id,
+                    "coupon_redemption_code": coupon_redemption_code,
                 },
                 subscription_redeem_coupon_params.SubscriptionRedeemCouponParams,
             ),
@@ -3454,9 +3458,10 @@ async def redeem_coupon(
         subscription_id: str,
         *,
         change_option: Literal["requested_date", "end_of_subscription_term", "immediate"],
-        coupon_id: str,
         allow_invoice_credit_or_void: Optional[bool] | NotGiven = NOT_GIVEN,
         change_date: Union[str, datetime, None] | NotGiven = NOT_GIVEN,
+        coupon_id: Optional[str] | NotGiven = NOT_GIVEN,
+        coupon_redemption_code: Optional[str] | 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,
@@ -3469,15 +3474,17 @@ async def redeem_coupon(
         Redeem a coupon effective at a given time.
 
         Args:
-          coupon_id: Coupon ID to be redeemed for this subscription.
-
           allow_invoice_credit_or_void: If false, this request will fail if it would void an issued invoice or create a
               credit note. Consider using this as a safety mechanism if you do not expect
               existing invoices to be changed.
 
           change_date: The date that the coupon discount should take effect. This parameter can only be
               passed if the `change_option` is `requested_date`.
 
+          coupon_id: Coupon ID to be redeemed for this subscription.
+
+          coupon_redemption_code: Redemption code of the coupon to be redeemed for this subscription.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -3495,9 +3502,10 @@ async def redeem_coupon(
             body=await async_maybe_transform(
                 {
                     "change_option": change_option,
-                    "coupon_id": coupon_id,
                     "allow_invoice_credit_or_void": allow_invoice_credit_or_void,
                     "change_date": change_date,
+                    "coupon_id": coupon_id,
+                    "coupon_redemption_code": coupon_redemption_code,
                 },
                 subscription_redeem_coupon_params.SubscriptionRedeemCouponParams,
             ),

src/orb/types/subscription_redeem_coupon_params.py

@@ -14,9 +14,6 @@
 class SubscriptionRedeemCouponParams(TypedDict, total=False):
     change_option: Required[Literal["requested_date", "end_of_subscription_term", "immediate"]]
 
-    coupon_id: Required[str]
-    """Coupon ID to be redeemed for this subscription."""
-
     allow_invoice_credit_or_void: Optional[bool]
     """
     If false, this request will fail if it would void an issued invoice or create a
@@ -29,3 +26,9 @@ class SubscriptionRedeemCouponParams(TypedDict, total=False):
 
     This parameter can only be passed if the `change_option` is `requested_date`.
     """
+
+    coupon_id: Optional[str]
+    """Coupon ID to be redeemed for this subscription."""
+
+    coupon_redemption_code: Optional[str]
+    """Redemption code of the coupon to be redeemed for this subscription."""

tests/api_resources/test_subscriptions.py

@@ -736,7 +736,6 @@ def test_method_redeem_coupon(self, client: Orb) -> None:
         subscription = client.subscriptions.redeem_coupon(
             subscription_id="subscription_id",
             change_option="requested_date",
-            coupon_id="coupon_id",
         )
         assert_matches_type(SubscriptionRedeemCouponResponse, subscription, path=["response"])
 
@@ -745,9 +744,10 @@ def test_method_redeem_coupon_with_all_params(self, client: Orb) -> None:
         subscription = client.subscriptions.redeem_coupon(
             subscription_id="subscription_id",
             change_option="requested_date",
-            coupon_id="coupon_id",
             allow_invoice_credit_or_void=True,
             change_date=parse_datetime("2017-07-21T17:32:28Z"),
+            coupon_id="coupon_id",
+            coupon_redemption_code="coupon_redemption_code",
         )
         assert_matches_type(SubscriptionRedeemCouponResponse, subscription, path=["response"])
 
@@ -756,7 +756,6 @@ def test_raw_response_redeem_coupon(self, client: Orb) -> None:
         response = client.subscriptions.with_raw_response.redeem_coupon(
             subscription_id="subscription_id",
             change_option="requested_date",
-            coupon_id="coupon_id",
         )
 
         assert response.is_closed is True
@@ -769,7 +768,6 @@ def test_streaming_response_redeem_coupon(self, client: Orb) -> None:
         with client.subscriptions.with_streaming_response.redeem_coupon(
             subscription_id="subscription_id",
             change_option="requested_date",
-            coupon_id="coupon_id",
         ) as response:
             assert not response.is_closed
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
@@ -785,7 +783,6 @@ def test_path_params_redeem_coupon(self, client: Orb) -> None:
             client.subscriptions.with_raw_response.redeem_coupon(
                 subscription_id="",
                 change_option="requested_date",
-                coupon_id="coupon_id",
             )
 
     @parametrize
@@ -1986,7 +1983,6 @@ async def test_method_redeem_coupon(self, async_client: AsyncOrb) -> None:
         subscription = await async_client.subscriptions.redeem_coupon(
             subscription_id="subscription_id",
             change_option="requested_date",
-            coupon_id="coupon_id",
         )
         assert_matches_type(SubscriptionRedeemCouponResponse, subscription, path=["response"])
 
@@ -1995,9 +1991,10 @@ async def test_method_redeem_coupon_with_all_params(self, async_client: AsyncOrb
         subscription = await async_client.subscriptions.redeem_coupon(
             subscription_id="subscription_id",
             change_option="requested_date",
-            coupon_id="coupon_id",
             allow_invoice_credit_or_void=True,
             change_date=parse_datetime("2017-07-21T17:32:28Z"),
+            coupon_id="coupon_id",
+            coupon_redemption_code="coupon_redemption_code",
         )
         assert_matches_type(SubscriptionRedeemCouponResponse, subscription, path=["response"])
 
@@ -2006,7 +2003,6 @@ async def test_raw_response_redeem_coupon(self, async_client: AsyncOrb) -> None:
         response = await async_client.subscriptions.with_raw_response.redeem_coupon(
             subscription_id="subscription_id",
             change_option="requested_date",
-            coupon_id="coupon_id",
         )
 
         assert response.is_closed is True
@@ -2019,7 +2015,6 @@ async def test_streaming_response_redeem_coupon(self, async_client: AsyncOrb) ->
         async with async_client.subscriptions.with_streaming_response.redeem_coupon(
             subscription_id="subscription_id",
             change_option="requested_date",
-            coupon_id="coupon_id",
         ) as response:
             assert not response.is_closed
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
@@ -2035,7 +2030,6 @@ async def test_path_params_redeem_coupon(self, async_client: AsyncOrb) -> None:
             await async_client.subscriptions.with_raw_response.redeem_coupon(
                 subscription_id="",
                 change_option="requested_date",
-                coupon_id="coupon_id",
             )
 
     @parametrize