orb-billing 1.20.2 → 1.22.0

package/src/resources/items.ts

@@ -0,0 +1,106 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from "../ling/core";
+import { APIResource } from "../ling/resource";
+import { isRequestOptions } from "../ling/core";
+import * as ItemsAPI from "../ling/resources/items";
+import { Page, type PageParams } from "../ling/pagination";
+
+export class Items extends APIResource {
+  /**
+   * 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 | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<ItemListResponsesPage, ItemListResponse> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this.getAPIList('/items', ItemListResponsesPage, { query, ...options });
+  }
+
+  /**
+   * This endpoint returns an item identified by its item_id.
+   */
+  fetch(itemId: string, options?: Core.RequestOptions): Core.APIPromise<ItemFetchResponse> {
+    return this.get(`/items/${itemId}`, options);
+  }
+}
+
+export class ItemListResponsesPage extends Page<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 ItemListResponse {
+  id: string;
+
+  created_at: string;
+
+  external_connections: Array<ItemListResponse.ExternalConnection>;
+
+  name: string;
+}
+
+export namespace ItemListResponse {
+  export interface ExternalConnection {
+    external_connection_name:
+      | 'stripe'
+      | 'quickbooks'
+      | 'bill.com'
+      | 'netsuite'
+      | 'taxjar'
+      | 'avalara'
+      | 'anrok';
+
+    external_entity_id: string;
+  }
+}
+
+/**
+ * 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>;
+
+  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 ItemListParams = ItemsAPI.ItemListParams;
+}

package/src/resources/metrics.ts

@@ -0,0 +1,264 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from "../ling/core";
+import { APIResource } from "../ling/resource";
+import { isRequestOptions } from "../ling/core";
+import * as MetricsAPI from "../ling/resources/metrics";
+import { Page, type PageParams } from "../ling/pagination";
+
+export class Metrics extends APIResource {
+  /**
+   * This endpoint is used to create a [metric](../guides/concepts##metric) using a
+   * SQL string. See
+   * [SQL support](../guides/extensibility/advanced-metrics#sql-support) for a
+   * description of constructing SQL queries with examples.
+   */
+  create(body: MetricCreateParams, options?: Core.RequestOptions): Core.APIPromise<MetricCreateResponse> {
+    return this.post('/metrics', { body, ...options });
+  }
+
+  /**
+   * This endpoint is used to fetch [metric](../guides/concepts#metric) details given
+   * a metric identifier. It returns information about the metrics including its
+   * name, description, and item.
+   */
+  list(
+    query?: MetricListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<MetricListResponsesPage, MetricListResponse>;
+  list(options?: Core.RequestOptions): Core.PagePromise<MetricListResponsesPage, MetricListResponse>;
+  list(
+    query: MetricListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<MetricListResponsesPage, MetricListResponse> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this.getAPIList('/metrics', MetricListResponsesPage, { query, ...options });
+  }
+
+  /**
+   * This endpoint is used to list [metrics](../guides/concepts##metric). It returns
+   * 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);
+  }
+}
+
+export class MetricListResponsesPage extends Page<MetricListResponse> {}
+
+/**
+ * The Metric resource represents a calculation of a quantity based on events.
+ * Metrics are defined by the query that transforms raw usage events into
+ * meaningful values for your customers.
+ */
+export interface MetricCreateResponse {
+  id: string;
+
+  description: string | null;
+
+  /**
+   * 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.
+   */
+  item: MetricCreateResponse.Item;
+
+  metadata: Record<string, string>;
+
+  name: string;
+
+  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
+ * meaningful values for your customers.
+ */
+export interface MetricListResponse {
+  id: string;
+
+  description: string | null;
+
+  /**
+   * 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.
+   */
+  item: MetricListResponse.Item;
+
+  metadata: Record<string, string>;
+
+  name: string;
+
+  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
+ * meaningful values for your customers.
+ */
+export interface MetricFetchResponse {
+  id: string;
+
+  description: string | null;
+
+  /**
+   * 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.
+   */
+  item: MetricFetchResponse.Item;
+
+  metadata: Record<string, string>;
+
+  name: string;
+
+  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.
+   */
+  description: string | null;
+
+  /**
+   * The id of the item
+   */
+  item_id: string;
+
+  /**
+   * The name of the metric.
+   */
+  name: string;
+
+  /**
+   * A sql string defining the metric.
+   */
+  sql: string;
+
+  /**
+   * User-specified key value pairs, often useful for referencing internal resources
+   * or IDs. Returned as-is in the metric resource.
+   */
+  metadata?: unknown | null;
+}
+
+export interface MetricListParams extends PageParams {
+  'created_at[gt]'?: string | null;
+
+  'created_at[gte]'?: string | null;
+
+  'created_at[lt]'?: string | null;
+
+  'created_at[lte]'?: string | null;
+}
+
+export namespace Metrics {
+  export import MetricCreateResponse = MetricsAPI.MetricCreateResponse;
+  export import MetricListResponse = MetricsAPI.MetricListResponse;
+  export import MetricFetchResponse = MetricsAPI.MetricFetchResponse;
+  export import MetricListResponsesPage = MetricsAPI.MetricListResponsesPage;
+  export import MetricCreateParams = MetricsAPI.MetricCreateParams;
+  export import MetricListParams = MetricsAPI.MetricListParams;
+}

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

@@ -0,0 +1,73 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from "../../ling/core";
+import { APIResource } from "../../ling/resource";
+import { isRequestOptions } from "../../ling/core";
+import * as ExternalPlanIDAPI from "../../ling/resources/plans/external-plan-id";
+import * as PlansAPI from "../../ling/resources/plans/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.
+   *
+   * ## 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).
+   */
+  update(
+    otherExternalPlanId: string,
+    body?: ExternalPlanIDUpdateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<PlansAPI.Plan>;
+  update(otherExternalPlanId: string, options?: Core.RequestOptions): Core.APIPromise<PlansAPI.Plan>;
+  update(
+    otherExternalPlanId: string,
+    body: ExternalPlanIDUpdateParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<PlansAPI.Plan> {
+    if (isRequestOptions(body)) {
+      return this.update(otherExternalPlanId, {}, body);
+    }
+    return this.put(`/plans/external_plan_id/${otherExternalPlanId}`, { body, ...options });
+  }
+
+  /**
+   * 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.
+   *
+   * ## 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). "
+   */
+  fetch(externalPlanId: string, options?: Core.RequestOptions): Core.APIPromise<PlansAPI.Plan> {
+    return this.get(`/plans/external_plan_id/${externalPlanId}`, options);
+  }
+}
+
+export interface ExternalPlanIDUpdateParams {
+  /**
+   * An optional user-defined ID for this plan resource, used throughout the system
+   * as an alias for this Plan. Use this field to identify a plan by an existing
+   * identifier in your system.
+   */
+  external_plan_id?: string | null;
+
+  metadata?: unknown | null;
+}
+
+export namespace ExternalPlanID {
+  export import ExternalPlanIDUpdateParams = ExternalPlanIDAPI.ExternalPlanIDUpdateParams;
+}

package/src/resources/plans/index.ts

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless.
+
+export { ExternalPlanIDUpdateParams, ExternalPlanID } from './external-plan-id';
+export { Plan, PlanCreateParams, PlanUpdateParams, PlanListParams, PlansPage, Plans } from './plans';