orb-billing 4.74.0 → 5.0.0

package/resources/prices/prices.mjs

@@ -1,9 +1,9 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 import { APIResource } from "../../resource.mjs";
 import { isRequestOptions } from "../../core.mjs";
+import { PricesPage } from "../shared.mjs";
 import * as ExternalPriceIDAPI from "./external-price-id.mjs";
 import { ExternalPriceID } from "./external-price-id.mjs";
-import { Page } from "../../pagination.mjs";
 export class Prices extends APIResource {
     constructor() {
         super(...arguments);
@@ -70,23 +70,14 @@ export class Prices extends APIResource {
     }
     /**
      * This endpoint is used to evaluate the output of price(s) for a given customer
-     * and time range over either ingested events or preview events. It enables
-     * filtering and grouping the output using
+     * and time range over ingested events. It enables filtering and grouping the
+     * output using
      * [computed properties](/extensibility/advanced-metrics#computed-properties),
      * supporting the following workflows:
      *
      * 1. Showing detailed usage and costs to the end customer.
      * 2. Auditing subtotals on invoice line items.
      *
-     * Prices may either reference existing prices in your Orb account or be defined
-     * inline in the request body. Up to 100 prices can be evaluated in a single
-     * request.
-     *
-     * Price evaluation by default uses ingested events, but you can also provide a
-     * list of preview events to use instead. Up to 500 preview events can be provided
-     * in a single request. When using ingested events, the start of the time range
-     * must be no more than 100 days ago.
-     *
      * For these workflows, the expressiveness of computed properties in both the
      * filters and grouping is critical. For example, if you'd like to show your
      * customer their usage grouped by hour and another property, you can do so with
@@ -96,13 +87,44 @@ export class Prices extends APIResource {
      * with the following `filter`:
      * `my_property = 'foo' AND my_other_property = 'bar'`.
      *
-     * The length of the results must be no greater than 1000. Note that this is a POST
-     * endpoint rather than a GET endpoint because it employs a JSON body rather than
-     * query parameters.
+     * Prices may either reference existing prices in your Orb account or be defined
+     * inline in the request body. Up to 100 prices can be evaluated in a single
+     * request.
+     *
+     * Prices are evaluated on ingested events and the start of the time range must be
+     * no more than 100 days ago. To evaluate based off a set of provided events, the
+     * [evaluate preview events](/api-reference/price/evaluate-preview-events) endpoint
+     * can be used instead.
+     *
+     * Note that this is a POST endpoint rather than a GET endpoint because it employs
+     * a JSON body rather than query parameters.
      */
     evaluateMultiple(body, options) {
         return this._client.post('/prices/evaluate', { body, ...options });
     }
+    /**
+     * This endpoint evaluates prices on preview events instead of actual usage, making
+     * it ideal for building price calculators and cost estimation tools. You can
+     * filter and group results using
+     * [computed properties](/extensibility/advanced-metrics#computed-properties) to
+     * analyze pricing across different dimensions.
+     *
+     * Prices may either reference existing prices in your Orb account or be defined
+     * inline in the request body. The endpoint has the following limitations:
+     *
+     * 1. Up to 100 prices can be evaluated in a single request.
+     * 2. Up to 500 preview events can be provided in a single request.
+     *
+     * A top-level customer_id is required to evaluate the preview events.
+     * Additionally, all events without a customer_id will have the top-level
+     * customer_id added.
+     *
+     * Note that this is a POST endpoint rather than a GET endpoint because it employs
+     * a JSON body rather than query parameters.
+     */
+    evaluatePreviewEvents(body, options) {
+        return this._client.post('/prices/evaluate_preview_events', { body, ...options });
+    }
     /**
      * This endpoint returns a price given an identifier.
      */
@@ -110,8 +132,6 @@ export class Prices extends APIResource {
         return this._client.get(`/prices/${priceId}`, options);
     }
 }
-export class PricesPage extends Page {
-}
-Prices.PricesPage = PricesPage;
 Prices.ExternalPriceID = ExternalPriceID;
+export { PricesPage };
 //# sourceMappingURL=prices.mjs.map

package/resources/prices/prices.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"prices.mjs","sourceRoot":"","sources":["../../src/resources/prices/prices.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAIpB,KAAK,kBAAkB;OACvB,EAAE,eAAe,EAA+B;OAChD,EAAE,IAAI,EAAmB;AAEhC,MAAM,OAAO,MAAO,SAAQ,WAAW;IAAvC;;QACE,oBAAe,GAAuC,IAAI,kBAAkB,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA2H7G,CAAC;IAzHC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAuB,EAAE,OAA6B;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,OAAe,EAAE,IAAuB,EAAE,OAA6B;QAC5E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAQD,IAAI,CACF,QAA+C,EAAE,EACjD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,SAAS,EAAE,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,QAAQ,CACN,OAAe,EACf,IAAyB,EACzB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,OAAO,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,gBAAgB,CACd,IAAiC,EACjC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAe,EAAE,OAA6B;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;CACF;AAED,MAAM,OAAO,UAAW,SAAQ,IAAW;CAAG;AAw1b9C,MAAM,CAAC,UAAU,GAAG,UAAU,CAAC;AAC/B,MAAM,CAAC,eAAe,GAAG,eAAe,CAAC"}
+{"version":3,"file":"prices.mjs","sourceRoot":"","sources":["../../src/resources/prices/prices.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAIpB,EAAE,UAAU,EAAE;OACd,KAAK,kBAAkB;OACvB,EAAE,eAAe,EAA+B;AAGvD,MAAM,OAAO,MAAO,SAAQ,WAAW;IAAvC;;QACE,oBAAe,GAAuC,IAAI,kBAAkB,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAyJ7G,CAAC;IAvJC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAuB,EAAE,OAA6B;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED;;;;OAIG;IACH,MAAM,CACJ,OAAe,EACf,IAAuB,EACvB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAQD,IAAI,CACF,QAA+C,EAAE,EACjD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,SAAS,EAAE,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,QAAQ,CACN,OAAe,EACf,IAAyB,EACzB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,OAAO,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,gBAAgB,CACd,IAAiC,EACjC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,qBAAqB,CACnB,IAAsC,EACtC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iCAAiC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAe,EAAE,OAA6B;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;CACF;AA4wFD,MAAM,CAAC,eAAe,GAAG,eAAe,CAAC;AAsBzC,OAAO,EAAE,UAAU,EAAE,CAAC"}