orb-billing 2.11.2 → 3.0.0

package/src/resources/customers/credits/credits.ts

@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from '../../../core';
 import { APIResource } from '../../../resource';
 import { isRequestOptions } from '../../../core';
+import * as Core from '../../../core';
 import * as CreditsAPI from './credits';
 import * as LedgerAPI from './ledger';
 import * as TopUpsAPI from './top-ups';
@@ -85,6 +85,8 @@ export interface CreditListResponse {
 
   expiry_date: string | null;
 
+  maximum_initial_balance: number | null;
+
   per_unit_cost_basis: string | null;
 
   status: 'active' | 'pending_payment';
@@ -99,6 +101,8 @@ export interface CreditListByExternalIDResponse {
 
   expiry_date: string | null;
 
+  maximum_initial_balance: number | null;
+
   per_unit_cost_basis: string | null;
 
   status: 'active' | 'pending_payment';
@@ -109,6 +113,11 @@ export interface CreditListParams extends PageParams {
    * The ledger currency or custom pricing unit to use.
    */
   currency?: string | null;
+
+  /**
+   * Include all blocks, not just active ones.
+   */
+  include_all_blocks?: boolean;
 }
 
 export interface CreditListByExternalIDParams extends PageParams {
@@ -116,6 +125,11 @@ export interface CreditListByExternalIDParams extends PageParams {
    * The ledger currency or custom pricing unit to use.
    */
   currency?: string | null;
+
+  /**
+   * Include all blocks, not just active ones.
+   */
+  include_all_blocks?: boolean;
 }
 
 export namespace Credits {

package/src/resources/customers/credits/ledger.ts

@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from '../../../core';
 import { APIResource } from '../../../resource';
 import { isRequestOptions } from '../../../core';
+import * as Core from '../../../core';
 import * as LedgerAPI from './ledger';
 import { Page, type PageParams } from '../../../pagination';
 

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

@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from '../../../core';
 import { APIResource } from '../../../resource';
 import { isRequestOptions } from '../../../core';
+import * as Core from '../../../core';
 import * as TopUpsAPI from './top-ups';
 import { Page, type PageParams } from '../../../pagination';
 

package/src/resources/customers/customers.ts

@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from '../../core';
 import { APIResource } from '../../resource';
 import { isRequestOptions } from '../../core';
+import * as Core from '../../core';
 import * as CustomersAPI from './customers';
 import * as BalanceTransactionsAPI from './balance-transactions';
 import * as CostsAPI from './costs';

package/src/resources/customers/usage.ts

@@ -1,7 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from '../../core';
 import { APIResource } from '../../resource';
+import * as Core from '../../core';
 import * as UsageAPI from './usage';
 
 export class Usage extends APIResource {

package/src/resources/events/backfills.ts

@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from '../../core';
 import { APIResource } from '../../resource';
 import { isRequestOptions } from '../../core';
+import * as Core from '../../core';
 import * as BackfillsAPI from './backfills';
 import { Page, type PageParams } from '../../pagination';
 

package/src/resources/events/events.ts

@@ -1,7 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from '../../core';
 import { APIResource } from '../../resource';
+import * as Core from '../../core';
 import * as EventsAPI from './events';
 import * as BackfillsAPI from './backfills';
 

package/src/resources/index.ts

@@ -26,6 +26,7 @@ export {
   Price,
   PriceEvaluateResponse,
   PriceCreateParams,
+  PriceUpdateParams,
   PriceListParams,
   PriceEvaluateParams,
   PricesPage,
@@ -45,6 +46,7 @@ export {
   Invoice,
   InvoiceFetchUpcomingResponse,
   InvoiceCreateParams,
+  InvoiceUpdateParams,
   InvoiceListParams,
   InvoiceFetchUpcomingParams,
   InvoiceMarkPaidParams,

package/src/resources/invoice-line-items.ts

@@ -1,7 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from '../core';
 import { APIResource } from '../resource';
+import * as Core from '../core';
 import * as InvoiceLineItemsAPI from './invoice-line-items';
 import * as Shared from './shared';
 import * as PricesAPI from './prices/prices';

package/src/resources/invoices.ts

@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from '../core';
 import { APIResource } from '../resource';
 import { isRequestOptions } from '../core';
+import * as Core from '../core';
 import * as InvoicesAPI from './invoices';
 import * as Shared from './shared';
 import * as PricesAPI from './prices/prices';
@@ -16,6 +16,30 @@ export class Invoices extends APIResource {
     return this._client.post('/invoices', { body, ...options });
   }
 
+  /**
+   * This endpoint allows you to update the `metadata` property on an invoice. If you
+   * pass null for the metadata value, it will clear any existing metadata for that
+   * invoice.
+   *
+   * `metadata` can be modified regardless of invoice state.
+   */
+  update(
+    invoiceId: string,
+    body?: InvoiceUpdateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<Invoice>;
+  update(invoiceId: string, options?: Core.RequestOptions): Core.APIPromise<Invoice>;
+  update(
+    invoiceId: string,
+    body: InvoiceUpdateParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<Invoice> {
+    if (isRequestOptions(body)) {
+      return this.update(invoiceId, {}, body);
+    }
+    return this._client.put(`/invoices/${invoiceId}`, { body, ...options });
+  }
+
   /**
    * This endpoint returns a list of all [`Invoice`](../guides/concepts#invoice)s for
    * an account in a list format.
@@ -408,6 +432,11 @@ export namespace Invoice {
      */
     next_attempt_at: string | null;
 
+    /**
+     * Number of auto-collection payment attempts.
+     */
+    num_attempts: number | null;
+
     /**
      * If Orb has ever attempted payment auto-collection for this invoice, this field
      * will reflect when that attempt occurred. In conjunction with `next_attempt_at`,
@@ -1571,6 +1600,11 @@ export namespace InvoiceFetchUpcomingResponse {
      */
     next_attempt_at: string | null;
 
+    /**
+     * Number of auto-collection payment attempts.
+     */
+    num_attempts: number | null;
+
     /**
      * If Orb has ever attempted payment auto-collection for this invoice, this field
      * will reflect when that attempt occurred. In conjunction with `next_attempt_at`,
@@ -2469,6 +2503,11 @@ export interface InvoiceCreateParams {
    */
   customer_id?: string | null;
 
+  /**
+   * An optional discount to attach to the invoice.
+   */
+  discount?: Shared.Discount | null;
+
   /**
    * The `external_customer_id` of the `Customer` to create this invoice for. One of
    * `customer_id` and `external_customer_id` are required.
@@ -2533,6 +2572,15 @@ export namespace InvoiceCreateParams {
   }
 }
 
+export interface InvoiceUpdateParams {
+  /**
+   * User-specified key/value pairs for the resource. Individual keys can be removed
+   * by setting the value to `null`, and the entire metadata mapping can be cleared
+   * by setting `metadata` to `null`.
+   */
+  metadata?: Record<string, string | null> | null;
+}
+
 export interface InvoiceListParams extends PageParams {
   amount?: string | null;
 
@@ -2595,6 +2643,7 @@ export namespace Invoices {
   export import InvoiceFetchUpcomingResponse = InvoicesAPI.InvoiceFetchUpcomingResponse;
   export import InvoicesPage = InvoicesAPI.InvoicesPage;
   export import InvoiceCreateParams = InvoicesAPI.InvoiceCreateParams;
+  export import InvoiceUpdateParams = InvoicesAPI.InvoiceUpdateParams;
   export import InvoiceListParams = InvoicesAPI.InvoiceListParams;
   export import InvoiceFetchUpcomingParams = InvoicesAPI.InvoiceFetchUpcomingParams;
   export import InvoiceMarkPaidParams = InvoicesAPI.InvoiceMarkPaidParams;

package/src/resources/items.ts

@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from '../core';
 import { APIResource } from '../resource';
 import { isRequestOptions } from '../core';
+import * as Core from '../core';
 import * as ItemsAPI from './items';
 import { Page, type PageParams } from '../pagination';
 
@@ -15,9 +15,18 @@ export class Items extends APIResource {
   }
 
   /**
-   * Update items
+   * This endpoint can be used to update properties on the Item.
    */
-  update(itemId: string, body: ItemUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Item> {
+  update(itemId: string, body?: ItemUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Item>;
+  update(itemId: string, options?: Core.RequestOptions): Core.APIPromise<Item>;
+  update(
+    itemId: string,
+    body: ItemUpdateParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<Item> {
+    if (isRequestOptions(body)) {
+      return this.update(itemId, {}, body);
+    }
     return this._client.put(`/items/${itemId}`, { body, ...options });
   }
 
@@ -85,14 +94,9 @@ export interface ItemCreateParams {
 }
 
 export interface ItemUpdateParams {
-  external_connections: Array<ItemUpdateParams.ExternalConnection> | null;
+  external_connections?: Array<ItemUpdateParams.ExternalConnection> | null;
 
-  /**
-   * User-specified key/value pairs for the resource. Individual keys can be removed
-   * by setting the value to `null`, and the entire metadata mapping can be cleared
-   * by setting `metadata` to `null`.
-   */
-  metadata?: Record<string, string | null> | null;
+  name?: string | null;
 }
 
 export namespace ItemUpdateParams {

package/src/resources/metrics.ts

@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from '../core';
 import { APIResource } from '../resource';
 import { isRequestOptions } from '../core';
+import * as Core from '../core';
 import * as MetricsAPI from './metrics';
 import * as ItemsAPI from './items';
 import { Page, type PageParams } from '../pagination';

package/src/resources/plans/external-plan-id.ts

@@ -1,25 +1,17 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from '../../core';
 import { APIResource } from '../../resource';
 import { isRequestOptions } from '../../core';
+import * as Core from '../../core';
 import * as ExternalPlanIDAPI from './external-plan-id';
 import * as PlansAPI from './plans';
 
 export class ExternalPlanID extends APIResource {
   /**
-   * This endpoint is used to fetch [plan](../guides/concepts##plan-and-price)
-   * details given an external_plan_id identifier. It returns information about the
-   * prices included in the plan and their configuration, as well as the product that
-   * the plan is attached to.
+   * This endpoint can be used to update the `external_plan_id`, and `metadata` of an
+   * existing plan.
    *
-   * ## Serialized prices
-   *
-   * Orb supports a few different pricing models out of the box. Each of these models
-   * is serialized differently in a given [Price](../guides/concepts#plan-and-price)
-   * object. The `model_type` field determines the key for the configuration object
-   * that is present. A detailed explanation of price types can be found in the
-   * [Price schema](../guides/concepts#plan-and-price).
+   * Other fields on a customer are currently immutable.
    */
   update(
     otherExternalPlanId: string,
@@ -44,6 +36,10 @@ export class ExternalPlanID extends APIResource {
    * prices included in the plan and their configuration, as well as the product that
    * the plan is attached to.
    *
+   * If multiple plans are found to contain the specified external_plan_id, the
+   * active plans will take priority over archived ones, and among those, the
+   * endpoint will return the most recently created plan.
+   *
    * ## Serialized prices
    *
    * Orb supports a few different pricing models out of the box. Each of these models