feat(api): api update (#496)

Author: stainless-app[bot]

.stats.yml

@@ -1,2 +1,2 @@
 configured_endpoints: 101
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-11f40c15fa889d9752019e8a35b82d2e7a3d42f2b42c850b469f120a5b2c47ba.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-e480186cdd0e2cc631befa7e2c6ba5f2d7ae52052f0e79a748214f3ade8a98ee.yml

src/orb/resources/alerts.py

@@ -162,7 +162,7 @@ def list(
 
         The list of alerts is ordered starting from the most recently created alert.
         This endpoint follows Orb's
-        [standardized pagination format](../reference/pagination).
+        [standardized pagination format](/api-reference/pagination).
 
         Args:
           cursor: Cursor for pagination. This can be populated by the `next_cursor` value returned
@@ -237,8 +237,7 @@ def create_for_customer(
         are three types of alerts that can be scoped to customers:
         `credit_balance_depleted`, `credit_balance_dropped`, and
         `credit_balance_recovered`. Customers can have a maximum of one of each type of
-        alert per
-        [credit balance currency](https://docs.withorb.com/guides/product-catalog/prepurchase).
+        alert per [credit balance currency](/product-catalog/prepurchase).
         `credit_balance_dropped` alerts require a list of thresholds to be provided
         while `credit_balance_depleted` and `credit_balance_recovered` alerts do not
         require thresholds.
@@ -309,8 +308,7 @@ def create_for_external_customer(
         are three types of alerts that can be scoped to customers:
         `credit_balance_depleted`, `credit_balance_dropped`, and
         `credit_balance_recovered`. Customers can have a maximum of one of each type of
-        alert per
-        [credit balance currency](https://docs.withorb.com/guides/product-catalog/prepurchase).
+        alert per [credit balance currency](/product-catalog/prepurchase).
         `credit_balance_dropped` alerts require a list of thresholds to be provided
         while `credit_balance_depleted` and `credit_balance_recovered` alerts do not
         require thresholds.
@@ -657,7 +655,7 @@ def list(
 
         The list of alerts is ordered starting from the most recently created alert.
         This endpoint follows Orb's
-        [standardized pagination format](../reference/pagination).
+        [standardized pagination format](/api-reference/pagination).
 
         Args:
           cursor: Cursor for pagination. This can be populated by the `next_cursor` value returned
@@ -732,8 +730,7 @@ async def create_for_customer(
         are three types of alerts that can be scoped to customers:
         `credit_balance_depleted`, `credit_balance_dropped`, and
         `credit_balance_recovered`. Customers can have a maximum of one of each type of
-        alert per
-        [credit balance currency](https://docs.withorb.com/guides/product-catalog/prepurchase).
+        alert per [credit balance currency](/product-catalog/prepurchase).
         `credit_balance_dropped` alerts require a list of thresholds to be provided
         while `credit_balance_depleted` and `credit_balance_recovered` alerts do not
         require thresholds.
@@ -804,8 +801,7 @@ async def create_for_external_customer(
         are three types of alerts that can be scoped to customers:
         `credit_balance_depleted`, `credit_balance_dropped`, and
         `credit_balance_recovered`. Customers can have a maximum of one of each type of
-        alert per
-        [credit balance currency](https://docs.withorb.com/guides/product-catalog/prepurchase).
+        alert per [credit balance currency](/product-catalog/prepurchase).
         `credit_balance_dropped` alerts require a list of thresholds to be provided
         while `credit_balance_depleted` and `credit_balance_recovered` alerts do not
         require thresholds.

src/orb/resources/coupons/subscriptions.py

@@ -55,9 +55,9 @@ def list(
     ) -> SyncPage[Subscription]:
         """
         This endpoint returns a list of all subscriptions that have redeemed a given
-        coupon as a [paginated](../reference/pagination) list, ordered starting from the
-        most recently created subscription. For a full discussion of the subscription
-        resource, see [Subscription](../guides/concepts#subscription).
+        coupon as a [paginated](/api-reference/pagination) list, ordered starting from
+        the most recently created subscription. For a full discussion of the
+        subscription resource, see [Subscription](/core-concepts#subscription).
 
         Args:
           cursor: Cursor for pagination. This can be populated by the `next_cursor` value returned
@@ -130,9 +130,9 @@ def list(
     ) -> AsyncPaginator[Subscription, AsyncPage[Subscription]]:
         """
         This endpoint returns a list of all subscriptions that have redeemed a given
-        coupon as a [paginated](../reference/pagination) list, ordered starting from the
-        most recently created subscription. For a full discussion of the subscription
-        resource, see [Subscription](../guides/concepts#subscription).
+        coupon as a [paginated](/api-reference/pagination) list, ordered starting from
+        the most recently created subscription. For a full discussion of the
+        subscription resource, see [Subscription](/core-concepts#subscription).
 
         Args:
           cursor: Cursor for pagination. This can be populated by the `next_cursor` value returned

src/orb/resources/credit_notes.py

@@ -61,7 +61,7 @@ def create(
     ) -> CreditNote:
         """
         This endpoint is used to create a single
-        [`Credit Note`](../guides/invoicing/credit-notes).
+        [`Credit Note`](/invoicing/credit-notes).
 
         Args:
           memo: An optional memo to attach to the credit note.
@@ -161,8 +161,8 @@ def fetch(
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> CreditNote:
         """
-        This endpoint is used to fetch a single
-        [`Credit Note`](../guides/invoicing/credit-notes) given an identifier.
+        This endpoint is used to fetch a single [`Credit Note`](/invoicing/credit-notes)
+        given an identifier.
 
         Args:
           extra_headers: Send extra headers
@@ -221,7 +221,7 @@ async def create(
     ) -> CreditNote:
         """
         This endpoint is used to create a single
-        [`Credit Note`](../guides/invoicing/credit-notes).
+        [`Credit Note`](/invoicing/credit-notes).
 
         Args:
           memo: An optional memo to attach to the credit note.
@@ -321,8 +321,8 @@ async def fetch(
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> CreditNote:
         """
-        This endpoint is used to fetch a single
-        [`Credit Note`](../guides/invoicing/credit-notes) given an identifier.
+        This endpoint is used to fetch a single [`Credit Note`](/invoicing/credit-notes)
+        given an identifier.
 
         Args:
           extra_headers: Send extra headers

src/orb/resources/customers/costs.py

@@ -63,8 +63,8 @@ def list(
         """
         This endpoint is used to fetch a day-by-day snapshot of a customer's costs in
         Orb, calculated by applying pricing information to the underlying usage (see the
-        [subscription usage endpoint](fetch-subscription-usage.api.mdx) to fetch usage
-        per metric, in usage units rather than a currency).
+        [subscription usage endpoint](/api-reference/subscription/fetch-subscription-usage)
+        to fetch usage per metric, in usage units rather than a currency).
 
         This endpoint can be leveraged for internal tooling and to provide a more
         transparent billing experience for your end users:
@@ -73,8 +73,8 @@ def list(
            the current billing period.
         2. Provide customer visibility into how different services are contributing to
            the overall invoice with a per-day timeseries (as compared to the
-           [upcoming invoice](fetch-upcoming-invoice) resource, which represents a
-           snapshot for the current period).
+           [upcoming invoice](/api-reference/invoice/fetch-upcoming-invoice) resource,
+           which represents a snapshot for the current period).
         3. Assess how minimums and discounts affect your customers by teasing apart
            costs directly as a result of usage, as opposed to minimums and discounts at
            the plan and price level.
@@ -239,8 +239,8 @@ def list_by_external_id(
         """
         This endpoint is used to fetch a day-by-day snapshot of a customer's costs in
         Orb, calculated by applying pricing information to the underlying usage (see the
-        [subscription usage endpoint](fetch-subscription-usage.api.mdx) to fetch usage
-        per metric, in usage units rather than a currency).
+        [subscription usage endpoint](/api-reference/subscription/fetch-subscription-usage)
+        to fetch usage per metric, in usage units rather than a currency).
 
         This endpoint can be leveraged for internal tooling and to provide a more
         transparent billing experience for your end users:
@@ -249,8 +249,8 @@ def list_by_external_id(
            the current billing period.
         2. Provide customer visibility into how different services are contributing to
            the overall invoice with a per-day timeseries (as compared to the
-           [upcoming invoice](fetch-upcoming-invoice) resource, which represents a
-           snapshot for the current period).
+           [upcoming invoice](/api-reference/invoice/fetch-upcoming-invoice) resource,
+           which represents a snapshot for the current period).
         3. Assess how minimums and discounts affect your customers by teasing apart
            costs directly as a result of usage, as opposed to minimums and discounts at
            the plan and price level.
@@ -438,8 +438,8 @@ async def list(
         """
         This endpoint is used to fetch a day-by-day snapshot of a customer's costs in
         Orb, calculated by applying pricing information to the underlying usage (see the
-        [subscription usage endpoint](fetch-subscription-usage.api.mdx) to fetch usage
-        per metric, in usage units rather than a currency).
+        [subscription usage endpoint](/api-reference/subscription/fetch-subscription-usage)
+        to fetch usage per metric, in usage units rather than a currency).
 
         This endpoint can be leveraged for internal tooling and to provide a more
         transparent billing experience for your end users:
@@ -448,8 +448,8 @@ async def list(
            the current billing period.
         2. Provide customer visibility into how different services are contributing to
            the overall invoice with a per-day timeseries (as compared to the
-           [upcoming invoice](fetch-upcoming-invoice) resource, which represents a
-           snapshot for the current period).
+           [upcoming invoice](/api-reference/invoice/fetch-upcoming-invoice) resource,
+           which represents a snapshot for the current period).
         3. Assess how minimums and discounts affect your customers by teasing apart
            costs directly as a result of usage, as opposed to minimums and discounts at
            the plan and price level.
@@ -614,8 +614,8 @@ async def list_by_external_id(
         """
         This endpoint is used to fetch a day-by-day snapshot of a customer's costs in
         Orb, calculated by applying pricing information to the underlying usage (see the
-        [subscription usage endpoint](fetch-subscription-usage.api.mdx) to fetch usage
-        per metric, in usage units rather than a currency).
+        [subscription usage endpoint](/api-reference/subscription/fetch-subscription-usage)
+        to fetch usage per metric, in usage units rather than a currency).
 
         This endpoint can be leveraged for internal tooling and to provide a more
         transparent billing experience for your end users:
@@ -624,8 +624,8 @@ async def list_by_external_id(
            the current billing period.
         2. Provide customer visibility into how different services are contributing to
            the overall invoice with a per-day timeseries (as compared to the
-           [upcoming invoice](fetch-upcoming-invoice) resource, which represents a
-           snapshot for the current period).
+           [upcoming invoice](/api-reference/invoice/fetch-upcoming-invoice) resource,
+           which represents a snapshot for the current period).
         3. Assess how minimums and discounts affect your customers by teasing apart
            costs directly as a result of usage, as opposed to minimums and discounts at
            the plan and price level.

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

@@ -91,11 +91,11 @@ def list(
         """
         The credits ledger provides _auditing_ functionality over Orb's credits system
         with a list of actions that have taken place to modify a customer's credit
-        balance. This [paginated endpoint](../reference/pagination) lists these entries,
-        starting from the most recent ledger entry.
+        balance. This [paginated endpoint](/api-reference/pagination) lists these
+        entries, starting from the most recent ledger entry.
 
         More details on using Orb's real-time credit feature are
-        [here](../guides/product-catalog/prepurchase.md).
+        [here](/product-catalog/prepurchase).
 
         There are four major types of modifications to credit balance, detailed below.
 
@@ -2045,11 +2045,11 @@ def list_by_external_id(
         """
         The credits ledger provides _auditing_ functionality over Orb's credits system
         with a list of actions that have taken place to modify a customer's credit
-        balance. This [paginated endpoint](../reference/pagination) lists these entries,
-        starting from the most recent ledger entry.
+        balance. This [paginated endpoint](/api-reference/pagination) lists these
+        entries, starting from the most recent ledger entry.
 
         More details on using Orb's real-time credit feature are
-        [here](../guides/product-catalog/prepurchase.md).
+        [here](/product-catalog/prepurchase).
 
         There are four major types of modifications to credit balance, detailed below.
 
@@ -2230,11 +2230,11 @@ def list(
         """
         The credits ledger provides _auditing_ functionality over Orb's credits system
         with a list of actions that have taken place to modify a customer's credit
-        balance. This [paginated endpoint](../reference/pagination) lists these entries,
-        starting from the most recent ledger entry.
+        balance. This [paginated endpoint](/api-reference/pagination) lists these
+        entries, starting from the most recent ledger entry.
 
         More details on using Orb's real-time credit feature are
-        [here](../guides/product-catalog/prepurchase.md).
+        [here](/product-catalog/prepurchase).
 
         There are four major types of modifications to credit balance, detailed below.
 
@@ -4184,11 +4184,11 @@ def list_by_external_id(
         """
         The credits ledger provides _auditing_ functionality over Orb's credits system
         with a list of actions that have taken place to modify a customer's credit
-        balance. This [paginated endpoint](../reference/pagination) lists these entries,
-        starting from the most recent ledger entry.
+        balance. This [paginated endpoint](/api-reference/pagination) lists these
+        entries, starting from the most recent ledger entry.
 
         More details on using Orb's real-time credit feature are
-        [here](../guides/product-catalog/prepurchase.md).
+        [here](/product-catalog/prepurchase).
 
         There are four major types of modifications to credit balance, detailed below.