orb-billing 1.27.0 → 1.28.0

package/src/resources/customers/customers.ts

@@ -11,11 +11,11 @@ import * as CreditsAPI from "./credits/credits";
 import { Page, type PageParams } from "../../pagination";
 
 export class Customers extends APIResource {
-  costs: CostsAPI.Costs = new CostsAPI.Costs(this.client);
-  usage: UsageAPI.Usage = new UsageAPI.Usage(this.client);
-  credits: CreditsAPI.Credits = new CreditsAPI.Credits(this.client);
+  costs: CostsAPI.Costs = new CostsAPI.Costs(this._client);
+  usage: UsageAPI.Usage = new UsageAPI.Usage(this._client);
+  credits: CreditsAPI.Credits = new CreditsAPI.Credits(this._client);
   balanceTransactions: BalanceTransactionsAPI.BalanceTransactions =
-    new BalanceTransactionsAPI.BalanceTransactions(this.client);
+    new BalanceTransactionsAPI.BalanceTransactions(this._client);
 
   /**
    * This operation is used to create an Orb customer, who is party to the core
@@ -32,7 +32,7 @@ export class Customers extends APIResource {
    *   configured on a per-customer basis by setting the `timezone` parameter
    */
   create(body: CustomerCreateParams, options?: Core.RequestOptions): Core.APIPromise<Customer> {
-    return this.post('/customers', { body, ...options });
+    return this._client.post('/customers', { body, ...options });
   }
 
   /**
@@ -56,7 +56,7 @@ export class Customers extends APIResource {
     if (isRequestOptions(body)) {
       return this.update(customerId, {}, body);
     }
-    return this.put(`/customers/${customerId}`, { body, ...options });
+    return this._client.put(`/customers/${customerId}`, { body, ...options });
   }
 
   /**
@@ -77,7 +77,7 @@ export class Customers extends APIResource {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
-    return this.getAPIList('/customers', CustomersPage, { query, ...options });
+    return this._client.getAPIList('/customers', CustomersPage, { query, ...options });
   }
 
   /**
@@ -94,8 +94,8 @@ export class Customers extends APIResource {
    *
    * On successful processing, this returns an empty dictionary (`{}`) in the API.
    */
-  del(customerId: string, options?: Core.RequestOptions): Core.APIPromise<void> {
-    return this.delete(`/customers/${customerId}`, {
+  delete(customerId: string, options?: Core.RequestOptions): Core.APIPromise<void> {
+    return this._client.delete(`/customers/${customerId}`, {
       ...options,
       headers: { Accept: '', ...options?.headers },
     });
@@ -110,7 +110,7 @@ export class Customers extends APIResource {
    * discussion of the Customer model.
    */
   fetch(customerId: string, options?: Core.RequestOptions): Core.APIPromise<Customer> {
-    return this.get(`/customers/${customerId}`, options);
+    return this._client.get(`/customers/${customerId}`, options);
   }
 
   /**
@@ -121,7 +121,7 @@ export class Customers extends APIResource {
    * [Get Customer](fetch-customer).
    */
   fetchByExternalId(externalCustomerId: string, options?: Core.RequestOptions): Core.APIPromise<Customer> {
-    return this.get(`/customers/external_customer_id/${externalCustomerId}`, options);
+    return this._client.get(`/customers/external_customer_id/${externalCustomerId}`, options);
   }
 
   /**
@@ -144,7 +144,7 @@ export class Customers extends APIResource {
     if (isRequestOptions(body)) {
       return this.updateByExternalId(id, {}, body);
     }
-    return this.put(`/customers/external_customer_id/${id}`, { body, ...options });
+    return this._client.put(`/customers/external_customer_id/${id}`, { body, ...options });
   }
 }
 
@@ -205,6 +205,10 @@ export interface Customer {
    */
   external_customer_id: string | null;
 
+  /**
+   * User specified key-value pairs. If not provided, this defaults to an empty
+   * dictionary.
+   */
   metadata: Record<string, string>;
 
   /**
@@ -628,10 +632,9 @@ export interface CustomerCreateParams {
   external_customer_id?: string | null;
 
   /**
-   * User-specified key value pairs, often useful for referencing internal resources
-   * or IDs. Returned as-is in the customer resource.
+   * User-specified key/value pairs for the resource.
    */
-  metadata?: unknown | null;
+  metadata?: Record<string, string | null> | null;
 
   /**
    * This is used for creating charges or invoices in an external system via Orb.
@@ -1031,10 +1034,9 @@ export interface CustomerUpdateParams {
   email_delivery?: boolean | null;
 
   /**
-   * User-specified key value pairs, often useful for referencing internal resources
-   * or IDs. Returned as-is in the customer resource.
+   * User-specified key/value pairs for the resource.
    */
-  metadata?: unknown | null;
+  metadata?: Record<string, string | null> | null;
 
   /**
    * The full name of the customer
@@ -1446,10 +1448,9 @@ export interface CustomerUpdateByExternalIDParams {
   email_delivery?: boolean | null;
 
   /**
-   * User-specified key value pairs, often useful for referencing internal resources
-   * or IDs. Returned as-is in the customer resource.
+   * User-specified key/value pairs for the resource.
    */
-  metadata?: unknown | null;
+  metadata?: Record<string, string | null> | null;
 
   /**
    * The full name of the customer

package/src/resources/customers/usage.ts

@@ -109,7 +109,7 @@ export class Usage extends APIResource {
     options?: Core.RequestOptions,
   ): Core.APIPromise<UsageUpdateResponse> {
     const { timeframe_end, timeframe_start, ...body } = params;
-    return this.patch(`/customers/${id}/usage`, {
+    return this._client.patch(`/customers/${id}/usage`, {
       query: { timeframe_end, timeframe_start },
       body,
       ...options,
@@ -220,7 +220,7 @@ export class Usage extends APIResource {
     options?: Core.RequestOptions,
   ): Core.APIPromise<UsageUpdateByExternalIDResponse> {
     const { timeframe_end, timeframe_start, ...body } = params;
-    return this.patch(`/customers/external_customer_id/${id}/usage`, {
+    return this._client.patch(`/customers/external_customer_id/${id}/usage`, {
       query: { timeframe_end, timeframe_start },
       body,
       ...options,

package/src/resources/events/backfills.ts

@@ -35,7 +35,7 @@ export class Backfills extends APIResource {
    * events.
    */
   create(body: BackfillCreateParams, options?: Core.RequestOptions): Core.APIPromise<BackfillCreateResponse> {
-    return this.post('/events/backfills', { body, ...options });
+    return this._client.post('/events/backfills', { body, ...options });
   }
 
   /**
@@ -59,7 +59,7 @@ export class Backfills extends APIResource {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
-    return this.getAPIList('/events/backfills', BackfillListResponsesPage, { query, ...options });
+    return this._client.getAPIList('/events/backfills', BackfillListResponsesPage, { query, ...options });
   }
 
   /**
@@ -69,14 +69,14 @@ export class Backfills extends APIResource {
    * will transition to `reflected`.
    */
   close(backfillId: string, options?: Core.RequestOptions): Core.APIPromise<BackfillCloseResponse> {
-    return this.post(`/events/backfills/${backfillId}/close`, options);
+    return this._client.post(`/events/backfills/${backfillId}/close`, options);
   }
 
   /**
    * This endpoint is used to fetch a backfill given an identifier.
    */
   fetch(backfillId: string, options?: Core.RequestOptions): Core.APIPromise<BackfillFetchResponse> {
-    return this.get(`/events/backfills/${backfillId}`, options);
+    return this._client.get(`/events/backfills/${backfillId}`, options);
   }
 
   /**
@@ -89,7 +89,7 @@ export class Backfills extends APIResource {
    * result of the backfill and it will immediately transition to `reverted`.
    */
   revert(backfillId: string, options?: Core.RequestOptions): Core.APIPromise<BackfillRevertResponse> {
-    return this.post(`/events/backfills/${backfillId}/revert`, options);
+    return this._client.post(`/events/backfills/${backfillId}/revert`, options);
   }
 }
 

package/src/resources/events/events.ts

@@ -6,7 +6,7 @@ import * as EventsAPI from "./events";
 import * as BackfillsAPI from "./backfills";
 
 export class Events extends APIResource {
-  backfills: BackfillsAPI.Backfills = new BackfillsAPI.Backfills(this.client);
+  backfills: BackfillsAPI.Backfills = new BackfillsAPI.Backfills(this._client);
 
   /**
    * This endpoint is used to amend a single usage event with a given `event_id`.
@@ -58,7 +58,7 @@ export class Events extends APIResource {
     body: EventUpdateParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<EventUpdateResponse> {
-    return this.put(`/events/${eventId}`, { body, ...options });
+    return this._client.put(`/events/${eventId}`, { body, ...options });
   }
 
   /**
@@ -101,7 +101,7 @@ export class Events extends APIResource {
    *   deprecating events for customers not in the Orb system.
    */
   deprecate(eventId: string, options?: Core.RequestOptions): Core.APIPromise<EventDeprecateResponse> {
-    return this.put(`/events/${eventId}/deprecate`, options);
+    return this._client.put(`/events/${eventId}/deprecate`, options);
   }
 
   /**
@@ -306,7 +306,7 @@ export class Events extends APIResource {
    */
   ingest(params: EventIngestParams, options?: Core.RequestOptions): Core.APIPromise<EventIngestResponse> {
     const { backfill_id, debug, ...body } = params;
-    return this.post('/ingest', { query: { backfill_id, debug }, body, ...options });
+    return this._client.post('/ingest', { query: { backfill_id, debug }, body, ...options });
   }
 
   /**
@@ -329,7 +329,7 @@ export class Events extends APIResource {
    * empty array for `data` instead.
    */
   search(body: EventSearchParams, options?: Core.RequestOptions): Core.APIPromise<EventSearchResponse> {
-    return this.post('/events/search', { body, ...options });
+    return this._client.post('/events/search', { body, ...options });
   }
 }
 

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

@@ -15,7 +15,7 @@ export class InvoiceLineItems extends APIResource {
     body: InvoiceLineItemCreateParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<InvoiceLineItemCreateResponse> {
-    return this.post('/invoice_line_items', { body, ...options });
+    return this._client.post('/invoice_line_items', { body, ...options });
   }
 }
 

package/src/resources/invoices.ts

@@ -13,7 +13,7 @@ export class Invoices extends APIResource {
    * This endpoint is used to create a one-off invoice for a customer.
    */
   create(body: InvoiceCreateParams, options?: Core.RequestOptions): Core.APIPromise<Invoice> {
-    return this.post('/invoices', { body, ...options });
+    return this._client.post('/invoices', { body, ...options });
   }
 
   /**
@@ -36,7 +36,7 @@ export class Invoices extends APIResource {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
-    return this.getAPIList('/invoices', InvoicesPage, { query, ...options });
+    return this._client.getAPIList('/invoices', InvoicesPage, { query, ...options });
   }
 
   /**
@@ -44,7 +44,7 @@ export class Invoices extends APIResource {
    * an identifier.
    */
   fetch(invoiceId: string, options?: Core.RequestOptions): Core.APIPromise<Invoice> {
-    return this.get(`/invoices/${invoiceId}`, options);
+    return this._client.get(`/invoices/${invoiceId}`, options);
   }
 
   /**
@@ -64,7 +64,7 @@ export class Invoices extends APIResource {
     if (isRequestOptions(query)) {
       return this.fetchUpcoming({}, query);
     }
-    return this.get('/invoices/upcoming', { query, ...options });
+    return this._client.get('/invoices/upcoming', { query, ...options });
   }
 
   /**
@@ -76,7 +76,7 @@ export class Invoices extends APIResource {
    * providers, etc).
    */
   issue(invoiceId: string, options?: Core.RequestOptions): Core.APIPromise<Invoice> {
-    return this.post(`/invoices/${invoiceId}/issue`, options);
+    return this._client.post(`/invoices/${invoiceId}/issue`, options);
   }
 
   /**
@@ -88,7 +88,7 @@ export class Invoices extends APIResource {
     body: InvoiceMarkPaidParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<Invoice> {
-    return this.post(`/invoices/${invoiceId}/mark_paid`, { body, ...options });
+    return this._client.post(`/invoices/${invoiceId}/mark_paid`, { body, ...options });
   }
 
   /**
@@ -101,7 +101,7 @@ export class Invoices extends APIResource {
    * customer balance upon voiding.
    */
   void(invoiceId: string, options?: Core.RequestOptions): Core.APIPromise<Invoice> {
-    return this.post(`/invoices/${invoiceId}/void`, options);
+    return this._client.post(`/invoices/${invoiceId}/void`, options);
   }
 }
 
@@ -298,7 +298,11 @@ export interface Invoice {
    */
   memo: string | null;
 
-  metadata: unknown;
+  /**
+   * User specified key-value pairs. If not provided, this defaults to an empty
+   * dictionary.
+   */
+  metadata: Record<string, string>;
 
   minimum: Invoice.Minimum | null;
 
@@ -1363,7 +1367,11 @@ export interface InvoiceFetchUpcomingResponse {
    */
   memo: string | null;
 
-  metadata: unknown;
+  /**
+   * User specified key-value pairs. If not provided, this defaults to an empty
+   * dictionary.
+   */
+  metadata: Record<string, string>;
 
   minimum: InvoiceFetchUpcomingResponse.Minimum | null;
 

package/src/resources/items.ts

@@ -11,7 +11,7 @@ export class Items extends APIResource {
    * This endpoint is used to create an [Item](../guides/concepts#item).
    */
   create(body: ItemCreateParams, options?: Core.RequestOptions): Core.APIPromise<Item> {
-    return this.post('/items', { body, ...options });
+    return this._client.post('/items', { body, ...options });
   }
 
   /**
@@ -27,14 +27,14 @@ export class Items extends APIResource {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
-    return this.getAPIList('/items', ItemsPage, { query, ...options });
+    return this._client.getAPIList('/items', ItemsPage, { query, ...options });
   }
 
   /**
    * This endpoint returns an item identified by its item_id.
    */
   fetch(itemId: string, options?: Core.RequestOptions): Core.APIPromise<Item> {
-    return this.get(`/items/${itemId}`, options);
+    return this._client.get(`/items/${itemId}`, options);
   }
 }
 

package/src/resources/metrics.ts

@@ -15,7 +15,7 @@ export class Metrics extends APIResource {
    * description of constructing SQL queries with examples.
    */
   create(body: MetricCreateParams, options?: Core.RequestOptions): Core.APIPromise<MetricCreateResponse> {
-    return this.post('/metrics', { body, ...options });
+    return this._client.post('/metrics', { body, ...options });
   }
 
   /**
@@ -35,7 +35,7 @@ export class Metrics extends APIResource {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
-    return this.getAPIList('/metrics', MetricListResponsesPage, { query, ...options });
+    return this._client.getAPIList('/metrics', MetricListResponsesPage, { query, ...options });
   }
 
   /**
@@ -43,7 +43,7 @@ export class Metrics extends APIResource {
    * information about the metrics including its name, description, and item.
    */
   fetch(metricId: string, options?: Core.RequestOptions): Core.APIPromise<MetricFetchResponse> {
-    return this.get(`/metrics/${metricId}`, options);
+    return this._client.get(`/metrics/${metricId}`, options);
   }
 }
 
@@ -66,6 +66,10 @@ export interface MetricCreateResponse {
    */
   item: ItemsAPI.Item;
 
+  /**
+   * User specified key-value pairs. If not provided, this defaults to an empty
+   * dictionary.
+   */
   metadata: Record<string, string>;
 
   name: string;
@@ -90,6 +94,10 @@ export interface MetricListResponse {
    */
   item: ItemsAPI.Item;
 
+  /**
+   * User specified key-value pairs. If not provided, this defaults to an empty
+   * dictionary.
+   */
   metadata: Record<string, string>;
 
   name: string;
@@ -114,6 +122,10 @@ export interface MetricFetchResponse {
    */
   item: ItemsAPI.Item;
 
+  /**
+   * User specified key-value pairs. If not provided, this defaults to an empty
+   * dictionary.
+   */
   metadata: Record<string, string>;
 
   name: string;
@@ -143,10 +155,9 @@ export interface MetricCreateParams {
   sql: string;
 
   /**
-   * User-specified key value pairs, often useful for referencing internal resources
-   * or IDs. Returned as-is in the metric resource.
+   * User-specified key/value pairs for the resource.
    */
-  metadata?: unknown | null;
+  metadata?: Record<string, string | null> | null;
 }
 
 export interface MetricListParams extends PageParams {

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

@@ -35,7 +35,7 @@ export class ExternalPlanID extends APIResource {
     if (isRequestOptions(body)) {
       return this.update(otherExternalPlanId, {}, body);
     }
-    return this.put(`/plans/external_plan_id/${otherExternalPlanId}`, { body, ...options });
+    return this._client.put(`/plans/external_plan_id/${otherExternalPlanId}`, { body, ...options });
   }
 
   /**
@@ -53,7 +53,7 @@ export class ExternalPlanID extends APIResource {
    * [Price schema](../guides/concepts#plan-and-price). "
    */
   fetch(externalPlanId: string, options?: Core.RequestOptions): Core.APIPromise<PlansAPI.Plan> {
-    return this.get(`/plans/external_plan_id/${externalPlanId}`, options);
+    return this._client.get(`/plans/external_plan_id/${externalPlanId}`, options);
   }
 }
 
@@ -65,7 +65,10 @@ export interface ExternalPlanIDUpdateParams {
    */
   external_plan_id?: string | null;
 
-  metadata?: unknown | null;
+  /**
+   * User-specified key/value pairs for the resource.
+   */
+  metadata?: Record<string, string | null> | null;
 }
 
 export namespace ExternalPlanID {

package/src/resources/plans/plans.ts

@@ -10,13 +10,13 @@ import * as PricesAPI from "../prices/prices";
 import { Page, type PageParams } from "../../pagination";
 
 export class Plans extends APIResource {
-  externalPlanId: ExternalPlanIDAPI.ExternalPlanID = new ExternalPlanIDAPI.ExternalPlanID(this.client);
+  externalPlanId: ExternalPlanIDAPI.ExternalPlanID = new ExternalPlanIDAPI.ExternalPlanID(this._client);
 
   /**
    * This endpoint allows creation of plans including their prices.
    */
   create(body: PlanCreateParams, options?: Core.RequestOptions): Core.APIPromise<Plan> {
-    return this.post('/plans', { body, ...options });
+    return this._client.post('/plans', { body, ...options });
   }
 
   /**
@@ -35,7 +35,7 @@ export class Plans extends APIResource {
     if (isRequestOptions(body)) {
       return this.update(planId, {}, body);
     }
-    return this.put(`/plans/${planId}`, { body, ...options });
+    return this._client.put(`/plans/${planId}`, { body, ...options });
   }
 
   /**
@@ -54,7 +54,7 @@ export class Plans extends APIResource {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
-    return this.getAPIList('/plans', PlansPage, { query, ...options });
+    return this._client.getAPIList('/plans', PlansPage, { query, ...options });
   }
 
   /**
@@ -77,7 +77,7 @@ export class Plans extends APIResource {
    * the serialized prices refer to all prices across all phases.
    */
   fetch(planId: string, options?: Core.RequestOptions): Core.APIPromise<Plan> {
-    return this.get(`/plans/${planId}`, options);
+    return this._client.get(`/plans/${planId}`, options);
   }
 }
 
@@ -135,7 +135,11 @@ export interface Plan {
 
   maximum_amount: string | null;
 
-  metadata: unknown;
+  /**
+   * User specified key-value pairs. If not provided, this defaults to an empty
+   * dictionary.
+   */
+  metadata: Record<string, string>;
 
   minimum: Plan.Minimum | null;
 
@@ -316,7 +320,10 @@ export interface PlanCreateParams {
 
   external_plan_id?: string | null;
 
-  metadata?: unknown | null;
+  /**
+   * User-specified key/value pairs for the resource.
+   */
+  metadata?: Record<string, string | null> | null;
 
   /**
    * The net terms determines the difference between the invoice date and the issue
@@ -1127,7 +1134,10 @@ export interface PlanUpdateParams {
    */
   external_plan_id?: string | null;
 
-  metadata?: unknown | null;
+  /**
+   * User-specified key/value pairs for the resource.
+   */
+  metadata?: Record<string, string | null> | null;
 }
 
 export interface PlanListParams extends PageParams {

package/src/resources/prices/external-price-id.ts

@@ -11,6 +11,6 @@ export class ExternalPriceID extends APIResource {
    * external price aliases.
    */
   fetch(externalPriceId: string, options?: Core.RequestOptions): Core.APIPromise<PricesAPI.Price> {
-    return this.get(`/prices/external_price_id/${externalPriceId}`, options);
+    return this._client.get(`/prices/external_price_id/${externalPriceId}`, options);
   }
 }

package/src/resources/prices/prices.ts

@@ -9,7 +9,7 @@ import * as ExternalPriceIDAPI from "./external-price-id";
 import { Page, type PageParams } from "../../pagination";
 
 export class Prices extends APIResource {
-  externalPriceId: ExternalPriceIDAPI.ExternalPriceID = new ExternalPriceIDAPI.ExternalPriceID(this.client);
+  externalPriceId: ExternalPriceIDAPI.ExternalPriceID = new ExternalPriceIDAPI.ExternalPriceID(this._client);
 
   /**
    * This endpoint is used to create a [price](../reference/price). A price created
@@ -24,7 +24,7 @@ export class Prices extends APIResource {
    * price model configurations possible in this endpoint.
    */
   create(body: PriceCreateParams, options?: Core.RequestOptions): Core.APIPromise<Price> {
-    return this.post('/prices', { body, ...options });
+    return this._client.post('/prices', { body, ...options });
   }
 
   /**
@@ -40,14 +40,14 @@ export class Prices extends APIResource {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
-    return this.getAPIList('/prices', PricesPage, { query, ...options });
+    return this._client.getAPIList('/prices', PricesPage, { query, ...options });
   }
 
   /**
    * This endpoint returns a price given an identifier.
    */
   fetch(priceId: string, options?: Core.RequestOptions): Core.APIPromise<Price> {
-    return this.get(`/prices/${priceId}`, options);
+    return this._client.get(`/prices/${priceId}`, options);
   }
 }