feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 116
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-e79a36262fa3c577305a43717398fb70482bb2dca47cdb3e201cbb2a590c359c.yml
-openapi_spec_hash: 1e04880dccbcc082ba451083e421a471
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-612316c13276a207f56e2e2c7bbc68f4bb73de85e3661595a23f23d9ccc80276.yml
+openapi_spec_hash: 6e125f05e40521ec485edf6e15beec2e
 config_hash: 3c3524be9607afb24d2139ce26ce5389

src/orb/resources/credit_notes.py

@@ -90,17 +90,17 @@ def create(
         Args:
           reason: An optional reason for the credit note.
 
-          end_date: An optional date string to specify the global credit note service period end
-              date in the customer's timezone. This will be applied to all line items. If not
-              provided, line items will use their original invoice line item service periods.
-              This date is inclusive.
+          end_date: A date string to specify the global credit note service period end date in the
+              customer's timezone. This will be applied to all line items that don't have
+              their own individual service periods specified. If not provided, line items will
+              use their original invoice line item service periods. This date is inclusive.
 
           memo: An optional memo to attach to the credit note.
 
-          start_date: An optional date string to specify the global credit note service period end
-              date in the customer's timezone. This will be applied to all line items. If not
-              provided, line items will use their original invoice line item service periods.
-              This date is inclusive.
+          start_date: A date string to specify the global credit note service period start date in the
+              customer's timezone. This will be applied to all line items that don't have
+              their own individual service periods specified. If not provided, line items will
+              use their original invoice line item service periods. This date is inclusive.
 
           extra_headers: Send extra headers
 
@@ -296,17 +296,17 @@ async def create(
         Args:
           reason: An optional reason for the credit note.
 
-          end_date: An optional date string to specify the global credit note service period end
-              date in the customer's timezone. This will be applied to all line items. If not
-              provided, line items will use their original invoice line item service periods.
-              This date is inclusive.
+          end_date: A date string to specify the global credit note service period end date in the
+              customer's timezone. This will be applied to all line items that don't have
+              their own individual service periods specified. If not provided, line items will
+              use their original invoice line item service periods. This date is inclusive.
 
           memo: An optional memo to attach to the credit note.
 
-          start_date: An optional date string to specify the global credit note service period end
-              date in the customer's timezone. This will be applied to all line items. If not
-              provided, line items will use their original invoice line item service periods.
-              This date is inclusive.
+          start_date: A date string to specify the global credit note service period start date in the
+              customer's timezone. This will be applied to all line items that don't have
+              their own individual service periods specified. If not provided, line items will
+              use their original invoice line item service periods. This date is inclusive.
 
           extra_headers: Send extra headers
 

src/orb/types/credit_note_create_params.py

@@ -19,21 +19,21 @@ class CreditNoteCreateParams(TypedDict, total=False):
 
     end_date: Annotated[Union[str, date, None], PropertyInfo(format="iso8601")]
     """
-    An optional date string to specify the global credit note service period end
-    date in the customer's timezone. This will be applied to all line items. If not
-    provided, line items will use their original invoice line item service periods.
-    This date is inclusive.
+    A date string to specify the global credit note service period end date in the
+    customer's timezone. This will be applied to all line items that don't have
+    their own individual service periods specified. If not provided, line items will
+    use their original invoice line item service periods. This date is inclusive.
     """
 
     memo: Optional[str]
     """An optional memo to attach to the credit note."""
 
     start_date: Annotated[Union[str, date, None], PropertyInfo(format="iso8601")]
     """
-    An optional date string to specify the global credit note service period end
-    date in the customer's timezone. This will be applied to all line items. If not
-    provided, line items will use their original invoice line item service periods.
-    This date is inclusive.
+    A date string to specify the global credit note service period start date in the
+    customer's timezone. This will be applied to all line items that don't have
+    their own individual service periods specified. If not provided, line items will
+    use their original invoice line item service periods. This date is inclusive.
     """
 
 
@@ -46,18 +46,17 @@ class LineItem(TypedDict, total=False):
 
     end_date: Annotated[Union[str, date, None], PropertyInfo(format="iso8601")]
     """
-    An optional date string to specify this line item's credit note service period
-    end date in the customer's timezone. If provided, this will be used for this
-    specific line item. If not provided, will use the global end_date if available,
-    otherwise defaults to the original invoice line item's end date. This date is
-    inclusive.
+    A date string to specify this line item's credit note service period end date in
+    the customer's timezone. If provided, this will be used for this specific line
+    item. If not provided, will use the global end_date if available, otherwise
+    defaults to the original invoice line item's end date. This date is inclusive.
     """
 
     start_date: Annotated[Union[str, date, None], PropertyInfo(format="iso8601")]
     """
-    An optional date string to specify this line item's credit note service period
-    start date in the customer's timezone. If provided, this will be used for this
-    specific line item. If not provided, will use the global start_date if
-    available, otherwise defaults to the original invoice line item's start date.
-    This date is inclusive.
+    A date string to specify this line item's credit note service period start date
+    in the customer's timezone. If provided, this will be used for this specific
+    line item. If not provided, will use the global start_date if available,
+    otherwise defaults to the original invoice line item's start date. This date is
+    inclusive.
     """

tests/api_resources/test_credit_notes.py

@@ -39,14 +39,14 @@ def test_method_create_with_all_params(self, client: Orb) -> None:
                 {
                     "amount": "amount",
                     "invoice_line_item_id": "4khy3nwzktxv7",
-                    "end_date": parse_date("2023-01-31"),
-                    "start_date": parse_date("2023-01-01"),
+                    "end_date": parse_date("2023-09-22"),
+                    "start_date": parse_date("2023-09-22"),
                 }
             ],
             reason="duplicate",
-            end_date=parse_date("2023-01-31"),
+            end_date=parse_date("2023-09-22"),
             memo="An optional memo for my credit note.",
-            start_date=parse_date("2023-01-01"),
+            start_date=parse_date("2023-09-22"),
         )
         assert_matches_type(CreditNote, credit_note, path=["response"])
 
@@ -187,14 +187,14 @@ async def test_method_create_with_all_params(self, async_client: AsyncOrb) -> No
                 {
                     "amount": "amount",
                     "invoice_line_item_id": "4khy3nwzktxv7",
-                    "end_date": parse_date("2023-01-31"),
-                    "start_date": parse_date("2023-01-01"),
+                    "end_date": parse_date("2023-09-22"),
+                    "start_date": parse_date("2023-09-22"),
                 }
             ],
             reason="duplicate",
-            end_date=parse_date("2023-01-31"),
+            end_date=parse_date("2023-09-22"),
             memo="An optional memo for my credit note.",
-            start_date=parse_date("2023-01-01"),
+            start_date=parse_date("2023-09-22"),
         )
         assert_matches_type(CreditNote, credit_note, path=["response"])