orb-billing 1.24.2 → 1.26.0

package/src/resources/events/events.ts

@@ -2,7 +2,6 @@
 
 import * as Core from "../../core";
 import { APIResource } from "../../resource";
-import { isRequestOptions } from "../../core";
 import * as EventsAPI from "./events";
 import * as BackfillsAPI from "./backfills";
 
@@ -26,7 +25,7 @@ export class Events extends APIResource {
    * event in cases where you need to:
    *
    * - update an event with new metadata as you iterate on your pricing model
-   * - update an event based on the result of an external API call (ex. call to a
+   * - update an event based on the result of an external API call (e.g. call to a
    *   payment gateway succeeded or failed)
    *
    * This amendment API is always audit-safe. The process will still retain the
@@ -74,7 +73,7 @@ export class Events extends APIResource {
    * event in cases where you need to:
    *
    * - no longer bill for an event that was improperly reported
-   * - no longer bill for an event based on the result of an external API call (ex.
+   * - no longer bill for an event based on the result of an external API call (e.g.
    *   call to a payment gateway failed and the user should not be billed)
    *
    * If you want to only change specific properties of an event, but keep the event
@@ -323,46 +322,14 @@ export class Events extends APIResource {
    *
    * - `event_ids`: This is an explicit array of IDs to filter by. Note that an
    *   event's ID is the `idempotency_key` that was originally used for ingestion.
-   * - `invoice_id`: This is an issued Orb invoice ID (see also
-   *   [List Invoices](list-invoices)). Orb will fetch all events that were used to
-   *   calculate the invoice. In the common case, this will be a list of events whose
-   *   `timestamp` property falls within the billing period specified by the invoice.
    *
    * By default, Orb does not return _deprecated_ events in this endpoint.
    *
    * By default, Orb will not throw a `404` if no events matched, Orb will return an
    * empty array for `data` instead.
    */
-  search(params?: EventSearchParams, options?: Core.RequestOptions): Core.APIPromise<EventSearchResponse>;
-  search(options?: Core.RequestOptions): Core.APIPromise<EventSearchResponse>;
-  search(
-    params: EventSearchParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<EventSearchResponse> {
-    if (isRequestOptions(params)) {
-      return this.search({}, params);
-    }
-    const {
-      cursor,
-      limit,
-      'timestamp[gt]': timestampGt,
-      'timestamp[gte]': timestampGte,
-      'timestamp[lt]': timestampLt,
-      'timestamp[lte]': timestampLte,
-      ...body
-    } = params;
-    return this.post('/events/search', {
-      query: {
-        cursor,
-        limit,
-        'timestamp[gt]': timestampGt,
-        'timestamp[gte]': timestampGte,
-        'timestamp[lt]': timestampLt,
-        'timestamp[lte]': timestampLte,
-      },
-      body,
-      ...options,
-    });
+  search(body: EventSearchParams, options?: Core.RequestOptions): Core.APIPromise<EventSearchResponse> {
+    return this.post('/events/search', { body, ...options });
   }
 }
 
@@ -421,8 +388,6 @@ export namespace EventIngestResponse {
 
 export interface EventSearchResponse {
   data: Array<EventSearchResponse.Data>;
-
-  pagination_metadata: EventSearchResponse.PaginationMetadata;
 }
 
 export namespace EventSearchResponse {
@@ -469,12 +434,6 @@ export namespace EventSearchResponse {
      */
     timestamp: string;
   }
-
-  export interface PaginationMetadata {
-    has_more: boolean;
-
-    next_cursor: string | null;
-  }
 }
 
 export interface EventUpdateParams {
@@ -569,50 +528,11 @@ export namespace EventIngestParams {
 
 export interface EventSearchParams {
   /**
-   * Query param: Cursor for pagination. This can be populated by the `next_cursor`
-   * value returned from the initial request.
-   */
-  cursor?: string | null;
-
-  /**
-   * Query param: The number of items to fetch. Defaults to 20.
-   */
-  limit?: number;
-
-  /**
-   * Query param:
-   */
-  'timestamp[gt]'?: string | null;
-
-  /**
-   * Query param:
-   */
-  'timestamp[gte]'?: string | null;
-
-  /**
-   * Query param:
-   */
-  'timestamp[lt]'?: string | null;
-
-  /**
-   * Query param:
-   */
-  'timestamp[lte]'?: string | null;
-
-  /**
-   * Body param: This is an explicit array of IDs to filter by. Note that an event's
-   * ID is the idempotency_key that was originally used for ingestion. Values in this
-   * array will be treated case sensitively.
-   */
-  event_ids?: Array<string> | null;
-
-  /**
-   * Body param: This is an issued Orb invoice ID (see also List Invoices). Orb will
-   * fetch all events that were used to calculate the invoice. In the common case,
-   * this will be a list of events whose timestamp property falls within the billing
-   * period specified by the invoice.
+   * This is an explicit array of IDs to filter by. Note that an event's ID is the
+   * idempotency_key that was originally used for ingestion. Values in this array
+   * will be treated case sensitively.
    */
-  invoice_id?: string | null;
+  event_ids: Array<string>;
 }
 
 export namespace Events {

package/src/resources/index.ts

@@ -37,7 +37,7 @@ export {
   InvoiceLineItemCreateParams,
   InvoiceLineItems,
 } from './invoice-line-items';
-export { ItemListResponse, ItemFetchResponse, ItemListParams, ItemListResponsesPage, Items } from './items';
+export { Item, ItemCreateParams, ItemListParams, ItemsPage, Items } from './items';
 export {
   MetricCreateResponse,
   MetricListResponse,

package/src/resources/items.ts

@@ -7,51 +7,55 @@ import * as ItemsAPI from "./items";
 import { Page, type PageParams } from "../pagination";
 
 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 });
+  }
+
   /**
    * This endpoint returns a list of all Items, ordered in descending order by
    * creation time.
    */
-  list(
-    query?: ItemListParams,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<ItemListResponsesPage, ItemListResponse>;
-  list(options?: Core.RequestOptions): Core.PagePromise<ItemListResponsesPage, ItemListResponse>;
+  list(query?: ItemListParams, options?: Core.RequestOptions): Core.PagePromise<ItemsPage, Item>;
+  list(options?: Core.RequestOptions): Core.PagePromise<ItemsPage, Item>;
   list(
     query: ItemListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<ItemListResponsesPage, ItemListResponse> {
+  ): Core.PagePromise<ItemsPage, Item> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
-    return this.getAPIList('/items', ItemListResponsesPage, { query, ...options });
+    return this.getAPIList('/items', ItemsPage, { query, ...options });
   }
 
   /**
    * This endpoint returns an item identified by its item_id.
    */
-  fetch(itemId: string, options?: Core.RequestOptions): Core.APIPromise<ItemFetchResponse> {
+  fetch(itemId: string, options?: Core.RequestOptions): Core.APIPromise<Item> {
     return this.get(`/items/${itemId}`, options);
   }
 }
 
-export class ItemListResponsesPage extends Page<ItemListResponse> {}
+export class ItemsPage extends Page<Item> {}
 
 /**
  * The Item resource represents a sellable product or good. Items are associated
  * with all line items, billable metrics, and prices and are used for defining
  * external sync behavior for invoices and tax calculation purposes.
  */
-export interface ItemListResponse {
+export interface Item {
   id: string;
 
   created_at: string;
 
-  external_connections: Array<ItemListResponse.ExternalConnection>;
+  external_connections: Array<Item.ExternalConnection>;
 
   name: string;
 }
 
-export namespace ItemListResponse {
+export namespace Item {
   export interface ExternalConnection {
     external_connection_name:
       | 'stripe'
@@ -66,41 +70,18 @@ export namespace ItemListResponse {
   }
 }
 
-/**
- * The Item resource represents a sellable product or good. Items are associated
- * with all line items, billable metrics, and prices and are used for defining
- * external sync behavior for invoices and tax calculation purposes.
- */
-export interface ItemFetchResponse {
-  id: string;
-
-  created_at: string;
-
-  external_connections: Array<ItemFetchResponse.ExternalConnection>;
-
+export interface ItemCreateParams {
+  /**
+   * The name of the item.
+   */
   name: string;
 }
 
-export namespace ItemFetchResponse {
-  export interface ExternalConnection {
-    external_connection_name:
-      | 'stripe'
-      | 'quickbooks'
-      | 'bill.com'
-      | 'netsuite'
-      | 'taxjar'
-      | 'avalara'
-      | 'anrok';
-
-    external_entity_id: string;
-  }
-}
-
 export interface ItemListParams extends PageParams {}
 
 export namespace Items {
-  export import ItemListResponse = ItemsAPI.ItemListResponse;
-  export import ItemFetchResponse = ItemsAPI.ItemFetchResponse;
-  export import ItemListResponsesPage = ItemsAPI.ItemListResponsesPage;
+  export import Item = ItemsAPI.Item;
+  export import ItemsPage = ItemsAPI.ItemsPage;
+  export import ItemCreateParams = ItemsAPI.ItemCreateParams;
   export import ItemListParams = ItemsAPI.ItemListParams;
 }

package/src/resources/metrics.ts

@@ -4,6 +4,7 @@ import * as Core from "../core";
 import { APIResource } from "../resource";
 import { isRequestOptions } from "../core";
 import * as MetricsAPI from "./metrics";
+import * as ItemsAPI from "./items";
 import { Page, type PageParams } from "../pagination";
 
 export class Metrics extends APIResource {
@@ -63,7 +64,7 @@ export interface MetricCreateResponse {
    * with all line items, billable metrics, and prices and are used for defining
    * external sync behavior for invoices and tax calculation purposes.
    */
-  item: MetricCreateResponse.Item;
+  item: ItemsAPI.Item;
 
   metadata: Record<string, string>;
 
@@ -72,38 +73,6 @@ export interface MetricCreateResponse {
   status: 'active' | 'draft' | 'archived';
 }
 
-export namespace MetricCreateResponse {
-  /**
-   * The Item resource represents a sellable product or good. Items are associated
-   * with all line items, billable metrics, and prices and are used for defining
-   * external sync behavior for invoices and tax calculation purposes.
-   */
-  export interface Item {
-    id: string;
-
-    created_at: string;
-
-    external_connections: Array<Item.ExternalConnection>;
-
-    name: string;
-  }
-
-  export namespace Item {
-    export interface ExternalConnection {
-      external_connection_name:
-        | 'stripe'
-        | 'quickbooks'
-        | 'bill.com'
-        | 'netsuite'
-        | 'taxjar'
-        | 'avalara'
-        | 'anrok';
-
-      external_entity_id: string;
-    }
-  }
-}
-
 /**
  * The Metric resource represents a calculation of a quantity based on events.
  * Metrics are defined by the query that transforms raw usage events into
@@ -119,7 +88,7 @@ export interface MetricListResponse {
    * with all line items, billable metrics, and prices and are used for defining
    * external sync behavior for invoices and tax calculation purposes.
    */
-  item: MetricListResponse.Item;
+  item: ItemsAPI.Item;
 
   metadata: Record<string, string>;
 
@@ -128,38 +97,6 @@ export interface MetricListResponse {
   status: 'active' | 'draft' | 'archived';
 }
 
-export namespace MetricListResponse {
-  /**
-   * The Item resource represents a sellable product or good. Items are associated
-   * with all line items, billable metrics, and prices and are used for defining
-   * external sync behavior for invoices and tax calculation purposes.
-   */
-  export interface Item {
-    id: string;
-
-    created_at: string;
-
-    external_connections: Array<Item.ExternalConnection>;
-
-    name: string;
-  }
-
-  export namespace Item {
-    export interface ExternalConnection {
-      external_connection_name:
-        | 'stripe'
-        | 'quickbooks'
-        | 'bill.com'
-        | 'netsuite'
-        | 'taxjar'
-        | 'avalara'
-        | 'anrok';
-
-      external_entity_id: string;
-    }
-  }
-}
-
 /**
  * The Metric resource represents a calculation of a quantity based on events.
  * Metrics are defined by the query that transforms raw usage events into
@@ -175,7 +112,7 @@ export interface MetricFetchResponse {
    * with all line items, billable metrics, and prices and are used for defining
    * external sync behavior for invoices and tax calculation purposes.
    */
-  item: MetricFetchResponse.Item;
+  item: ItemsAPI.Item;
 
   metadata: Record<string, string>;
 
@@ -184,38 +121,6 @@ export interface MetricFetchResponse {
   status: 'active' | 'draft' | 'archived';
 }
 
-export namespace MetricFetchResponse {
-  /**
-   * The Item resource represents a sellable product or good. Items are associated
-   * with all line items, billable metrics, and prices and are used for defining
-   * external sync behavior for invoices and tax calculation purposes.
-   */
-  export interface Item {
-    id: string;
-
-    created_at: string;
-
-    external_connections: Array<Item.ExternalConnection>;
-
-    name: string;
-  }
-
-  export namespace Item {
-    export interface ExternalConnection {
-      external_connection_name:
-        | 'stripe'
-        | 'quickbooks'
-        | 'bill.com'
-        | 'netsuite'
-        | 'taxjar'
-        | 'avalara'
-        | 'anrok';
-
-      external_entity_id: string;
-    }
-  }
-}
-
 export interface MetricCreateParams {
   /**
    * A description of the metric.

package/src/resources/subscriptions.ts

@@ -399,7 +399,7 @@ export class Subscriptions extends APIResource {
    * Orb supports invoicing for a subscription when a preconfigured usage threshold
    * is hit. To enable threshold billing, pass in an `invoicing_threshold`, which is
    * specified in the subscription's invoicing currency, when creating a
-   * subscription. Ex. pass in `10.00` to issue an invoice when usage amounts hit
+   * subscription. E.g. pass in `10.00` to issue an invoice when usage amounts hit
    * $10.00 for a subscription that invoices in USD.
    */
   create(body?: SubscriptionCreateParams, options?: Core.RequestOptions): Core.APIPromise<Subscription>;

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '1.24.2'; // x-release-please-version
+export const VERSION = '1.26.0'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "1.24.2";
+export declare const VERSION = "1.26.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '1.24.2'; // x-release-please-version
+exports.VERSION = '1.26.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '1.24.2'; // x-release-please-version
+export const VERSION = '1.26.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map