@metronome/sdk 0.2.0 → 1.0.0

package/resources/v1/customers/invoices.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"invoices.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/customers/invoices.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmDG;IACH,QAAQ,CAAC,MAAM,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAKtG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyDG;IACH,IAAI,CAAC,MAAM,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,WAAW,CAAC,kBAAkB,EAAE,OAAO,CAAC;IAQnG;;;;;;;;;;;;;;;;;OAiBG;IACH,SAAS,CAAC,MAAM,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;IAKzG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqDG;IACH,cAAc,CACZ,MAAM,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,wCAAwC,EAAE,6BAA6B,CAAC;CAQxF;AAED,MAAM,MAAM,kBAAkB,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;AAErD,MAAM,MAAM,wCAAwC,GAAG,UAAU,CAAC,6BAA6B,CAAC,CAAC;AAEjG,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IAEX,WAAW,EAAE,MAAM,CAAC,cAAc,CAAC;IAEnC,WAAW,EAAE,MAAM,CAAC;IAEpB,UAAU,EAAE,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAEpC,MAAM,EAAE,MAAM,CAAC;IAEf,KAAK,EAAE,MAAM,CAAC;IAEd,IAAI,EAAE,MAAM,CAAC;IAEb,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,CAAC,EAAE,UAAU,GAAG,YAAY,CAAC;IAE5C;;OAEG;IACH,sBAAsB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEnD,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,iBAAiB,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC;IAE7C;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,aAAa,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE3C;;OAEG;IACH,sBAAsB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEnD;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,gBAAgB,CAAC,EAAE,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC;IAElD,mBAAmB,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAEvD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC;;OAEG;IACH,kBAAkB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAE/C,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC;IAE3C;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,yBAAiB,OAAO,CAAC;IACvB,UAAiB,QAAQ;QACvB,WAAW,EAAE,MAAM,CAAC,cAAc,CAAC;QAEnC,IAAI,EAAE,MAAM,CAAC;QAEb,KAAK,EAAE,MAAM,CAAC;QAEd;;;;;;;;;;;;;;;;;;;;;;;;WAwBG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;;;WAIG;QACH,wBAAwB,CAAC,EAAE,QAAQ,CAAC,qBAAqB,CAAC;QAE1D;;WAEG;QACH,oBAAoB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEjD;;;;;WAKG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB,uBAAuB,CAAC,EAAE,MAAM,CAAC;QAEjC,8BAA8B,CAAC,EAAE,MAAM,CAAC;QAExC,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,aAAa,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAE1C;;WAEG;QACH,sBAAsB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEnD;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;QAEtB;;;;WAIG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC;QAEzB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,4BAA4B,CAAC,EAAE,MAAM,CAAC;QAEtC;;WAEG;QACH,8BAA8B,CAAC,EAAE,MAAM,CAAC;QAExC,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAE1B;;WAEG;QACH,eAAe,CAAC,EAAE,QAAQ,CAAC,cAAc,CAAC;QAE1C;;;WAGG;QACH,yBAAyB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAA;SAAE,CAAC;QAE7D;;;WAGG;QACH,oBAAoB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEjD;;WAEG;QACH,qBAAqB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAElD;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE7B;;;;;;WAMG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,kCAAkC,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAE/D,uBAAuB,CAAC,EAAE,MAAM,CAAC;QAEjC;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB,aAAa,CAAC,EAAE,KAAK,GAAG,iBAAiB,GAAG,KAAK,GAAG,iBAAiB,CAAC;QAEtE;;WAEG;QACH,8BAA8B,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAE3D;;WAEG;QACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAE7B;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB,cAAc,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QAE7C;;WAEG;QACH,0BAA0B,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEvD;;WAEG;QACH,IAAI,CAAC,EAAE,QAAQ,CAAC,IAAI,CAAC;QAErB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;IAED,UAAiB,QAAQ,CAAC;QACxB;;;;WAIG;QACH,UAAiB,qBAAqB;YACpC,EAAE,EAAE,MAAM,CAAC;YAEX,IAAI,EAAE,SAAS,GAAG,UAAU,GAAG,QAAQ,CAAC;SACzC;QAED;;WAEG;QACH,UAAiB,cAAc;YAC7B,EAAE,EAAE,MAAM,CAAC;SACZ;QAED,UAAiB,WAAW;YAC1B;;eAEG;YACH,aAAa,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;aAAE,CAAC;YAEzC,IAAI,EAAE,MAAM,CAAC;YAEb,QAAQ,EAAE,MAAM,CAAC;YAEjB,QAAQ,EAAE,MAAM,CAAC;YAEjB,SAAS,CAAC,EAAE,MAAM,CAAC;YAEnB,eAAe,CAAC,EAAE,MAAM,CAAC;YAEzB;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;YAElB;;;eAGG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,WAAW,CAAC,EAAE,WAAW,CAAC,UAAU,CAAC;YAErC,KAAK,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;SACjC;QAED,UAAiB,WAAW,CAAC;YAC3B;;eAEG;YACH,UAAiB,UAAU;gBACzB,WAAW,EAAE,MAAM,CAAC;gBAEpB,aAAa,CAAC,EAAE,MAAM,CAAC;aACxB;YAED,UAAiB,IAAI;gBACnB,KAAK,EAAE,MAAM,CAAC;gBAEd,QAAQ,EAAE,MAAM,CAAC;gBAEjB;;mBAEG;gBACH,WAAW,EAAE,MAAM,CAAC;gBAEpB,QAAQ,EAAE,MAAM,CAAC;aAClB;SACF;QAED;;WAEG;QACH,UAAiB,IAAI;YACnB,KAAK,EAAE,MAAM,CAAC;YAEd,WAAW,EAAE,MAAM,CAAC;YAEpB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACtB;KACF;IAED,UAAiB,gBAAgB;QAC/B,oBAAoB,EAAE,MAAM,CAAC;QAE7B,IAAI,EAAE,MAAM,CAAC;QAEb,MAAM,EAAE,MAAM,CAAC;QAEf,0BAA0B,CAAC,EAAE,gBAAgB,CAAC,wBAAwB,CAAC;KACxE;IAED,UAAiB,gBAAgB,CAAC;QAChC,UAAiB,wBAAwB;YACvC,qBAAqB,EACjB,iBAAiB,GACjB,QAAQ,GACR,UAAU,GACV,QAAQ,GACR,mBAAmB,GACnB,mBAAmB,GACnB,SAAS,GACT,iBAAiB,CAAC;YAEtB,eAAe,CAAC,EACZ,OAAO,GACP,WAAW,GACX,MAAM,GACN,eAAe,GACf,MAAM,GACN,SAAS,GACT,gBAAgB,GAChB,uBAAuB,GACvB,SAAS,GACT,MAAM,GACN,QAAQ,CAAC;YAEb,UAAU,CAAC,EAAE,MAAM,CAAC;YAEpB,mBAAmB,CAAC,EAAE,MAAM,CAAC;SAC9B;KACF;IAED,UAAiB,eAAe;QAC9B,qBAAqB,EACjB,iBAAiB,GACjB,QAAQ,GACR,UAAU,GACV,QAAQ,GACR,mBAAmB,GACnB,mBAAmB,GACnB,SAAS,GACT,iBAAiB,CAAC;QAEtB,eAAe,CAAC,EACZ,OAAO,GACP,WAAW,GACX,MAAM,GACN,eAAe,GACf,MAAM,GACN,SAAS,GACT,gBAAgB,GAChB,uBAAuB,GACvB,SAAS,GACT,MAAM,GACN,QAAQ,CAAC;QAEb,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB,mBAAmB,CAAC,EAAE,MAAM,CAAC;KAC9B;IAED,UAAiB,iBAAiB;QAChC,WAAW,EAAE,MAAM,CAAC,cAAc,CAAC;QAEnC,IAAI,EAAE,MAAM,CAAC;QAEb,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,0BAA0B,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEvD,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B;IAED;;OAEG;IACH,UAAiB,eAAe;QAC9B,QAAQ,EAAE,MAAM,CAAC;QAEjB,oBAAoB,EAAE,MAAM,CAAC;QAE7B,aAAa,EAAE,KAAK,GAAG,iBAAiB,GAAG,KAAK,GAAG,iBAAiB,CAAC;QAErE,WAAW,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC;QAEzC,WAAW,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC;KAC1C;IAED,UAAiB,eAAe,CAAC;QAC/B,UAAiB,UAAU;YACzB,kBAAkB,CAAC,EAAE,MAAM,CAAC;YAE5B,YAAY,CAAC,EAAE,MAAM,CAAC;YAEtB,sBAAsB,CAAC,EAAE,MAAM,CAAC;SACjC;QAED,UAAiB,UAAU;YACzB,cAAc,CAAC,EAAE,MAAM,CAAC;YAExB,YAAY,CAAC,EAAE,MAAM,CAAC;SACvB;KACF;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,wBAAwB;CAAG;AAE5C,MAAM,WAAW,6BAA8B,SAAQ,OAAO;IAC5D,uBAAuB,EAAE,MAAM,CAAC;IAEhC,yBAAyB,EAAE,MAAM,CAAC;CACnC;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;CACpC;AAED,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACzD;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC;;;OAGG;IACH,IAAI,CAAC,EAAE,UAAU,GAAG,WAAW,CAAC;IAEhC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAEhC;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,2BAA4B,SAAQ,gBAAgB;IACnE;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC;;;OAGG;IACH,IAAI,CAAC,EAAE,UAAU,GAAG,WAAW,CAAC;IAEhC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;CAC9B;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,wCAAwC,IAAI,wCAAwC,EACzF,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}

package/resources/v1/customers/invoices.d.ts

@@ -1,10 +1,50 @@
-import { APIResource } from "../../../resource.js";
-import * as Core from "../../../core.js";
+import { APIResource } from "../../../core/resource.js";
 import * as Shared from "../../shared.js";
-import { CursorPage, type CursorPageParams } from "../../../pagination.js";
+import { APIPromise } from "../../../core/api-promise.js";
+import { CursorPage, type CursorPageParams, PagePromise } from "../../../core/pagination.js";
+import { RequestOptions } from "../../../internal/request-options.js";
 export declare class Invoices extends APIResource {
     /**
-     * Fetch a specific invoice for a given customer.
+     * Retrieve detailed information for a specific invoice by its unique identifier.
+     * This endpoint returns comprehensive invoice data including line items, applied
+     * credits, totals, and billing period details for both finalized and draft
+     * invoices.
+     *
+     * ### Use this endpoint to:
+     *
+     * - Display historical invoice details in customer-facing dashboards or billing
+     *   portals.
+     * - Retrieve current month draft invoices to show customers their month-to-date
+     *   spend.
+     * - Access finalized invoices for historical billing records and payment
+     *   reconciliation.
+     * - Validate customer pricing and credit applications for customer support
+     *   queries.
+     *
+     * ### Key response fields:
+     *
+     * Invoice status (DRAFT, FINALIZED, VOID) Billing period start and end dates Total
+     * amount and amount due after credits Detailed line items broken down by:
+     *
+     * - Customer and contract information
+     * - Invoice line item type
+     * - Product/service name and ID
+     * - Quantity consumed
+     * - Unit and total price
+     * - Time period for usage-based charges
+     * - Applied credits or prepaid commitments
+     *
+     * ### Usage guidelines:
+     *
+     * - Draft invoices update in real-time as usage is reported and may change before
+     *   finalization
+     * - The response includes both usage-based line items (e.g., API calls, data
+     *   processed) and scheduled charges (e.g., monthly subscriptions, commitment
+     *   fees)
+     * - Credit and commitment applications are shown as separate line items with
+     *   negative amounts
+     * - For voided invoices, the response will indicate VOID status but retain all
+     *   original line item details
      *
      * @example
      * ```ts
@@ -16,10 +56,54 @@ export declare class Invoices extends APIResource {
      * );
      * ```
      */
-    retrieve(params: InvoiceRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<InvoiceRetrieveResponse>;
+    retrieve(params: InvoiceRetrieveParams, options?: RequestOptions): APIPromise<InvoiceRetrieveResponse>;
     /**
-     * List all invoices for a given customer, optionally filtered by status, date
-     * range, and/or credit type.
+     * Retrieves a paginated list of invoices for a specific customer, with flexible
+     * filtering options to narrow results by status, date range, credit type, and
+     * more. This endpoint provides a comprehensive view of a customer's billing
+     * history and current charges, supporting both real-time billing dashboards and
+     * historical reporting needs.
+     *
+     * ### Use this endpoint to:
+     *
+     * - Display historical invoice details in customer-facing dashboards or billing
+     *   portals.
+     * - Retrieve current month draft invoices to show customers their month-to-date
+     *   spend.
+     * - Access finalized invoices for historical billing records and payment
+     *   reconciliation.
+     * - Validate customer pricing and credit applications for customer support
+     *   queries.
+     * - Generate financial reports by filtering invoices within specific date ranges
+     *
+     * ### Key response fields:
+     *
+     * Array of invoice objects containing:
+     *
+     * - Invoice ID and status (DRAFT, FINALIZED, VOID)
+     * - Invoice type (USAGE, SCHEDULED)
+     * - Billing period start and end dates
+     * - Issue date and due date
+     * - Total amount, subtotal, and amount due
+     * - Applied credits summary
+     * - Contract ID reference
+     * - External billing provider status (if integrated with Stripe, etc.)
+     * - Pagination metadata `next_page` cursor
+     *
+     * ### Usage guidelines:
+     *
+     * - The endpoint returns invoice summaries; use the Get Invoice endpoint for
+     *   detailed line items
+     * - Draft invoices are continuously updated as new usage is reported and will show
+     *   real-time spend
+     * - Results are ordered by creation date descending by default (newest first)
+     * - When filtering by date range, the filter applies to the billing period, not
+     *   the issue date
+     * - For customers with many invoices, implement pagination to ensure all results
+     *   are retrieved External billing provider statuses (like Stripe payment status)
+     *   are included when applicable
+     * - Voided invoices are included in results by default unless filtered out by
+     *   status
      *
      * @example
      * ```ts
@@ -31,7 +115,7 @@ export declare class Invoices extends APIResource {
      * }
      * ```
      */
-    list(params: InvoiceListParams, options?: Core.RequestOptions): Core.PagePromise<InvoicesCursorPage, Invoice>;
+    list(params: InvoiceListParams, options?: RequestOptions): PagePromise<InvoicesCursorPage, Invoice>;
     /**
      * Add a one time charge to the specified invoice
      *
@@ -50,13 +134,46 @@ export declare class Invoices extends APIResource {
      *   });
      * ```
      */
-    addCharge(params: InvoiceAddChargeParams, options?: Core.RequestOptions): Core.APIPromise<InvoiceAddChargeResponse>;
+    addCharge(params: InvoiceAddChargeParams, options?: RequestOptions): APIPromise<InvoiceAddChargeResponse>;
     /**
-     * List daily or hourly invoice breakdowns for a given customer, optionally
-     * filtered by status, date range, and/or credit type. Important considerations:
+     * Retrieve granular time-series breakdowns of invoice data at hourly or daily
+     * intervals. This endpoint transforms standard invoices into detailed timelines,
+     * enabling you to track usage patterns, identify consumption spikes, and provide
+     * customers with transparency into their billing details throughout the billing
+     * period.
+     *
+     * ### Use this endpoint to:
+     *
+     * - Build usage analytics dashboards showing daily or hourly consumption trends
+     * - Identify peak usage periods for capacity planning and cost optimization
+     * - Generate detailed billing reports for finance teams and customer success
+     * - Troubleshoot billing disputes by examining usage patterns at specific times
+     * - Power real-time cost monitoring and alerting systems
+     *
+     * ### Key response fields:
+     *
+     * An array of BreakdownInvoice objects, each containing:
      *
-     * - If we receive backdated usage after an invoice has been finalized, the
-     *   backdated usage will be included in the response and usage numbers may differ.
+     * - All standard invoice fields (ID, customer, commit, line items, totals, status)
+     * - Line items with quantities and costs for that specific period
+     * - `breakdown_start_timestamp`: Start of the specific time window
+     * - `breakdown_end_timestamp`: End of the specific time window
+     * - `next_page`: Pagination cursor for large result sets
+     *
+     * ### Usage guidelines:
+     *
+     * - Time granularity: Set `window_size` to hour or day based on your analysis
+     *   needs
+     * - Response limits: Daily breakdowns return up to 35 days; hourly breakdowns
+     *   return up to 24 hours per request
+     * - Date filtering: Use `starting_on` and `ending_before` to focus on specific
+     *   periods
+     * - Performance: For large date ranges, use pagination to retrieve all data
+     *   efficiently
+     * - Backdated usage: If usage events arrive after invoice finalization, breakdowns
+     *   will reflect the updated usage
+     * - Zero quantity filtering: Use `skip_zero_qty_line_items=true` to exclude
+     *   periods with no usage
      *
      * @example
      * ```ts
@@ -72,12 +189,10 @@ export declare class Invoices extends APIResource {
      * }
      * ```
      */
-    listBreakdowns(params: InvoiceListBreakdownsParams, options?: Core.RequestOptions): Core.PagePromise<InvoiceListBreakdownsResponsesCursorPage, InvoiceListBreakdownsResponse>;
-}
-export declare class InvoicesCursorPage extends CursorPage<Invoice> {
-}
-export declare class InvoiceListBreakdownsResponsesCursorPage extends CursorPage<InvoiceListBreakdownsResponse> {
+    listBreakdowns(params: InvoiceListBreakdownsParams, options?: RequestOptions): PagePromise<InvoiceListBreakdownsResponsesCursorPage, InvoiceListBreakdownsResponse>;
 }
+export type InvoicesCursorPage = CursorPage<Invoice>;
+export type InvoiceListBreakdownsResponsesCursorPage = CursorPage<InvoiceListBreakdownsResponse>;
 export interface Invoice {
     id: string;
     credit_type: Shared.CreditTypeData;
@@ -91,6 +206,9 @@ export interface Invoice {
      * This field's availability is dependent on your client's configuration.
      */
     billable_status?: 'billable' | 'unbillable';
+    /**
+     * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+     */
     contract_custom_fields?: {
         [key: string]: string;
     };
@@ -104,6 +222,9 @@ export interface Invoice {
     custom_fields?: {
         [key: string]: unknown;
     };
+    /**
+     * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+     */
     customer_custom_fields?: {
         [key: string]: string;
     };
@@ -122,6 +243,9 @@ export interface Invoice {
      * This field's availability is dependent on your client's configuration.
      */
     netsuite_sales_order_id?: string;
+    /**
+     * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+     */
     plan_custom_fields?: {
         [key: string]: string;
     };
@@ -146,12 +270,41 @@ export declare namespace Invoice {
         credit_type: Shared.CreditTypeData;
         name: string;
         total: number;
+        /**
+         * The type of line item.
+         *
+         * - `scheduled`: Line item is associated with a scheduled charge. View the
+         *   scheduled_charge_id on the line item.
+         * - `commit_purchase`: Line item is associated with a payment for a prepaid
+         *   commit. View the commit_id on the line item.
+         * - `usage`: Line item is associated with a usage product or composite product.
+         *   View the product_id on the line item to determine which product.
+         * - `subscription`: Line item is associated with a subscription. e.g. monthly
+         *   recurring payment for an in-advance subscription.
+         * - `applied_commit_or_credit`: On metronome invoices, applied commits and credits
+         *   are associated with their own line items. These line items have negative
+         *   totals. Use the applied_commit_or_credit object on the line item to understand
+         *   the id of the applied commit or credit, and its type. Note that the
+         *   application of a postpaid commit is associated with a line item, but the total
+         *   on the line item is not included in the invoice's total as postpaid commits
+         *   are paid in-arrears.
+         * - `cpu_conversion`: Line item converting between a custom pricing unit and fiat
+         *   currency, using the conversion rate set on the rate card. This line item will
+         *   appear when there are products priced in custom pricing units, and there is
+         *   insufficient prepaid commit/credit in that custom pricing unit to fully cover
+         *   the spend. Then, the outstanding spend in custom pricing units will be
+         *   converted to fiat currency using a cpu_conversion line item.
+         */
+        type: string;
         /**
          * Details about the credit or commit that was applied to this line item. Only
          * present on line items with product of `USAGE`, `SUBSCRIPTION` or `COMPOSITE`
          * types.
          */
         applied_commit_or_credit?: LineItem.AppliedCommitOrCredit;
+        /**
+         * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+         */
         commit_custom_fields?: {
             [key: string]: string;
         };
@@ -170,9 +323,15 @@ export declare namespace Invoice {
          * (for commit type `POSTPAID`).
          */
         commit_type?: string;
+        /**
+         * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+         */
         custom_fields?: {
             [key: string]: string;
         };
+        /**
+         * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+         */
         discount_custom_fields?: {
             [key: string]: string;
         };
@@ -224,6 +383,9 @@ export declare namespace Invoice {
         pricing_group_values?: {
             [key: string]: string;
         };
+        /**
+         * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+         */
         product_custom_fields?: {
             [key: string]: string;
         };
@@ -243,6 +405,9 @@ export declare namespace Invoice {
          * charges, commit and credit payments, the value is `FixedProductListItem`.
          */
         product_type?: string;
+        /**
+         * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+         */
         professional_service_custom_fields?: {
             [key: string]: string;
         };
@@ -252,6 +417,9 @@ export declare namespace Invoice {
          */
         quantity?: number;
         reseller_type?: 'AWS' | 'AWS_PRO_SERVICE' | 'GCP' | 'GCP_PRO_SERVICE';
+        /**
+         * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+         */
         scheduled_charge_custom_fields?: {
             [key: string]: string;
         };
@@ -264,6 +432,9 @@ export declare namespace Invoice {
          */
         starting_at?: string;
         sub_line_items?: Array<LineItem.SubLineItem>;
+        /**
+         * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+         */
         subscription_custom_fields?: {
             [key: string]: string;
         };
@@ -293,6 +464,9 @@ export declare namespace Invoice {
             id: string;
         }
         interface SubLineItem {
+            /**
+             * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+             */
             custom_fields: {
                 [key: string]: string;
             };
@@ -371,6 +545,9 @@ export declare namespace Invoice {
         credit_type: Shared.CreditTypeData;
         name: string;
         total: number;
+        /**
+         * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+         */
         credit_grant_custom_fields?: {
             [key: string]: string;
         };
@@ -528,6 +705,6 @@ export interface InvoiceListBreakdownsParams extends CursorPageParams {
     window_size?: 'HOUR' | 'DAY';
 }
 export declare namespace Invoices {
-    export { type Invoice as Invoice, type InvoiceRetrieveResponse as InvoiceRetrieveResponse, type InvoiceAddChargeResponse as InvoiceAddChargeResponse, type InvoiceListBreakdownsResponse as InvoiceListBreakdownsResponse, InvoicesCursorPage as InvoicesCursorPage, InvoiceListBreakdownsResponsesCursorPage as InvoiceListBreakdownsResponsesCursorPage, type InvoiceRetrieveParams as InvoiceRetrieveParams, type InvoiceListParams as InvoiceListParams, type InvoiceAddChargeParams as InvoiceAddChargeParams, type InvoiceListBreakdownsParams as InvoiceListBreakdownsParams, };
+    export { type Invoice as Invoice, type InvoiceRetrieveResponse as InvoiceRetrieveResponse, type InvoiceAddChargeResponse as InvoiceAddChargeResponse, type InvoiceListBreakdownsResponse as InvoiceListBreakdownsResponse, type InvoicesCursorPage as InvoicesCursorPage, type InvoiceListBreakdownsResponsesCursorPage as InvoiceListBreakdownsResponsesCursorPage, type InvoiceRetrieveParams as InvoiceRetrieveParams, type InvoiceListParams as InvoiceListParams, type InvoiceAddChargeParams as InvoiceAddChargeParams, type InvoiceListBreakdownsParams as InvoiceListBreakdownsParams, };
 }
 //# sourceMappingURL=invoices.d.ts.map

package/resources/v1/customers/invoices.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"invoices.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/customers/invoices.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,IAAI,MAAM,eAAe,CAAC;AACtC,OAAO,KAAK,MAAM,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAExE,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC;IAK3C;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,MAAM,EAAE,iBAAiB,EACzB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,kBAAkB,EAAE,OAAO,CAAC;IAQhD;;;;;;;;;;;;;;;;;OAiBG;IACH,SAAS,CACP,MAAM,EAAE,sBAAsB,EAC9B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC;IAK5C;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,cAAc,CACZ,MAAM,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,wCAAwC,EAAE,6BAA6B,CAAC;CAQ7F;AAED,qBAAa,kBAAmB,SAAQ,UAAU,CAAC,OAAO,CAAC;CAAG;AAE9D,qBAAa,wCAAyC,SAAQ,UAAU,CAAC,6BAA6B,CAAC;CAAG;AAE1G,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IAEX,WAAW,EAAE,MAAM,CAAC,cAAc,CAAC;IAEnC,WAAW,EAAE,MAAM,CAAC;IAEpB,UAAU,EAAE,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAEpC,MAAM,EAAE,MAAM,CAAC;IAEf,KAAK,EAAE,MAAM,CAAC;IAEd,IAAI,EAAE,MAAM,CAAC;IAEb,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,CAAC,EAAE,UAAU,GAAG,YAAY,CAAC;IAE5C,sBAAsB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEnD,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,iBAAiB,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC;IAE7C;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,aAAa,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE3C,sBAAsB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEnD;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,gBAAgB,CAAC,EAAE,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC;IAElD,mBAAmB,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAEvD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC,kBAAkB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAE/C,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC;IAE3C;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,yBAAiB,OAAO,CAAC;IACvB,UAAiB,QAAQ;QACvB,WAAW,EAAE,MAAM,CAAC,cAAc,CAAC;QAEnC,IAAI,EAAE,MAAM,CAAC;QAEb,KAAK,EAAE,MAAM,CAAC;QAEd;;;;WAIG;QACH,wBAAwB,CAAC,EAAE,QAAQ,CAAC,qBAAqB,CAAC;QAE1D,oBAAoB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEjD;;;;;WAKG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB,uBAAuB,CAAC,EAAE,MAAM,CAAC;QAEjC,8BAA8B,CAAC,EAAE,MAAM,CAAC;QAExC,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB,aAAa,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAE1C,sBAAsB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEnD;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;QAEtB;;;;WAIG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC;QAEzB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,4BAA4B,CAAC,EAAE,MAAM,CAAC;QAEtC;;WAEG;QACH,8BAA8B,CAAC,EAAE,MAAM,CAAC;QAExC,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAE1B;;WAEG;QACH,eAAe,CAAC,EAAE,QAAQ,CAAC,cAAc,CAAC;QAE1C;;;WAGG;QACH,yBAAyB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAA;SAAE,CAAC;QAE7D;;;WAGG;QACH,oBAAoB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEjD,qBAAqB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAElD;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE7B;;;;;;WAMG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB,kCAAkC,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAE/D,uBAAuB,CAAC,EAAE,MAAM,CAAC;QAEjC;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB,aAAa,CAAC,EAAE,KAAK,GAAG,iBAAiB,GAAG,KAAK,GAAG,iBAAiB,CAAC;QAEtE,8BAA8B,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAE3D;;WAEG;QACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAE7B;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB,cAAc,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QAE7C,0BAA0B,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEvD;;WAEG;QACH,IAAI,CAAC,EAAE,QAAQ,CAAC,IAAI,CAAC;QAErB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;IAED,UAAiB,QAAQ,CAAC;QACxB;;;;WAIG;QACH,UAAiB,qBAAqB;YACpC,EAAE,EAAE,MAAM,CAAC;YAEX,IAAI,EAAE,SAAS,GAAG,UAAU,GAAG,QAAQ,CAAC;SACzC;QAED;;WAEG;QACH,UAAiB,cAAc;YAC7B,EAAE,EAAE,MAAM,CAAC;SACZ;QAED,UAAiB,WAAW;YAC1B,aAAa,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;aAAE,CAAC;YAEzC,IAAI,EAAE,MAAM,CAAC;YAEb,QAAQ,EAAE,MAAM,CAAC;YAEjB,QAAQ,EAAE,MAAM,CAAC;YAEjB,SAAS,CAAC,EAAE,MAAM,CAAC;YAEnB,eAAe,CAAC,EAAE,MAAM,CAAC;YAEzB;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;YAElB;;;eAGG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,WAAW,CAAC,EAAE,WAAW,CAAC,UAAU,CAAC;YAErC,KAAK,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;SACjC;QAED,UAAiB,WAAW,CAAC;YAC3B;;eAEG;YACH,UAAiB,UAAU;gBACzB,WAAW,EAAE,MAAM,CAAC;gBAEpB,aAAa,CAAC,EAAE,MAAM,CAAC;aACxB;YAED,UAAiB,IAAI;gBACnB,KAAK,EAAE,MAAM,CAAC;gBAEd,QAAQ,EAAE,MAAM,CAAC;gBAEjB;;mBAEG;gBACH,WAAW,EAAE,MAAM,CAAC;gBAEpB,QAAQ,EAAE,MAAM,CAAC;aAClB;SACF;QAED;;WAEG;QACH,UAAiB,IAAI;YACnB,KAAK,EAAE,MAAM,CAAC;YAEd,WAAW,EAAE,MAAM,CAAC;YAEpB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACtB;KACF;IAED,UAAiB,gBAAgB;QAC/B,oBAAoB,EAAE,MAAM,CAAC;QAE7B,IAAI,EAAE,MAAM,CAAC;QAEb,MAAM,EAAE,MAAM,CAAC;QAEf,0BAA0B,CAAC,EAAE,gBAAgB,CAAC,wBAAwB,CAAC;KACxE;IAED,UAAiB,gBAAgB,CAAC;QAChC,UAAiB,wBAAwB;YACvC,qBAAqB,EACjB,iBAAiB,GACjB,QAAQ,GACR,UAAU,GACV,QAAQ,GACR,mBAAmB,GACnB,mBAAmB,GACnB,SAAS,GACT,iBAAiB,CAAC;YAEtB,eAAe,CAAC,EACZ,OAAO,GACP,WAAW,GACX,MAAM,GACN,eAAe,GACf,MAAM,GACN,SAAS,GACT,gBAAgB,GAChB,uBAAuB,GACvB,SAAS,GACT,MAAM,GACN,QAAQ,CAAC;YAEb,UAAU,CAAC,EAAE,MAAM,CAAC;YAEpB,mBAAmB,CAAC,EAAE,MAAM,CAAC;SAC9B;KACF;IAED,UAAiB,eAAe;QAC9B,qBAAqB,EACjB,iBAAiB,GACjB,QAAQ,GACR,UAAU,GACV,QAAQ,GACR,mBAAmB,GACnB,mBAAmB,GACnB,SAAS,GACT,iBAAiB,CAAC;QAEtB,eAAe,CAAC,EACZ,OAAO,GACP,WAAW,GACX,MAAM,GACN,eAAe,GACf,MAAM,GACN,SAAS,GACT,gBAAgB,GAChB,uBAAuB,GACvB,SAAS,GACT,MAAM,GACN,QAAQ,CAAC;QAEb,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB,mBAAmB,CAAC,EAAE,MAAM,CAAC;KAC9B;IAED,UAAiB,iBAAiB;QAChC,WAAW,EAAE,MAAM,CAAC,cAAc,CAAC;QAEnC,IAAI,EAAE,MAAM,CAAC;QAEb,KAAK,EAAE,MAAM,CAAC;QAEd,0BAA0B,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEvD,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B;IAED;;OAEG;IACH,UAAiB,eAAe;QAC9B,QAAQ,EAAE,MAAM,CAAC;QAEjB,oBAAoB,EAAE,MAAM,CAAC;QAE7B,aAAa,EAAE,KAAK,GAAG,iBAAiB,GAAG,KAAK,GAAG,iBAAiB,CAAC;QAErE,WAAW,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC;QAEzC,WAAW,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC;KAC1C;IAED,UAAiB,eAAe,CAAC;QAC/B,UAAiB,UAAU;YACzB,kBAAkB,CAAC,EAAE,MAAM,CAAC;YAE5B,YAAY,CAAC,EAAE,MAAM,CAAC;YAEtB,sBAAsB,CAAC,EAAE,MAAM,CAAC;SACjC;QAED,UAAiB,UAAU;YACzB,cAAc,CAAC,EAAE,MAAM,CAAC;YAExB,YAAY,CAAC,EAAE,MAAM,CAAC;SACvB;KACF;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,wBAAwB;CAAG;AAE5C,MAAM,WAAW,6BAA8B,SAAQ,OAAO;IAC5D,uBAAuB,EAAE,MAAM,CAAC;IAEhC,yBAAyB,EAAE,MAAM,CAAC;CACnC;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;CACpC;AAED,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACzD;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC;;;OAGG;IACH,IAAI,CAAC,EAAE,UAAU,GAAG,WAAW,CAAC;IAEhC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAEhC;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,2BAA4B,SAAQ,gBAAgB;IACnE;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC;;;OAGG;IACH,IAAI,CAAC,EAAE,UAAU,GAAG,WAAW,CAAC;IAEhC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;CAC9B;AAKD,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,kBAAkB,IAAI,kBAAkB,EACxC,wCAAwC,IAAI,wCAAwC,EACpF,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}
+{"version":3,"file":"invoices.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/customers/invoices.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmDG;IACH,QAAQ,CAAC,MAAM,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAKtG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyDG;IACH,IAAI,CAAC,MAAM,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,WAAW,CAAC,kBAAkB,EAAE,OAAO,CAAC;IAQnG;;;;;;;;;;;;;;;;;OAiBG;IACH,SAAS,CAAC,MAAM,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;IAKzG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqDG;IACH,cAAc,CACZ,MAAM,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,wCAAwC,EAAE,6BAA6B,CAAC;CAQxF;AAED,MAAM,MAAM,kBAAkB,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;AAErD,MAAM,MAAM,wCAAwC,GAAG,UAAU,CAAC,6BAA6B,CAAC,CAAC;AAEjG,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IAEX,WAAW,EAAE,MAAM,CAAC,cAAc,CAAC;IAEnC,WAAW,EAAE,MAAM,CAAC;IAEpB,UAAU,EAAE,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAEpC,MAAM,EAAE,MAAM,CAAC;IAEf,KAAK,EAAE,MAAM,CAAC;IAEd,IAAI,EAAE,MAAM,CAAC;IAEb,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,CAAC,EAAE,UAAU,GAAG,YAAY,CAAC;IAE5C;;OAEG;IACH,sBAAsB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEnD,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,iBAAiB,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC;IAE7C;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,aAAa,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE3C;;OAEG;IACH,sBAAsB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEnD;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,gBAAgB,CAAC,EAAE,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC;IAElD,mBAAmB,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAEvD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC;;OAEG;IACH,kBAAkB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAE/C,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC;IAE3C;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,yBAAiB,OAAO,CAAC;IACvB,UAAiB,QAAQ;QACvB,WAAW,EAAE,MAAM,CAAC,cAAc,CAAC;QAEnC,IAAI,EAAE,MAAM,CAAC;QAEb,KAAK,EAAE,MAAM,CAAC;QAEd;;;;;;;;;;;;;;;;;;;;;;;;WAwBG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;;;WAIG;QACH,wBAAwB,CAAC,EAAE,QAAQ,CAAC,qBAAqB,CAAC;QAE1D;;WAEG;QACH,oBAAoB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEjD;;;;;WAKG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB,uBAAuB,CAAC,EAAE,MAAM,CAAC;QAEjC,8BAA8B,CAAC,EAAE,MAAM,CAAC;QAExC,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,aAAa,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAE1C;;WAEG;QACH,sBAAsB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEnD;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;QAEtB;;;;WAIG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC;QAEzB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,4BAA4B,CAAC,EAAE,MAAM,CAAC;QAEtC;;WAEG;QACH,8BAA8B,CAAC,EAAE,MAAM,CAAC;QAExC,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAE1B;;WAEG;QACH,eAAe,CAAC,EAAE,QAAQ,CAAC,cAAc,CAAC;QAE1C;;;WAGG;QACH,yBAAyB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAA;SAAE,CAAC;QAE7D;;;WAGG;QACH,oBAAoB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEjD;;WAEG;QACH,qBAAqB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAElD;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE7B;;;;;;WAMG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,kCAAkC,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAE/D,uBAAuB,CAAC,EAAE,MAAM,CAAC;QAEjC;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB,aAAa,CAAC,EAAE,KAAK,GAAG,iBAAiB,GAAG,KAAK,GAAG,iBAAiB,CAAC;QAEtE;;WAEG;QACH,8BAA8B,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAE3D;;WAEG;QACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAE7B;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB,cAAc,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QAE7C;;WAEG;QACH,0BAA0B,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEvD;;WAEG;QACH,IAAI,CAAC,EAAE,QAAQ,CAAC,IAAI,CAAC;QAErB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;IAED,UAAiB,QAAQ,CAAC;QACxB;;;;WAIG;QACH,UAAiB,qBAAqB;YACpC,EAAE,EAAE,MAAM,CAAC;YAEX,IAAI,EAAE,SAAS,GAAG,UAAU,GAAG,QAAQ,CAAC;SACzC;QAED;;WAEG;QACH,UAAiB,cAAc;YAC7B,EAAE,EAAE,MAAM,CAAC;SACZ;QAED,UAAiB,WAAW;YAC1B;;eAEG;YACH,aAAa,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;aAAE,CAAC;YAEzC,IAAI,EAAE,MAAM,CAAC;YAEb,QAAQ,EAAE,MAAM,CAAC;YAEjB,QAAQ,EAAE,MAAM,CAAC;YAEjB,SAAS,CAAC,EAAE,MAAM,CAAC;YAEnB,eAAe,CAAC,EAAE,MAAM,CAAC;YAEzB;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;YAElB;;;eAGG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,WAAW,CAAC,EAAE,WAAW,CAAC,UAAU,CAAC;YAErC,KAAK,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;SACjC;QAED,UAAiB,WAAW,CAAC;YAC3B;;eAEG;YACH,UAAiB,UAAU;gBACzB,WAAW,EAAE,MAAM,CAAC;gBAEpB,aAAa,CAAC,EAAE,MAAM,CAAC;aACxB;YAED,UAAiB,IAAI;gBACnB,KAAK,EAAE,MAAM,CAAC;gBAEd,QAAQ,EAAE,MAAM,CAAC;gBAEjB;;mBAEG;gBACH,WAAW,EAAE,MAAM,CAAC;gBAEpB,QAAQ,EAAE,MAAM,CAAC;aAClB;SACF;QAED;;WAEG;QACH,UAAiB,IAAI;YACnB,KAAK,EAAE,MAAM,CAAC;YAEd,WAAW,EAAE,MAAM,CAAC;YAEpB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACtB;KACF;IAED,UAAiB,gBAAgB;QAC/B,oBAAoB,EAAE,MAAM,CAAC;QAE7B,IAAI,EAAE,MAAM,CAAC;QAEb,MAAM,EAAE,MAAM,CAAC;QAEf,0BAA0B,CAAC,EAAE,gBAAgB,CAAC,wBAAwB,CAAC;KACxE;IAED,UAAiB,gBAAgB,CAAC;QAChC,UAAiB,wBAAwB;YACvC,qBAAqB,EACjB,iBAAiB,GACjB,QAAQ,GACR,UAAU,GACV,QAAQ,GACR,mBAAmB,GACnB,mBAAmB,GACnB,SAAS,GACT,iBAAiB,CAAC;YAEtB,eAAe,CAAC,EACZ,OAAO,GACP,WAAW,GACX,MAAM,GACN,eAAe,GACf,MAAM,GACN,SAAS,GACT,gBAAgB,GAChB,uBAAuB,GACvB,SAAS,GACT,MAAM,GACN,QAAQ,CAAC;YAEb,UAAU,CAAC,EAAE,MAAM,CAAC;YAEpB,mBAAmB,CAAC,EAAE,MAAM,CAAC;SAC9B;KACF;IAED,UAAiB,eAAe;QAC9B,qBAAqB,EACjB,iBAAiB,GACjB,QAAQ,GACR,UAAU,GACV,QAAQ,GACR,mBAAmB,GACnB,mBAAmB,GACnB,SAAS,GACT,iBAAiB,CAAC;QAEtB,eAAe,CAAC,EACZ,OAAO,GACP,WAAW,GACX,MAAM,GACN,eAAe,GACf,MAAM,GACN,SAAS,GACT,gBAAgB,GAChB,uBAAuB,GACvB,SAAS,GACT,MAAM,GACN,QAAQ,CAAC;QAEb,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB,mBAAmB,CAAC,EAAE,MAAM,CAAC;KAC9B;IAED,UAAiB,iBAAiB;QAChC,WAAW,EAAE,MAAM,CAAC,cAAc,CAAC;QAEnC,IAAI,EAAE,MAAM,CAAC;QAEb,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,0BAA0B,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEvD,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B;IAED;;OAEG;IACH,UAAiB,eAAe;QAC9B,QAAQ,EAAE,MAAM,CAAC;QAEjB,oBAAoB,EAAE,MAAM,CAAC;QAE7B,aAAa,EAAE,KAAK,GAAG,iBAAiB,GAAG,KAAK,GAAG,iBAAiB,CAAC;QAErE,WAAW,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC;QAEzC,WAAW,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC;KAC1C;IAED,UAAiB,eAAe,CAAC;QAC/B,UAAiB,UAAU;YACzB,kBAAkB,CAAC,EAAE,MAAM,CAAC;YAE5B,YAAY,CAAC,EAAE,MAAM,CAAC;YAEtB,sBAAsB,CAAC,EAAE,MAAM,CAAC;SACjC;QAED,UAAiB,UAAU;YACzB,cAAc,CAAC,EAAE,MAAM,CAAC;YAExB,YAAY,CAAC,EAAE,MAAM,CAAC;SACvB;KACF;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,wBAAwB;CAAG;AAE5C,MAAM,WAAW,6BAA8B,SAAQ,OAAO;IAC5D,uBAAuB,EAAE,MAAM,CAAC;IAEhC,yBAAyB,EAAE,MAAM,CAAC;CACnC;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;CACpC;AAED,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACzD;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC;;;OAGG;IACH,IAAI,CAAC,EAAE,UAAU,GAAG,WAAW,CAAC;IAEhC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAEhC;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,2BAA4B,SAAQ,gBAAgB;IACnE;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC;;;OAGG;IACH,IAAI,CAAC,EAAE,UAAU,GAAG,WAAW,CAAC;IAEhC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;CAC9B;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,wCAAwC,IAAI,wCAAwC,EACzF,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}

package/resources/v1/customers/invoices.js

@@ -1,12 +1,52 @@
 "use strict";
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.InvoiceListBreakdownsResponsesCursorPage = exports.InvoicesCursorPage = exports.Invoices = void 0;
-const resource_1 = require("../../../resource.js");
-const pagination_1 = require("../../../pagination.js");
+exports.Invoices = void 0;
+const resource_1 = require("../../../core/resource.js");
+const pagination_1 = require("../../../core/pagination.js");
+const path_1 = require("../../../internal/utils/path.js");
 class Invoices extends resource_1.APIResource {
     /**
-     * Fetch a specific invoice for a given customer.
+     * Retrieve detailed information for a specific invoice by its unique identifier.
+     * This endpoint returns comprehensive invoice data including line items, applied
+     * credits, totals, and billing period details for both finalized and draft
+     * invoices.
+     *
+     * ### Use this endpoint to:
+     *
+     * - Display historical invoice details in customer-facing dashboards or billing
+     *   portals.
+     * - Retrieve current month draft invoices to show customers their month-to-date
+     *   spend.
+     * - Access finalized invoices for historical billing records and payment
+     *   reconciliation.
+     * - Validate customer pricing and credit applications for customer support
+     *   queries.
+     *
+     * ### Key response fields:
+     *
+     * Invoice status (DRAFT, FINALIZED, VOID) Billing period start and end dates Total
+     * amount and amount due after credits Detailed line items broken down by:
+     *
+     * - Customer and contract information
+     * - Invoice line item type
+     * - Product/service name and ID
+     * - Quantity consumed
+     * - Unit and total price
+     * - Time period for usage-based charges
+     * - Applied credits or prepaid commitments
+     *
+     * ### Usage guidelines:
+     *
+     * - Draft invoices update in real-time as usage is reported and may change before
+     *   finalization
+     * - The response includes both usage-based line items (e.g., API calls, data
+     *   processed) and scheduled charges (e.g., monthly subscriptions, commitment
+     *   fees)
+     * - Credit and commitment applications are shown as separate line items with
+     *   negative amounts
+     * - For voided invoices, the response will indicate VOID status but retain all
+     *   original line item details
      *
      * @example
      * ```ts
@@ -20,11 +60,55 @@ class Invoices extends resource_1.APIResource {
      */
     retrieve(params, options) {
         const { customer_id, invoice_id, ...query } = params;
-        return this._client.get(`/v1/customers/${customer_id}/invoices/${invoice_id}`, { query, ...options });
+        return this._client.get((0, path_1.path) `/v1/customers/${customer_id}/invoices/${invoice_id}`, { query, ...options });
     }
     /**
-     * List all invoices for a given customer, optionally filtered by status, date
-     * range, and/or credit type.
+     * Retrieves a paginated list of invoices for a specific customer, with flexible
+     * filtering options to narrow results by status, date range, credit type, and
+     * more. This endpoint provides a comprehensive view of a customer's billing
+     * history and current charges, supporting both real-time billing dashboards and
+     * historical reporting needs.
+     *
+     * ### Use this endpoint to:
+     *
+     * - Display historical invoice details in customer-facing dashboards or billing
+     *   portals.
+     * - Retrieve current month draft invoices to show customers their month-to-date
+     *   spend.
+     * - Access finalized invoices for historical billing records and payment
+     *   reconciliation.
+     * - Validate customer pricing and credit applications for customer support
+     *   queries.
+     * - Generate financial reports by filtering invoices within specific date ranges
+     *
+     * ### Key response fields:
+     *
+     * Array of invoice objects containing:
+     *
+     * - Invoice ID and status (DRAFT, FINALIZED, VOID)
+     * - Invoice type (USAGE, SCHEDULED)
+     * - Billing period start and end dates
+     * - Issue date and due date
+     * - Total amount, subtotal, and amount due
+     * - Applied credits summary
+     * - Contract ID reference
+     * - External billing provider status (if integrated with Stripe, etc.)
+     * - Pagination metadata `next_page` cursor
+     *
+     * ### Usage guidelines:
+     *
+     * - The endpoint returns invoice summaries; use the Get Invoice endpoint for
+     *   detailed line items
+     * - Draft invoices are continuously updated as new usage is reported and will show
+     *   real-time spend
+     * - Results are ordered by creation date descending by default (newest first)
+     * - When filtering by date range, the filter applies to the billing period, not
+     *   the issue date
+     * - For customers with many invoices, implement pagination to ensure all results
+     *   are retrieved External billing provider statuses (like Stripe payment status)
+     *   are included when applicable
+     * - Voided invoices are included in results by default unless filtered out by
+     *   status
      *
      * @example
      * ```ts
@@ -38,7 +122,7 @@ class Invoices extends resource_1.APIResource {
      */
     list(params, options) {
         const { customer_id, ...query } = params;
-        return this._client.getAPIList(`/v1/customers/${customer_id}/invoices`, InvoicesCursorPage, {
+        return this._client.getAPIList((0, path_1.path) `/v1/customers/${customer_id}/invoices`, (pagination_1.CursorPage), {
             query,
             ...options,
         });
@@ -63,14 +147,47 @@ class Invoices extends resource_1.APIResource {
      */
     addCharge(params, options) {
         const { customer_id, ...body } = params;
-        return this._client.post(`/v1/customers/${customer_id}/addCharge`, { body, ...options });
+        return this._client.post((0, path_1.path) `/v1/customers/${customer_id}/addCharge`, { body, ...options });
     }
     /**
-     * List daily or hourly invoice breakdowns for a given customer, optionally
-     * filtered by status, date range, and/or credit type. Important considerations:
+     * Retrieve granular time-series breakdowns of invoice data at hourly or daily
+     * intervals. This endpoint transforms standard invoices into detailed timelines,
+     * enabling you to track usage patterns, identify consumption spikes, and provide
+     * customers with transparency into their billing details throughout the billing
+     * period.
+     *
+     * ### Use this endpoint to:
+     *
+     * - Build usage analytics dashboards showing daily or hourly consumption trends
+     * - Identify peak usage periods for capacity planning and cost optimization
+     * - Generate detailed billing reports for finance teams and customer success
+     * - Troubleshoot billing disputes by examining usage patterns at specific times
+     * - Power real-time cost monitoring and alerting systems
+     *
+     * ### Key response fields:
      *
-     * - If we receive backdated usage after an invoice has been finalized, the
-     *   backdated usage will be included in the response and usage numbers may differ.
+     * An array of BreakdownInvoice objects, each containing:
+     *
+     * - All standard invoice fields (ID, customer, commit, line items, totals, status)
+     * - Line items with quantities and costs for that specific period
+     * - `breakdown_start_timestamp`: Start of the specific time window
+     * - `breakdown_end_timestamp`: End of the specific time window
+     * - `next_page`: Pagination cursor for large result sets
+     *
+     * ### Usage guidelines:
+     *
+     * - Time granularity: Set `window_size` to hour or day based on your analysis
+     *   needs
+     * - Response limits: Daily breakdowns return up to 35 days; hourly breakdowns
+     *   return up to 24 hours per request
+     * - Date filtering: Use `starting_on` and `ending_before` to focus on specific
+     *   periods
+     * - Performance: For large date ranges, use pagination to retrieve all data
+     *   efficiently
+     * - Backdated usage: If usage events arrive after invoice finalization, breakdowns
+     *   will reflect the updated usage
+     * - Zero quantity filtering: Use `skip_zero_qty_line_items=true` to exclude
+     *   periods with no usage
      *
      * @example
      * ```ts
@@ -88,16 +205,8 @@ class Invoices extends resource_1.APIResource {
      */
     listBreakdowns(params, options) {
         const { customer_id, ...query } = params;
-        return this._client.getAPIList(`/v1/customers/${customer_id}/invoices/breakdowns`, InvoiceListBreakdownsResponsesCursorPage, { query, ...options });
+        return this._client.getAPIList((0, path_1.path) `/v1/customers/${customer_id}/invoices/breakdowns`, (pagination_1.CursorPage), { query, ...options });
     }
 }
 exports.Invoices = Invoices;
-class InvoicesCursorPage extends pagination_1.CursorPage {
-}
-exports.InvoicesCursorPage = InvoicesCursorPage;
-class InvoiceListBreakdownsResponsesCursorPage extends pagination_1.CursorPage {
-}
-exports.InvoiceListBreakdownsResponsesCursorPage = InvoiceListBreakdownsResponsesCursorPage;
-Invoices.InvoicesCursorPage = InvoicesCursorPage;
-Invoices.InvoiceListBreakdownsResponsesCursorPage = InvoiceListBreakdownsResponsesCursorPage;
 //# sourceMappingURL=invoices.js.map

package/resources/v1/customers/invoices.js.map

@@ -1 +1 @@
-{"version":3,"file":"invoices.js","sourceRoot":"","sources":["../../../src/resources/v1/customers/invoices.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,mDAAgD;AAGhD,uDAAwE;AAExE,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,MAA6B,EAC7B,OAA6B;QAE7B,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,WAAW,aAAa,UAAU,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxG,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,MAAyB,EACzB,OAA6B;QAE7B,MAAM,EAAE,WAAW,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,iBAAiB,WAAW,WAAW,EAAE,kBAAkB,EAAE;YAC1F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,SAAS,CACP,MAA8B,EAC9B,OAA6B;QAE7B,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACxC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,WAAW,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,cAAc,CACZ,MAAmC,EACnC,OAA6B;QAE7B,MAAM,EAAE,WAAW,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,iBAAiB,WAAW,sBAAsB,EAClD,wCAAwC,EACxC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF;AAzGD,4BAyGC;AAED,MAAa,kBAAmB,SAAQ,uBAAmB;CAAG;AAA9D,gDAA8D;AAE9D,MAAa,wCAAyC,SAAQ,uBAAyC;CAAG;AAA1G,4FAA0G;AA6lB1G,QAAQ,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;AACjD,QAAQ,CAAC,wCAAwC,GAAG,wCAAwC,CAAC"}
+{"version":3,"file":"invoices.js","sourceRoot":"","sources":["../../../src/resources/v1/customers/invoices.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAGrD,4DAA0F;AAE1F,0DAAoD;AAEpD,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmDG;IACH,QAAQ,CAAC,MAA6B,EAAE,OAAwB;QAC9D,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,iBAAiB,WAAW,aAAa,UAAU,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5G,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyDG;IACH,IAAI,CAAC,MAAyB,EAAE,OAAwB;QACtD,MAAM,EAAE,WAAW,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAA,WAAI,EAAA,iBAAiB,WAAW,WAAW,EAAE,CAAA,uBAAmB,CAAA,EAAE;YAC/F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,SAAS,CAAC,MAA8B,EAAE,OAAwB;QAChE,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACxC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,iBAAiB,WAAW,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqDG;IACH,cAAc,CACZ,MAAmC,EACnC,OAAwB;QAExB,MAAM,EAAE,WAAW,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,iBAAiB,WAAW,sBAAsB,EACtD,CAAA,uBAAyC,CAAA,EACzC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF;AApND,4BAoNC"}