orb-billing 5.48.0 → 5.75.1

package/resources/events/events.mjs

@@ -61,6 +61,15 @@ export class Events extends APIResource {
      * - By default, no more than 100 events can be amended for a single customer in a
      *   100 day period. For higher volume updates, consider using the
      *   [event backfill](create-backfill) endpoint.
+     *
+     * @example
+     * ```ts
+     * const event = await client.events.update('event_id', {
+     *   event_name: 'event_name',
+     *   properties: { foo: 'bar' },
+     *   timestamp: '2020-12-09T16:09:53Z',
+     * });
+     * ```
      */
     update(eventId, body, options) {
         return this._client.put(`/events/${eventId}`, { body, ...options });
@@ -106,6 +115,11 @@ export class Events extends APIResource {
      * - By default, no more than 100 events can be deprecated for a single customer in
      *   a 100 day period. For higher volume updates, consider using the
      *   [event backfill](create-backfill) endpoint.
+     *
+     * @example
+     * ```ts
+     * const response = await client.events.deprecate('event_id');
+     * ```
      */
     deprecate(eventId, options) {
         return this._client.put(`/events/${eventId}/deprecate`, options);
@@ -226,8 +240,8 @@ export class Events extends APIResource {
      * billed for in the corresponding billing period.
      *
      * In general, Orb does not expect events with future dated timestamps. In cases
-     * where the timestamp is at least 24 hours ahead of the current time, the event
-     * will not be accepted as a valid event, and will throw validation errors.
+     * where the timestamp is 5 minutes ahead of the current time, the event will not
+     * be accepted as a valid event, and will throw validation errors.
      *
      * ## Event validation
      *
@@ -242,9 +256,9 @@ export class Events extends APIResource {
      * - If the `external_customer_id` is specified, the customer in Orb does not need
      *   to exist. Events will be attributed to any future customers with the
      *   `external_customer_id` on subscription creation.
-     * - `timestamp` must conform to ISO 8601 and represent a timestamp at most 1 hour
-     *   in the future. This timestamp should be sent in UTC timezone (no timezone
-     *   offset).
+     * - `timestamp` must conform to ISO 8601 and represent a timestamp at most 5
+     *   minutes in the future. This timestamp should be sent in UTC timezone (no
+     *   timezone offset).
      *
      * ## Idempotency and retry semantics
      *
@@ -281,39 +295,26 @@ export class Events extends APIResource {
      * request payload size, but please give us a heads up if you’re changing either of
      * these factors by an order of magnitude from initial setup.
      *
-     * ## Testing in debug mode
-     *
-     * The ingestion API supports a debug mode, which returns additional verbose output
-     * to indicate which event idempotency keys were newly ingested or duplicates from
-     * previous requests. To enable this mode, mark `debug=true` as a query parameter.
-     *
-     * If `debug=true` is not specified, the response will only contain
-     * `validation_failed`. Orb will still honor the idempotency guarantees set
-     * [here](/events-and-metrics/event-ingestion#event-volume-and-concurrency) in all
-     * cases.
-     *
-     * We strongly recommend that you only use debug mode as part of testing your
-     * initial Orb integration. Once you're ready to switch to production, disable
-     * debug mode to take advantage of improved performance and maximal throughput.
-     *
-     * #### Example: ingestion response with `debug=true`
+     * #### Example: ingestion response
      *
      * ```json
      * {
-     *   "debug": {
-     *     "duplicate": [],
-     *     "ingested": ["B7E83HDMfJPAunXW", "SJs5DQJ3TnwSqEZE", "8SivfDsNKwCeAXim"]
-     *   },
      *   "validation_failed": []
      * }
      * ```
      *
-     * #### Example: ingestion response with `debug=false`
-     *
-     * ```json
-     * {
-     *   "validation_failed": []
-     * }
+     * @example
+     * ```ts
+     * const response = await client.events.ingest({
+     *   events: [
+     *     {
+     *       event_name: 'event_name',
+     *       idempotency_key: 'idempotency_key',
+     *       properties: { foo: 'bar' },
+     *       timestamp: '2020-12-09T16:09:53Z',
+     *     },
+     *   ],
+     * });
      * ```
      */
     ingest(params, options) {
@@ -336,6 +337,13 @@ export class Events extends APIResource {
      *
      * By default, Orb will not throw a `404` if no events matched, Orb will return an
      * empty array for `data` instead.
+     *
+     * @example
+     * ```ts
+     * const response = await client.events.search({
+     *   event_ids: ['string'],
+     * });
+     * ```
      */
     search(body, options) {
         return this._client.post('/events/search', { body, ...options });

package/resources/events/events.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"events.mjs","sourceRoot":"","sources":["../../src/resources/events/events.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,KAAK,YAAY;OACjB,EAOL,yBAAyB,EAEzB,SAAS,GACV;OACM,KAAK,SAAS;OACd,EAAgB,MAAM,EAAoB;AAEjD;;;;GAIG;AACH,MAAM,OAAO,MAAO,SAAQ,WAAW;IAAvC;;QACE,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7E,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA8UhE,CAAC;IA5UC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;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;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,SAAS,CAAC,OAAe,EAAE,OAA6B;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,OAAO,YAAY,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6MG;IACH,MAAM,CAAC,MAAyB,EAAE,OAA6B;QAC7D,MAAM,EAAE,WAAW,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAAuB,EAAE,OAA6B;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;CACF;AA6ND,MAAM,CAAC,SAAS,GAAG,SAAS,CAAC;AAC7B,MAAM,CAAC,yBAAyB,GAAG,yBAAyB,CAAC;AAC7D,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC"}
+{"version":3,"file":"events.mjs","sourceRoot":"","sources":["../../src/resources/events/events.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,KAAK,YAAY;OACjB,EAOL,yBAAyB,EAEzB,SAAS,GACV;OACM,KAAK,SAAS;OACd,EAAgB,MAAM,EAAoB;AAEjD;;;;GAIG;AACH,MAAM,OAAO,MAAO,SAAQ,WAAW;IAAvC;;QACE,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7E,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAsVhE,CAAC;IApVC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuDG;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;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,SAAS,CAAC,OAAe,EAAE,OAA6B;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,OAAO,YAAY,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgMG;IACH,MAAM,CAAC,MAAyB,EAAE,OAA6B;QAC7D,MAAM,EAAE,WAAW,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,MAAM,CAAC,IAAuB,EAAE,OAA6B;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;CACF;AA6ND,MAAM,CAAC,SAAS,GAAG,SAAS,CAAC;AAC7B,MAAM,CAAC,yBAAyB,GAAG,yBAAyB,CAAC;AAC7D,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC"}

package/resources/events/volume.d.ts

@@ -20,6 +20,13 @@ export declare class Volume extends APIResource {
      * where the start and end time are hour-aligned and in UTC. When a specific
      * timestamp is passed in for either start or end time, the response includes the
      * hours the timestamp falls in.
+     *
+     * @example
+     * ```ts
+     * const eventVolumes = await client.events.volume.list({
+     *   timeframe_start: '2019-12-27T18:11:19.117Z',
+     * });
+     * ```
      */
     list(query: VolumeListParams, options?: Core.RequestOptions): Core.APIPromise<EventVolumes>;
 }

package/resources/events/volume.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"volume.d.ts","sourceRoot":"","sources":["../../src/resources/events/volume.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AAEnC;;;;GAIG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;OAcG;IACH,IAAI,CAAC,KAAK,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC;CAG5F;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;CAChC;AAED,yBAAiB,YAAY,CAAC;IAC5B;;;OAGG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd,aAAa,EAAE,MAAM,CAAC;QAEtB,eAAe,EAAE,MAAM,CAAC;KACzB;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;;;OAKG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EAAE,KAAK,YAAY,IAAI,YAAY,EAAE,KAAK,gBAAgB,IAAI,gBAAgB,EAAE,CAAC;CACzF"}
+{"version":3,"file":"volume.d.ts","sourceRoot":"","sources":["../../src/resources/events/volume.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AAEnC;;;;GAIG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,IAAI,CAAC,KAAK,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC;CAG5F;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;CAChC;AAED,yBAAiB,YAAY,CAAC;IAC5B;;;OAGG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd,aAAa,EAAE,MAAM,CAAC;QAEtB,eAAe,EAAE,MAAM,CAAC;KACzB;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;;;OAKG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EAAE,KAAK,YAAY,IAAI,YAAY,EAAE,KAAK,gBAAgB,IAAI,gBAAgB,EAAE,CAAC;CACzF"}

package/resources/events/volume.js

@@ -23,6 +23,13 @@ class Volume extends resource_1.APIResource {
      * where the start and end time are hour-aligned and in UTC. When a specific
      * timestamp is passed in for either start or end time, the response includes the
      * hours the timestamp falls in.
+     *
+     * @example
+     * ```ts
+     * const eventVolumes = await client.events.volume.list({
+     *   timeframe_start: '2019-12-27T18:11:19.117Z',
+     * });
+     * ```
      */
     list(query, options) {
         return this._client.get('/events/volume', { query, ...options });

package/resources/events/volume.js.map

@@ -1 +1 @@
-{"version":3,"file":"volume.js","sourceRoot":"","sources":["../../src/resources/events/volume.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAG7C;;;;GAIG;AACH,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;;;;;;;;;;OAcG;IACH,IAAI,CAAC,KAAuB,EAAE,OAA6B;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;CACF;AAnBD,wBAmBC"}
+{"version":3,"file":"volume.js","sourceRoot":"","sources":["../../src/resources/events/volume.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAG7C;;;;GAIG;AACH,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,IAAI,CAAC,KAAuB,EAAE,OAA6B;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;CACF;AA1BD,wBA0BC"}

package/resources/events/volume.mjs

@@ -20,6 +20,13 @@ export class Volume extends APIResource {
      * where the start and end time are hour-aligned and in UTC. When a specific
      * timestamp is passed in for either start or end time, the response includes the
      * hours the timestamp falls in.
+     *
+     * @example
+     * ```ts
+     * const eventVolumes = await client.events.volume.list({
+     *   timeframe_start: '2019-12-27T18:11:19.117Z',
+     * });
+     * ```
      */
     list(query, options) {
         return this._client.get('/events/volume', { query, ...options });

package/resources/events/volume.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"volume.mjs","sourceRoot":"","sources":["../../src/resources/events/volume.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAGtB;;;;GAIG;AACH,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;OAcG;IACH,IAAI,CAAC,KAAuB,EAAE,OAA6B;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;CACF"}
+{"version":3,"file":"volume.mjs","sourceRoot":"","sources":["../../src/resources/events/volume.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAGtB;;;;GAIG;AACH,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,IAAI,CAAC,KAAuB,EAAE,OAA6B;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;CACF"}

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

@@ -22,6 +22,18 @@ export declare class InvoiceLineItems extends APIResource {
      * - If both `item_id` and `name` are provided: The item is looked up by ID for
      *   association, but the provided `name` is used for the line item (not the item's
      *   name).
+     *
+     * @example
+     * ```ts
+     * const invoiceLineItem =
+     *   await client.invoiceLineItems.create({
+     *     amount: '12.00',
+     *     end_date: '2023-09-22',
+     *     invoice_id: '4khy3nwzktxv7',
+     *     quantity: 1,
+     *     start_date: '2023-09-22',
+     *   });
+     * ```
      */
     create(body: InvoiceLineItemCreateParams, options?: Core.RequestOptions): Core.APIPromise<InvoiceLineItemCreateResponse>;
 }
@@ -40,7 +52,7 @@ export interface InvoiceLineItemCreateResponse {
      * invoice calculations (ie. usage discounts -> amount discounts -> percentage
      * discounts -> minimums -> maximums).
      */
-    adjustments: Array<Shared.MonetaryUsageDiscountAdjustment | Shared.MonetaryAmountDiscountAdjustment | Shared.MonetaryPercentageDiscountAdjustment | Shared.MonetaryMinimumAdjustment | Shared.MonetaryMaximumAdjustment>;
+    adjustments: Array<Shared.MonetaryUsageDiscountAdjustment | Shared.MonetaryAmountDiscountAdjustment | Shared.MonetaryPercentageDiscountAdjustment | InvoiceLineItemCreateResponse.MonetaryTieredPercentageDiscountAdjustment | Shared.MonetaryMinimumAdjustment | Shared.MonetaryMaximumAdjustment>;
     /**
      * The final amount for a line item after all adjustments and pre paid credits have
      * been applied.
@@ -112,6 +124,82 @@ export interface InvoiceLineItemCreateResponse {
      */
     usage_customer_ids: Array<string> | null;
 }
+export declare namespace InvoiceLineItemCreateResponse {
+    interface MonetaryTieredPercentageDiscountAdjustment {
+        id: string;
+        adjustment_type: 'tiered_percentage_discount';
+        /**
+         * The value applied by an adjustment.
+         */
+        amount: string;
+        /**
+         * @deprecated The price IDs that this adjustment applies to.
+         */
+        applies_to_price_ids: Array<string>;
+        /**
+         * The filters that determine which prices to apply this adjustment to.
+         */
+        filters: Array<MonetaryTieredPercentageDiscountAdjustment.Filter>;
+        /**
+         * True for adjustments that apply to an entire invoice, false for adjustments that
+         * apply to only one price.
+         */
+        is_invoice_level: boolean;
+        /**
+         * The reason for the adjustment.
+         */
+        reason: string | null;
+        /**
+         * The adjustment id this adjustment replaces. This adjustment will take the place
+         * of the replaced adjustment in plan version migrations.
+         */
+        replaces_adjustment_id: string | null;
+        /**
+         * The ordered, contiguous bands of cumulative eligible spend, each discounted at
+         * its own percentage (progressive fill-a-tier), applied to the prices this
+         * adjustment covers in a given billing period.
+         */
+        tiers: Array<MonetaryTieredPercentageDiscountAdjustment.Tier>;
+    }
+    namespace MonetaryTieredPercentageDiscountAdjustment {
+        interface Filter {
+            /**
+             * The property of the price to filter on.
+             */
+            field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
+            /**
+             * Should prices that match the filter be included or excluded.
+             */
+            operator: 'includes' | 'excludes';
+            /**
+             * The IDs or values that match this filter.
+             */
+            values: Array<string>;
+        }
+        /**
+         * One band of a tiered percentage discount. Bounds are denominated in the
+         * discount's currency. `lower_bound` is the exclusive start of the band and
+         * `upper_bound` is the inclusive end; `upper_bound` is null only for the
+         * open-ended final tier.
+         */
+        interface Tier {
+            /**
+             * Exclusive lower bound of cumulative spend for this tier.
+             */
+            lower_bound: number;
+            /**
+             * The percentage (between 0 and 1) discounted from spend that falls within this
+             * tier.
+             */
+            percentage: number;
+            /**
+             * Inclusive upper bound of cumulative spend for this tier; null for the final
+             * open-ended tier.
+             */
+            upper_bound?: number | null;
+        }
+    }
+}
 export interface InvoiceLineItemCreateParams {
     /**
      * The total amount in the invoice's currency to add to the line item.

package/resources/invoice-line-items.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"invoice-line-items.d.ts","sourceRoot":"","sources":["../src/resources/invoice-line-items.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AAEnC;;;;;GAKG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,6BAA6B,CAAC;CAGlD;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;;;OAIG;IACH,WAAW,EAAE,KAAK,CACd,MAAM,CAAC,+BAA+B,GACtC,MAAM,CAAC,gCAAgC,GACvC,MAAM,CAAC,oCAAoC,GAC3C,MAAM,CAAC,yBAAyB,GAChC,MAAM,CAAC,yBAAyB,CACnC,CAAC;IAEF;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,yBAAyB,EAAE,MAAM,CAAC;IAElC;;;;;;;;;;;OAWG;IACH,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC;IAEpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,cAAc,EAAE,KAAK,CAAC,MAAM,CAAC,iBAAiB,GAAG,MAAM,CAAC,eAAe,GAAG,MAAM,CAAC,gBAAgB,CAAC,CAAC;IAEnG;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAErC;;OAEG;IACH,kBAAkB,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;CAC1C;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;;;;;;OAOG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}
+{"version":3,"file":"invoice-line-items.d.ts","sourceRoot":"","sources":["../src/resources/invoice-line-items.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AAEnC;;;;;GAKG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,MAAM,CACJ,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,6BAA6B,CAAC;CAGlD;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;;;OAIG;IACH,WAAW,EAAE,KAAK,CACd,MAAM,CAAC,+BAA+B,GACtC,MAAM,CAAC,gCAAgC,GACvC,MAAM,CAAC,oCAAoC,GAC3C,6BAA6B,CAAC,0CAA0C,GACxE,MAAM,CAAC,yBAAyB,GAChC,MAAM,CAAC,yBAAyB,CACnC,CAAC;IAEF;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,yBAAyB,EAAE,MAAM,CAAC;IAElC;;;;;;;;;;;OAWG;IACH,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC;IAEpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,cAAc,EAAE,KAAK,CAAC,MAAM,CAAC,iBAAiB,GAAG,MAAM,CAAC,eAAe,GAAG,MAAM,CAAC,gBAAgB,CAAC,CAAC;IAEnG;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAErC;;OAEG;IACH,kBAAkB,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;CAC1C;AAED,yBAAiB,6BAA6B,CAAC;IAC7C,UAAiB,0CAA0C;QACzD,EAAE,EAAE,MAAM,CAAC;QAEX,eAAe,EAAE,4BAA4B,CAAC;QAE9C;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,oBAAoB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEpC;;WAEG;QACH,OAAO,EAAE,KAAK,CAAC,0CAA0C,CAAC,MAAM,CAAC,CAAC;QAElE;;;WAGG;QACH,gBAAgB,EAAE,OAAO,CAAC;QAE1B;;WAEG;QACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;;WAGG;QACH,sBAAsB,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtC;;;;WAIG;QACH,KAAK,EAAE,KAAK,CAAC,0CAA0C,CAAC,IAAI,CAAC,CAAC;KAC/D;IAED,UAAiB,0CAA0C,CAAC;QAC1D,UAAiB,MAAM;YACrB;;eAEG;YACH,KAAK,EAAE,UAAU,GAAG,SAAS,GAAG,YAAY,GAAG,UAAU,GAAG,iBAAiB,CAAC;YAE9E;;eAEG;YACH,QAAQ,EAAE,UAAU,GAAG,UAAU,CAAC;YAElC;;eAEG;YACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;SACvB;QAED;;;;;WAKG;QACH,UAAiB,IAAI;YACnB;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;YAEpB;;;eAGG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;;eAGG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC7B;KACF;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;;;;;;OAOG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}

package/resources/invoice-line-items.js

@@ -24,6 +24,18 @@ class InvoiceLineItems extends resource_1.APIResource {
      * - If both `item_id` and `name` are provided: The item is looked up by ID for
      *   association, but the provided `name` is used for the line item (not the item's
      *   name).
+     *
+     * @example
+     * ```ts
+     * const invoiceLineItem =
+     *   await client.invoiceLineItems.create({
+     *     amount: '12.00',
+     *     end_date: '2023-09-22',
+     *     invoice_id: '4khy3nwzktxv7',
+     *     quantity: 1,
+     *     start_date: '2023-09-22',
+     *   });
+     * ```
      */
     create(body, options) {
         return this._client.post('/invoice_line_items', { body, ...options });

package/resources/invoice-line-items.js.map

@@ -1 +1 @@
-{"version":3,"file":"invoice-line-items.js","sourceRoot":"","sources":["../src/resources/invoice-line-items.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAI1C;;;;;GAKG;AACH,MAAa,gBAAiB,SAAQ,sBAAW;IAC/C;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,IAAiC,EACjC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;CACF;AAtBD,4CAsBC"}
+{"version":3,"file":"invoice-line-items.js","sourceRoot":"","sources":["../src/resources/invoice-line-items.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAI1C;;;;;GAKG;AACH,MAAa,gBAAiB,SAAQ,sBAAW;IAC/C;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,MAAM,CACJ,IAAiC,EACjC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;CACF;AAlCD,4CAkCC"}

package/resources/invoice-line-items.mjs

@@ -21,6 +21,18 @@ export class InvoiceLineItems extends APIResource {
      * - If both `item_id` and `name` are provided: The item is looked up by ID for
      *   association, but the provided `name` is used for the line item (not the item's
      *   name).
+     *
+     * @example
+     * ```ts
+     * const invoiceLineItem =
+     *   await client.invoiceLineItems.create({
+     *     amount: '12.00',
+     *     end_date: '2023-09-22',
+     *     invoice_id: '4khy3nwzktxv7',
+     *     quantity: 1,
+     *     start_date: '2023-09-22',
+     *   });
+     * ```
      */
     create(body, options) {
         return this._client.post('/invoice_line_items', { body, ...options });

package/resources/invoice-line-items.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"invoice-line-items.mjs","sourceRoot":"","sources":["../src/resources/invoice-line-items.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB;;;;;GAKG;AACH,MAAM,OAAO,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,IAAiC,EACjC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;CACF"}
+{"version":3,"file":"invoice-line-items.mjs","sourceRoot":"","sources":["../src/resources/invoice-line-items.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB;;;;;GAKG;AACH,MAAM,OAAO,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,MAAM,CACJ,IAAiC,EACjC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;CACF"}