feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 106
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-e8dad7eee5621fe2ba948dfd00dabf170d9d92ce615a9f04b0f546f4d8bf39ba.yml
-openapi_spec_hash: 3f6a98e3a1b3a47acebd67a960090ebf
-config_hash: f6da12790e8f46d93592def474d41c69
+configured_endpoints: 113
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-c697450a215fdbd1a854d26381ce137b222726c3e6669a93afb1c0c5669906ca.yml
+openapi_spec_hash: b8b5388292baa73b5f2c686d4904ae45
+config_hash: 0e33d6c596feab76cb4df5d64f28350b

api.md

@@ -260,6 +260,7 @@ Methods:
 - <code title="post /items">client.items.<a href="./src/orb/resources/items.py">create</a>(\*\*<a href="src/orb/types/item_create_params.py">params</a>) -> <a href="./src/orb/types/item.py">Item</a></code>
 - <code title="put /items/{item_id}">client.items.<a href="./src/orb/resources/items.py">update</a>(item_id, \*\*<a href="src/orb/types/item_update_params.py">params</a>) -> <a href="./src/orb/types/item.py">Item</a></code>
 - <code title="get /items">client.items.<a href="./src/orb/resources/items.py">list</a>(\*\*<a href="src/orb/types/item_list_params.py">params</a>) -> <a href="./src/orb/types/item.py">SyncPage[Item]</a></code>
+- <code title="post /items/{item_id}/archive">client.items.<a href="./src/orb/resources/items.py">archive</a>(item_id) -> <a href="./src/orb/types/item.py">Item</a></code>
 - <code title="get /items/{item_id}">client.items.<a href="./src/orb/resources/items.py">fetch</a>(item_id) -> <a href="./src/orb/types/item.py">Item</a></code>
 
 # Metrics
@@ -291,13 +292,41 @@ Methods:
 - <code title="put /plans/{plan_id}">client.plans.<a href="./src/orb/resources/plans/plans.py">update</a>(plan_id, \*\*<a href="src/orb/types/plan_update_params.py">params</a>) -> <a href="./src/orb/types/plan.py">Plan</a></code>
 - <code title="get /plans">client.plans.<a href="./src/orb/resources/plans/plans.py">list</a>(\*\*<a href="src/orb/types/plan_list_params.py">params</a>) -> <a href="./src/orb/types/plan.py">SyncPage[Plan]</a></code>
 - <code title="get /plans/{plan_id}">client.plans.<a href="./src/orb/resources/plans/plans.py">fetch</a>(plan_id) -> <a href="./src/orb/types/plan.py">Plan</a></code>
+- <code title="post /plans/{plan_id}/set_default_version">client.plans.<a href="./src/orb/resources/plans/plans.py">set_default_version</a>(plan_id, \*\*<a href="src/orb/types/plan_set_default_version_params.py">params</a>) -> <a href="./src/orb/types/plan.py">Plan</a></code>
 
 ## ExternalPlanID
 
 Methods:
 
-- <code title="put /plans/external_plan_id/{external_plan_id}">client.plans.external_plan_id.<a href="./src/orb/resources/plans/external_plan_id.py">update</a>(other_external_plan_id, \*\*<a href="src/orb/types/plans/external_plan_id_update_params.py">params</a>) -> <a href="./src/orb/types/plan.py">Plan</a></code>
-- <code title="get /plans/external_plan_id/{external_plan_id}">client.plans.external_plan_id.<a href="./src/orb/resources/plans/external_plan_id.py">fetch</a>(external_plan_id) -> <a href="./src/orb/types/plan.py">Plan</a></code>
+- <code title="put /plans/external_plan_id/{external_plan_id}">client.plans.external_plan_id.<a href="./src/orb/resources/plans/external_plan_id/external_plan_id.py">update</a>(other_external_plan_id, \*\*<a href="src/orb/types/plans/external_plan_id_update_params.py">params</a>) -> <a href="./src/orb/types/plan.py">Plan</a></code>
+- <code title="get /plans/external_plan_id/{external_plan_id}">client.plans.external_plan_id.<a href="./src/orb/resources/plans/external_plan_id/external_plan_id.py">fetch</a>(external_plan_id) -> <a href="./src/orb/types/plan.py">Plan</a></code>
+- <code title="post /plans/external_plan_id/{external_plan_id}/set_default_version">client.plans.external_plan_id.<a href="./src/orb/resources/plans/external_plan_id/external_plan_id.py">set_default_version</a>(external_plan_id, \*\*<a href="src/orb/types/plans/external_plan_id_set_default_version_params.py">params</a>) -> <a href="./src/orb/types/plan.py">Plan</a></code>
+
+### Versions
+
+Types:
+
+```python
+from orb.types.plans.external_plan_id import VersionCreateResponse, VersionRetrieveResponse
+```
+
+Methods:
+
+- <code title="post /plans/external_plan_id/{external_plan_id}/versions">client.plans.external_plan_id.versions.<a href="./src/orb/resources/plans/external_plan_id/versions.py">create</a>(external_plan_id, \*\*<a href="src/orb/types/plans/external_plan_id/version_create_params.py">params</a>) -> <a href="./src/orb/types/plans/external_plan_id/version_create_response.py">VersionCreateResponse</a></code>
+- <code title="get /plans/external_plan_id/{external_plan_id}/versions/{version}">client.plans.external_plan_id.versions.<a href="./src/orb/resources/plans/external_plan_id/versions.py">retrieve</a>(version, \*, external_plan_id) -> <a href="./src/orb/types/plans/external_plan_id/version_retrieve_response.py">VersionRetrieveResponse</a></code>
+
+## Versions
+
+Types:
+
+```python
+from orb.types.plans import VersionCreateResponse, VersionRetrieveResponse
+```
+
+Methods:
+
+- <code title="post /plans/{plan_id}/versions">client.plans.versions.<a href="./src/orb/resources/plans/versions.py">create</a>(plan_id, \*\*<a href="src/orb/types/plans/version_create_params.py">params</a>) -> <a href="./src/orb/types/plans/version_create_response.py">VersionCreateResponse</a></code>
+- <code title="get /plans/{plan_id}/versions/{version}">client.plans.versions.<a href="./src/orb/resources/plans/versions.py">retrieve</a>(version, \*, plan_id) -> <a href="./src/orb/types/plans/version_retrieve_response.py">VersionRetrieveResponse</a></code>
 
 # Prices
 
@@ -312,7 +341,7 @@ Methods:
 - <code title="post /prices">client.prices.<a href="./src/orb/resources/prices/prices.py">create</a>(\*\*<a href="src/orb/types/price_create_params.py">params</a>) -> <a href="./src/orb/types/price.py">Price</a></code>
 - <code title="put /prices/{price_id}">client.prices.<a href="./src/orb/resources/prices/prices.py">update</a>(price_id, \*\*<a href="src/orb/types/price_update_params.py">params</a>) -> <a href="./src/orb/types/price.py">Price</a></code>
 - <code title="get /prices">client.prices.<a href="./src/orb/resources/prices/prices.py">list</a>(\*\*<a href="src/orb/types/price_list_params.py">params</a>) -> <a href="./src/orb/types/price.py">SyncPage[Price]</a></code>
-- <code title="post /prices/{price_id}/evaluate">client.prices.<a href="./src/orb/resources/prices/prices.py">evaluate</a>(price_id, \*\*<a href="src/orb/types/price_evaluate_params.py">params</a>) -> <a href="./src/orb/types/price_evaluate_response.py">PriceEvaluateResponse</a></code>
+- <code title="post /prices/evaluate">client.prices.<a href="./src/orb/resources/prices/prices.py">evaluate</a>(\*\*<a href="src/orb/types/price_evaluate_params.py">params</a>) -> <a href="./src/orb/types/price_evaluate_response.py">PriceEvaluateResponse</a></code>
 - <code title="get /prices/{price_id}">client.prices.<a href="./src/orb/resources/prices/prices.py">fetch</a>(price_id) -> <a href="./src/orb/types/price.py">Price</a></code>
 
 ## ExternalPriceID

src/orb/resources/credit_notes.py

@@ -46,9 +46,8 @@ def create(
         self,
         *,
         line_items: Iterable[credit_note_create_params.LineItem],
+        reason: Literal["duplicate", "fraudulent", "order_change", "product_unsatisfactory"],
         memo: Optional[str] | NotGiven = NOT_GIVEN,
-        reason: Optional[Literal["duplicate", "fraudulent", "order_change", "product_unsatisfactory"]]
-        | 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,
@@ -62,10 +61,10 @@ def create(
         [`Credit Note`](/invoicing/credit-notes).
 
         Args:
-          memo: An optional memo to attach to the credit note.
-
           reason: An optional reason for the credit note.
 
+          memo: An optional memo to attach to the credit note.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -81,8 +80,8 @@ def create(
             body=maybe_transform(
                 {
                     "line_items": line_items,
-                    "memo": memo,
                     "reason": reason,
+                    "memo": memo,
                 },
                 credit_note_create_params.CreditNoteCreateParams,
             ),
@@ -214,9 +213,8 @@ async def create(
         self,
         *,
         line_items: Iterable[credit_note_create_params.LineItem],
+        reason: Literal["duplicate", "fraudulent", "order_change", "product_unsatisfactory"],
         memo: Optional[str] | NotGiven = NOT_GIVEN,
-        reason: Optional[Literal["duplicate", "fraudulent", "order_change", "product_unsatisfactory"]]
-        | 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,
@@ -230,10 +228,10 @@ async def create(
         [`Credit Note`](/invoicing/credit-notes).
 
         Args:
-          memo: An optional memo to attach to the credit note.
-
           reason: An optional reason for the credit note.
 
+          memo: An optional memo to attach to the credit note.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -249,8 +247,8 @@ async def create(
             body=await async_maybe_transform(
                 {
                     "line_items": line_items,
-                    "memo": memo,
                     "reason": reason,
+                    "memo": memo,
                 },
                 credit_note_create_params.CreditNoteCreateParams,
             ),

src/orb/resources/customers/balance_transactions.py

@@ -137,13 +137,6 @@ def list(
         chronological order for a single customer, providing a complete audit trail of
         all adjustments and invoice applications.
 
-        ## Eligibility
-
-        The customer balance can only be applied to invoices or adjusted manually if
-        invoices are not synced to a separate invoicing provider. If a payment gateway
-        such as Stripe is used, the balance will be applied to the invoice before
-        forwarding payment to the gateway.
-
         Args:
           cursor: Cursor for pagination. This can be populated by the `next_cursor` value returned
               from the initial request.
@@ -298,13 +291,6 @@ def list(
         chronological order for a single customer, providing a complete audit trail of
         all adjustments and invoice applications.
 
-        ## Eligibility
-
-        The customer balance can only be applied to invoices or adjusted manually if
-        invoices are not synced to a separate invoicing provider. If a payment gateway
-        such as Stripe is used, the balance will be applied to the invoice before
-        forwarding payment to the gateway.
-
         Args:
           cursor: Cursor for pagination. This can be populated by the `next_cursor` value returned
               from the initial request.

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

@@ -93,7 +93,7 @@ def create(
               threshold, the top-up will be triggered.
 
           active_from: The date from which the top-up is active. If unspecified, the top-up is active
-              immediately.
+              immediately. This should not be more than 10 days in the past.
 
           expires_after: The number of days or months after which the top-up expires. If unspecified, it
               does not expire.
@@ -277,7 +277,7 @@ def create_by_external_id(
               threshold, the top-up will be triggered.
 
           active_from: The date from which the top-up is active. If unspecified, the top-up is active
-              immediately.
+              immediately. This should not be more than 10 days in the past.
 
           expires_after: The number of days or months after which the top-up expires. If unspecified, it
               does not expire.
@@ -488,7 +488,7 @@ async def create(
               threshold, the top-up will be triggered.
 
           active_from: The date from which the top-up is active. If unspecified, the top-up is active
-              immediately.
+              immediately. This should not be more than 10 days in the past.
 
           expires_after: The number of days or months after which the top-up expires. If unspecified, it
               does not expire.
@@ -672,7 +672,7 @@ async def create_by_external_id(
               threshold, the top-up will be triggered.
 
           active_from: The date from which the top-up is active. If unspecified, the top-up is active
-              immediately.
+              immediately. This should not be more than 10 days in the past.
 
           expires_after: The number of days or months after which the top-up expires. If unspecified, it
               does not expire.

src/orb/resources/customers/customers.py

@@ -628,10 +628,7 @@ def delete(
         **Note**: This operation happens asynchronously and can be expected to take a
         few minutes to propagate to related resources. However, querying for the
         customer on subsequent GET requests while deletion is in process will reflect
-        its deletion with a `deleted: true` property. Once the customer deletion has
-        been fully processed, the customer will not be returned in the API.
-
-        On successful processing, this returns an empty dictionary (`{}`) in the API.
+        its deletion.
 
         Args:
           extra_headers: Send extra headers
@@ -1634,10 +1631,7 @@ async def delete(
         **Note**: This operation happens asynchronously and can be expected to take a
         few minutes to propagate to related resources. However, querying for the
         customer on subsequent GET requests while deletion is in process will reflect
-        its deletion with a `deleted: true` property. Once the customer deletion has
-        been fully processed, the customer will not be returned in the API.
-
-        On successful processing, this returns an empty dictionary (`{}`) in the API.
+        its deletion.
 
         Args:
           extra_headers: Send extra headers

src/orb/resources/dimensional_price_groups/dimensional_price_groups.py

@@ -76,7 +76,7 @@ def create(
         For example, suppose we have a billable metric that measures the number of
         widgets used and we want to charge differently depending on the color of the
         widget. We can create a price group with a dimension "color" and two prices: one
-        that charges $10 per red widget and one that charges $20 per blue widget.
+        that charges \\$$10 per red widget and one that charges \\$$20 per blue widget.
 
         Args:
           dimensions: The set of keys (in order) used to disambiguate prices in the group.
@@ -250,7 +250,7 @@ async def create(
         For example, suppose we have a billable metric that measures the number of
         widgets used and we want to charge differently depending on the color of the
         widget. We can create a price group with a dimension "color" and two prices: one
-        that charges $10 per red widget and one that charges $20 per blue widget.
+        that charges \\$$10 per red widget and one that charges \\$$20 per blue widget.
 
         Args:
           dimensions: The set of keys (in order) used to disambiguate prices in the group.