feat(api): api update (#471)

Author: stainless-app[bot]

.stats.yml

@@ -1,2 +1,2 @@
 configured_endpoints: 97
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-d0a97f690d07742fea0d6c9b9b0d9dae5e8490eb03a7f3da27989fdf53d3e45d.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-77f4e8cf0fc3b3f18c894408f322af7988ae90606235fe5058442409142a33e1.yml

src/orb/resources/customers/credits/credits.py

@@ -83,6 +83,9 @@ def list(
         """
         Returns a paginated list of unexpired, non-zero credit blocks for a customer.
 
+        If `include_all_blocks` is set to `true`, all credit blocks (including expired
+        and depleted blocks) will be included in the response.
+
         Note that `currency` defaults to credits if not specified. To use a real world
         currency, set `currency` to an ISO 4217 string.
 
@@ -92,7 +95,8 @@ def list(
           cursor: Cursor for pagination. This can be populated by the `next_cursor` value returned
               from the initial request.
 
-          include_all_blocks: Include all blocks, not just active ones.
+          include_all_blocks: If set to True, all expired and depleted blocks, as well as active block will be
+              returned.
 
           limit: The number of items to fetch. Defaults to 20.
 
@@ -145,6 +149,9 @@ def list_by_external_id(
         """
         Returns a paginated list of unexpired, non-zero credit blocks for a customer.
 
+        If `include_all_blocks` is set to `true`, all credit blocks (including expired
+        and depleted blocks) will be included in the response.
+
         Note that `currency` defaults to credits if not specified. To use a real world
         currency, set `currency` to an ISO 4217 string.
 
@@ -154,7 +161,8 @@ def list_by_external_id(
           cursor: Cursor for pagination. This can be populated by the `next_cursor` value returned
               from the initial request.
 
-          include_all_blocks: Include all blocks, not just active ones.
+          include_all_blocks: If set to True, all expired and depleted blocks, as well as active block will be
+              returned.
 
           limit: The number of items to fetch. Defaults to 20.
 
@@ -238,6 +246,9 @@ def list(
         """
         Returns a paginated list of unexpired, non-zero credit blocks for a customer.
 
+        If `include_all_blocks` is set to `true`, all credit blocks (including expired
+        and depleted blocks) will be included in the response.
+
         Note that `currency` defaults to credits if not specified. To use a real world
         currency, set `currency` to an ISO 4217 string.
 
@@ -247,7 +258,8 @@ def list(
           cursor: Cursor for pagination. This can be populated by the `next_cursor` value returned
               from the initial request.
 
-          include_all_blocks: Include all blocks, not just active ones.
+          include_all_blocks: If set to True, all expired and depleted blocks, as well as active block will be
+              returned.
 
           limit: The number of items to fetch. Defaults to 20.
 
@@ -300,6 +312,9 @@ def list_by_external_id(
         """
         Returns a paginated list of unexpired, non-zero credit blocks for a customer.
 
+        If `include_all_blocks` is set to `true`, all credit blocks (including expired
+        and depleted blocks) will be included in the response.
+
         Note that `currency` defaults to credits if not specified. To use a real world
         currency, set `currency` to an ISO 4217 string.
 
@@ -309,7 +324,8 @@ def list_by_external_id(
           cursor: Cursor for pagination. This can be populated by the `next_cursor` value returned
               from the initial request.
 
-          include_all_blocks: Include all blocks, not just active ones.
+          include_all_blocks: If set to True, all expired and depleted blocks, as well as active block will be
+              returned.
 
           limit: The number of items to fetch. Defaults to 20.
 

src/orb/types/customers/credit_list_by_external_id_params.py

@@ -20,7 +20,10 @@ class CreditListByExternalIDParams(TypedDict, total=False):
     """
 
     include_all_blocks: bool
-    """Include all blocks, not just active ones."""
+    """
+    If set to True, all expired and depleted blocks, as well as active block will be
+    returned.
+    """
 
     limit: int
     """The number of items to fetch. Defaults to 20."""

src/orb/types/customers/credit_list_params.py

@@ -20,7 +20,10 @@ class CreditListParams(TypedDict, total=False):
     """
 
     include_all_blocks: bool
-    """Include all blocks, not just active ones."""
+    """
+    If set to True, all expired and depleted blocks, as well as active block will be
+    returned.
+    """
 
     limit: int
     """The number of items to fetch. Defaults to 20."""