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

@@ -225,6 +225,7 @@ Methods:
 - <code title="post /items">client.items.<a href="./src/resources/items.ts">create</a>({ ...params }) -> Item</code>
 - <code title="put /items/{item_id}">client.items.<a href="./src/resources/items.ts">update</a>(itemId, { ...params }) -> Item</code>
 - <code title="get /items">client.items.<a href="./src/resources/items.ts">list</a>({ ...params }) -> ItemsPage</code>
+- <code title="post /items/{item_id}/archive">client.items.<a href="./src/resources/items.ts">archive</a>(itemId) -> Item</code>
 - <code title="get /items/{item_id}">client.items.<a href="./src/resources/items.ts">fetch</a>(itemId) -> Item</code>
 
 # Metrics
@@ -252,13 +253,39 @@ Methods:
 - <code title="put /plans/{plan_id}">client.plans.<a href="./src/resources/plans/plans.ts">update</a>(planId, { ...params }) -> Plan</code>
 - <code title="get /plans">client.plans.<a href="./src/resources/plans/plans.ts">list</a>({ ...params }) -> PlansPage</code>
 - <code title="get /plans/{plan_id}">client.plans.<a href="./src/resources/plans/plans.ts">fetch</a>(planId) -> Plan</code>
+- <code title="post /plans/{plan_id}/set_default_version">client.plans.<a href="./src/resources/plans/plans.ts">setDefaultVersion</a>(planId, { ...params }) -> Plan</code>
 
 ## ExternalPlanID
 
 Methods:
 
-- <code title="put /plans/external_plan_id/{external_plan_id}">client.plans.externalPlanId.<a href="./src/resources/plans/external-plan-id.ts">update</a>(otherExternalPlanId, { ...params }) -> Plan</code>
-- <code title="get /plans/external_plan_id/{external_plan_id}">client.plans.externalPlanId.<a href="./src/resources/plans/external-plan-id.ts">fetch</a>(externalPlanId) -> Plan</code>
+- <code title="put /plans/external_plan_id/{external_plan_id}">client.plans.externalPlanId.<a href="./src/resources/plans/external-plan-id/external-plan-id.ts">update</a>(otherExternalPlanId, { ...params }) -> Plan</code>
+- <code title="get /plans/external_plan_id/{external_plan_id}">client.plans.externalPlanId.<a href="./src/resources/plans/external-plan-id/external-plan-id.ts">fetch</a>(externalPlanId) -> Plan</code>
+- <code title="post /plans/external_plan_id/{external_plan_id}/set_default_version">client.plans.externalPlanId.<a href="./src/resources/plans/external-plan-id/external-plan-id.ts">setDefaultVersion</a>(externalPlanId, { ...params }) -> Plan</code>
+
+### Versions
+
+Types:
+
+- <code><a href="./src/resources/plans/external-plan-id/versions.ts">VersionCreateResponse</a></code>
+- <code><a href="./src/resources/plans/external-plan-id/versions.ts">VersionRetrieveResponse</a></code>
+
+Methods:
+
+- <code title="post /plans/external_plan_id/{external_plan_id}/versions">client.plans.externalPlanId.versions.<a href="./src/resources/plans/external-plan-id/versions.ts">create</a>(externalPlanId, { ...params }) -> VersionCreateResponse</code>
+- <code title="get /plans/external_plan_id/{external_plan_id}/versions/{version}">client.plans.externalPlanId.versions.<a href="./src/resources/plans/external-plan-id/versions.ts">retrieve</a>(externalPlanId, version) -> VersionRetrieveResponse</code>
+
+## Versions
+
+Types:
+
+- <code><a href="./src/resources/plans/versions.ts">VersionCreateResponse</a></code>
+- <code><a href="./src/resources/plans/versions.ts">VersionRetrieveResponse</a></code>
+
+Methods:
+
+- <code title="post /plans/{plan_id}/versions">client.plans.versions.<a href="./src/resources/plans/versions.ts">create</a>(planId, { ...params }) -> VersionCreateResponse</code>
+- <code title="get /plans/{plan_id}/versions/{version}">client.plans.versions.<a href="./src/resources/plans/versions.ts">retrieve</a>(planId, version) -> VersionRetrieveResponse</code>
 
 # Prices
 
@@ -273,7 +300,7 @@ Methods:
 - <code title="post /prices">client.prices.<a href="./src/resources/prices/prices.ts">create</a>({ ...params }) -> Price</code>
 - <code title="put /prices/{price_id}">client.prices.<a href="./src/resources/prices/prices.ts">update</a>(priceId, { ...params }) -> Price</code>
 - <code title="get /prices">client.prices.<a href="./src/resources/prices/prices.ts">list</a>({ ...params }) -> PricesPage</code>
-- <code title="post /prices/{price_id}/evaluate">client.prices.<a href="./src/resources/prices/prices.ts">evaluate</a>(priceId, { ...params }) -> PriceEvaluateResponse</code>
+- <code title="post /prices/evaluate">client.prices.<a href="./src/resources/prices/prices.ts">evaluate</a>({ ...params }) -> PriceEvaluateResponse</code>
 - <code title="get /prices/{price_id}">client.prices.<a href="./src/resources/prices/prices.ts">fetch</a>(priceId) -> Price</code>
 
 ## ExternalPriceID

src/index.ts

@@ -137,6 +137,7 @@ import {
   Plan,
   PlanCreateParams,
   PlanListParams,
+  PlanSetDefaultVersionParams,
   PlanUpdateParams,
   Plans,
   PlansPage,
@@ -460,6 +461,7 @@ export declare namespace Orb {
     type PlanCreateParams as PlanCreateParams,
     type PlanUpdateParams as PlanUpdateParams,
     type PlanListParams as PlanListParams,
+    type PlanSetDefaultVersionParams as PlanSetDefaultVersionParams,
   };
 
   export {

src/resources/alerts.ts

@@ -224,6 +224,12 @@ export interface Alert {
     | 'credit_balance_recovered'
     | 'usage_exceeded'
     | 'cost_exceeded';
+
+  /**
+   * The current status of the alert. This field is only present for credit balance
+   * alerts.
+   */
+  balance_alert_status?: Array<Alert.BalanceAlertStatus> | null;
 }
 
 export namespace Alert {
@@ -280,6 +286,21 @@ export namespace Alert {
      */
     value: number;
   }
+
+  /**
+   * Alert status is used to determine if an alert is currently in-alert or not.
+   */
+  export interface BalanceAlertStatus {
+    /**
+     * Whether the alert is currently in-alert or not.
+     */
+    in_alert: boolean;
+
+    /**
+     * The value of the threshold that defines the alert status.
+     */
+    threshold_value: number;
+  }
 }
 
 export interface AlertUpdateParams {

src/resources/credit-notes.ts

@@ -254,14 +254,14 @@ export interface CreditNoteCreateParams {
   line_items: Array<CreditNoteCreateParams.LineItem>;
 
   /**
-   * An optional memo to attach to the credit note.
+   * An optional reason for the credit note.
    */
-  memo?: string | null;
+  reason: 'duplicate' | 'fraudulent' | 'order_change' | 'product_unsatisfactory';
 
   /**
-   * An optional reason for the credit note.
+   * An optional memo to attach to the credit note.
    */
-  reason?: 'duplicate' | 'fraudulent' | 'order_change' | 'product_unsatisfactory' | null;
+  memo?: string | null;
 }
 
 export namespace CreditNoteCreateParams {

src/resources/customers/balance-transactions.ts

@@ -40,13 +40,6 @@ export class BalanceTransactions extends APIResource {
    * This endpoint retrieves all customer balance transactions in reverse
    * 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.
    */
   list(
     customerId: string,

src/resources/customers/credits/ledger.ts

@@ -3,6 +3,7 @@
 import { APIResource } from '../../../resource';
 import { isRequestOptions } from '../../../core';
 import * as Core from '../../../core';
+import * as InvoicesAPI from '../../invoices';
 import { Page, type PageParams } from '../../../pagination';
 
 export class Ledger extends APIResource {
@@ -513,6 +514,11 @@ export namespace LedgerListResponse {
     metadata: Record<string, string>;
 
     starting_balance: number;
+
+    /**
+     * If the increment resulted in invoice creation, the list of created invoices
+     */
+    created_invoices?: Array<InvoicesAPI.Invoice> | null;
   }
 
   export namespace IncrementLedgerEntry {
@@ -896,6 +902,11 @@ export namespace LedgerCreateEntryResponse {
     metadata: Record<string, string>;
 
     starting_balance: number;
+
+    /**
+     * If the increment resulted in invoice creation, the list of created invoices
+     */
+    created_invoices?: Array<InvoicesAPI.Invoice> | null;
   }
 
   export namespace IncrementLedgerEntry {
@@ -1279,6 +1290,11 @@ export namespace LedgerCreateEntryByExternalIDResponse {
     metadata: Record<string, string>;
 
     starting_balance: number;
+
+    /**
+     * If the increment resulted in invoice creation, the list of created invoices
+     */
+    created_invoices?: Array<InvoicesAPI.Invoice> | null;
   }
 
   export namespace IncrementLedgerEntry {
@@ -1662,6 +1678,11 @@ export namespace LedgerListByExternalIDResponse {
     metadata: Record<string, string>;
 
     starting_balance: number;
+
+    /**
+     * If the increment resulted in invoice creation, the list of created invoices
+     */
+    created_invoices?: Array<InvoicesAPI.Invoice> | null;
   }
 
   export namespace IncrementLedgerEntry {

src/resources/customers/credits/top-ups.ts

@@ -449,7 +449,7 @@ export interface TopUpCreateParams {
 
   /**
    * 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.
    */
   active_from?: string | null;
 
@@ -528,7 +528,7 @@ export interface TopUpCreateByExternalIDParams {
 
   /**
    * 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.
    */
   active_from?: string | null;
 

src/resources/customers/customers.ts

@@ -103,10 +103,7 @@ export class Customers extends APIResource {
    * **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.
    */
   delete(customerId: string, options?: Core.RequestOptions): Core.APIPromise<void> {
     return this._client.delete(`/customers/${customerId}`, {
@@ -812,6 +809,7 @@ export interface CustomerCreateParams {
   tax_configuration?:
     | CustomerCreateParams.NewAvalaraTaxConfiguration
     | CustomerCreateParams.NewTaxJarConfiguration
+    | CustomerCreateParams.NewSphereConfiguration
     | null;
 
   /**
@@ -1009,6 +1007,12 @@ export namespace CustomerCreateParams {
     tax_provider: 'taxjar';
   }
 
+  export interface NewSphereConfiguration {
+    tax_exempt: boolean;
+
+    tax_provider: 'sphere';
+  }
+
   /**
    * Tax IDs are commonly required to be displayed on customer invoices, which are
    * added to the headers of invoices.
@@ -1352,6 +1356,7 @@ export interface CustomerUpdateParams {
   tax_configuration?:
     | CustomerUpdateParams.NewAvalaraTaxConfiguration
     | CustomerUpdateParams.NewTaxJarConfiguration
+    | CustomerUpdateParams.NewSphereConfiguration
     | null;
 
   /**
@@ -1542,6 +1547,12 @@ export namespace CustomerUpdateParams {
     tax_provider: 'taxjar';
   }
 
+  export interface NewSphereConfiguration {
+    tax_exempt: boolean;
+
+    tax_provider: 'sphere';
+  }
+
   /**
    * Tax IDs are commonly required to be displayed on customer invoices, which are
    * added to the headers of invoices.
@@ -1895,6 +1906,7 @@ export interface CustomerUpdateByExternalIDParams {
   tax_configuration?:
     | CustomerUpdateByExternalIDParams.NewAvalaraTaxConfiguration
     | CustomerUpdateByExternalIDParams.NewTaxJarConfiguration
+    | CustomerUpdateByExternalIDParams.NewSphereConfiguration
     | null;
 
   /**
@@ -2085,6 +2097,12 @@ export namespace CustomerUpdateByExternalIDParams {
     tax_provider: 'taxjar';
   }
 
+  export interface NewSphereConfiguration {
+    tax_exempt: boolean;
+
+    tax_provider: 'sphere';
+  }
+
   /**
    * Tax IDs are commonly required to be displayed on customer invoices, which are
    * added to the headers of invoices.

src/resources/dimensional-price-groups/dimensional-price-groups.ts

@@ -20,7 +20,7 @@ export class DimensionalPriceGroups extends APIResource {
    * 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.
    */
   create(
     body: DimensionalPriceGroupCreateParams,