orb-billing 5.75.1 → 6.0.0

package/resources/credit-notes.d.mts

@@ -0,0 +1,144 @@
+import { APIResource } from "../core/resource.mjs";
+import * as Shared from "./shared.mjs";
+import { CreditNotesPage } from "./shared.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { type PageParams, PagePromise } from "../core/pagination.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+/**
+ * The [Credit Note](/invoicing/credit-notes) resource represents a credit that has been applied to a
+ * particular invoice.
+ */
+export declare class CreditNotes extends APIResource {
+    /**
+     * This endpoint is used to create a single
+     * [`Credit Note`](/invoicing/credit-notes).
+     *
+     * The credit note service period configuration supports two explicit modes:
+     *
+     * 1. Global service periods: Specify start_date and end_date at the credit note
+     *    level. These dates will be applied to all line items uniformly.
+     *
+     * 2. Individual service periods: Specify start_date and end_date for each line
+     *    item. When using this mode, ALL line items must have individual periods
+     *    specified.
+     *
+     * 3. Default behavior: If no service periods are specified (neither global nor
+     *    individual), the original invoice line item service periods will be used.
+     *
+     * Note: Mixing global and individual service periods in the same request is not
+     * allowed to prevent confusion.
+     *
+     * Service period dates are normalized to the start of the day in the customer's
+     * timezone to ensure consistent handling across different timezones.
+     *
+     * Date Format: Use start_date and end_date with format "YYYY-MM-DD" (e.g.,
+     * "2023-09-22") to match other Orb APIs like /v1/invoice_line_items.
+     *
+     * Note: Both start_date and end_date are inclusive - the service period will cover
+     * both the start date and end date completely (from start of start_date to end of
+     * end_date).
+     *
+     * @example
+     * ```ts
+     * const creditNote = await client.creditNotes.create({
+     *   line_items: [
+     *     {
+     *       amount: 'amount',
+     *       invoice_line_item_id: '4khy3nwzktxv7',
+     *     },
+     *   ],
+     *   reason: 'duplicate',
+     * });
+     * ```
+     */
+    create(body: CreditNoteCreateParams, options?: RequestOptions): APIPromise<Shared.CreditNote>;
+    /**
+     * Get a paginated list of CreditNotes. Users can also filter by customer_id,
+     * subscription_id, or external_customer_id. The credit notes will be returned in
+     * reverse chronological order by `creation_time`.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const creditNote of client.creditNotes.list()) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query?: CreditNoteListParams | null | undefined, options?: RequestOptions): PagePromise<CreditNotesPage, Shared.CreditNote>;
+    /**
+     * This endpoint is used to fetch a single [`Credit Note`](/invoicing/credit-notes)
+     * given an identifier.
+     *
+     * @example
+     * ```ts
+     * const creditNote = await client.creditNotes.fetch(
+     *   'credit_note_id',
+     * );
+     * ```
+     */
+    fetch(creditNoteId: string, options?: RequestOptions): APIPromise<Shared.CreditNote>;
+}
+export interface CreditNoteCreateParams {
+    line_items: Array<CreditNoteCreateParams.LineItem>;
+    /**
+     * An optional reason for the credit note.
+     */
+    reason: 'duplicate' | 'fraudulent' | 'order_change' | 'product_unsatisfactory';
+    /**
+     * A date string to specify the global credit note service period end date in the
+     * customer's timezone. This will be applied to all line items that don't have
+     * their own individual service periods specified. If not provided, line items will
+     * use their original invoice line item service periods. This date is inclusive.
+     */
+    end_date?: string | null;
+    /**
+     * An optional memo to attach to the credit note.
+     */
+    memo?: string | null;
+    /**
+     * A date string to specify the global credit note service period start date in the
+     * customer's timezone. This will be applied to all line items that don't have
+     * their own individual service periods specified. If not provided, line items will
+     * use their original invoice line item service periods. This date is inclusive.
+     */
+    start_date?: string | null;
+}
+export declare namespace CreditNoteCreateParams {
+    interface LineItem {
+        /**
+         * The total amount in the invoice's currency to credit this line item.
+         */
+        amount: string;
+        /**
+         * The ID of the line item to credit.
+         */
+        invoice_line_item_id: string;
+        /**
+         * A date string to specify this line item's credit note service period end date in
+         * the customer's timezone. If provided, this will be used for this specific line
+         * item. If not provided, will use the global end_date if available, otherwise
+         * defaults to the original invoice line item's end date. This date is inclusive.
+         */
+        end_date?: string | null;
+        /**
+         * A date string to specify this line item's credit note service period start date
+         * in the customer's timezone. If provided, this will be used for this specific
+         * line item. If not provided, will use the global start_date if available,
+         * otherwise defaults to the original invoice line item's start date. This date is
+         * inclusive.
+         */
+        start_date?: string | null;
+    }
+}
+export interface CreditNoteListParams extends PageParams {
+    'created_at[gt]'?: string | null;
+    'created_at[gte]'?: string | null;
+    'created_at[lt]'?: string | null;
+    'created_at[lte]'?: string | null;
+}
+export declare namespace CreditNotes {
+    export { type CreditNoteCreateParams as CreditNoteCreateParams, type CreditNoteListParams as CreditNoteListParams, };
+}
+export { type CreditNotesPage };
+//# sourceMappingURL=credit-notes.d.mts.map

package/resources/credit-notes.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"credit-notes.d.mts","sourceRoot":"","sources":["../src/resources/credit-notes.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,KAAK,MAAM,qBAAiB;AACnC,OAAO,EAAE,eAAe,EAAE,qBAAiB;AAC3C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAQ,KAAK,UAAU,EAAE,WAAW,EAAE,+BAA2B;AACxE,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D;;;GAGG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,MAAM,CAAC,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAI7F;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,eAAe,EAAE,MAAM,CAAC,UAAU,CAAC;IAIlD;;;;;;;;;;OAUG;IACH,KAAK,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;CAGrF;AAED,MAAM,WAAW,sBAAsB;IACrC,UAAU,EAAE,KAAK,CAAC,sBAAsB,CAAC,QAAQ,CAAC,CAAC;IAEnD;;OAEG;IACH,MAAM,EAAE,WAAW,GAAG,YAAY,GAAG,cAAc,GAAG,wBAAwB,CAAC;IAE/E;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,QAAQ;QACvB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,oBAAoB,EAAE,MAAM,CAAC;QAE7B;;;;;WAKG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;;;;;WAMG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;CACF;AAED,MAAM,WAAW,oBAAqB,SAAQ,UAAU;IACtD,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACnC;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH;AAED,OAAO,EAAE,KAAK,eAAe,EAAE,CAAC"}

package/resources/credit-notes.d.ts

@@ -1,8 +1,9 @@
-import { APIResource } from "../resource.js";
-import * as Core from "../core.js";
+import { APIResource } from "../core/resource.js";
 import * as Shared from "./shared.js";
 import { CreditNotesPage } from "./shared.js";
-import { type PageParams } from "../pagination.js";
+import { APIPromise } from "../core/api-promise.js";
+import { type PageParams, PagePromise } from "../core/pagination.js";
+import { RequestOptions } from "../internal/request-options.js";
 /**
  * The [Credit Note](/invoicing/credit-notes) resource represents a credit that has been applied to a
  * particular invoice.
@@ -50,7 +51,7 @@ export declare class CreditNotes extends APIResource {
      * });
      * ```
      */
-    create(body: CreditNoteCreateParams, options?: Core.RequestOptions): Core.APIPromise<Shared.CreditNote>;
+    create(body: CreditNoteCreateParams, options?: RequestOptions): APIPromise<Shared.CreditNote>;
     /**
      * Get a paginated list of CreditNotes. Users can also filter by customer_id,
      * subscription_id, or external_customer_id. The credit notes will be returned in
@@ -64,8 +65,7 @@ export declare class CreditNotes extends APIResource {
      * }
      * ```
      */
-    list(query?: CreditNoteListParams, options?: Core.RequestOptions): Core.PagePromise<CreditNotesPage, Shared.CreditNote>;
-    list(options?: Core.RequestOptions): Core.PagePromise<CreditNotesPage, Shared.CreditNote>;
+    list(query?: CreditNoteListParams | null | undefined, options?: RequestOptions): PagePromise<CreditNotesPage, Shared.CreditNote>;
     /**
      * This endpoint is used to fetch a single [`Credit Note`](/invoicing/credit-notes)
      * given an identifier.
@@ -77,7 +77,7 @@ export declare class CreditNotes extends APIResource {
      * );
      * ```
      */
-    fetch(creditNoteId: string, options?: Core.RequestOptions): Core.APIPromise<Shared.CreditNote>;
+    fetch(creditNoteId: string, options?: RequestOptions): APIPromise<Shared.CreditNote>;
 }
 export interface CreditNoteCreateParams {
     line_items: Array<CreditNoteCreateParams.LineItem>;
@@ -140,5 +140,5 @@ export interface CreditNoteListParams extends PageParams {
 export declare namespace CreditNotes {
     export { type CreditNoteCreateParams as CreditNoteCreateParams, type CreditNoteListParams as CreditNoteListParams, };
 }
-export { CreditNotesPage };
+export { type CreditNotesPage };
 //# sourceMappingURL=credit-notes.d.ts.map

package/resources/credit-notes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"credit-notes.d.ts","sourceRoot":"","sources":["../src/resources/credit-notes.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAC3C,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,eAAe,CAAC;AAEhD;;;GAGG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,MAAM,CAAC,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAIvG;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,KAAK,CAAC,EAAE,oBAAoB,EAC5B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,eAAe,EAAE,MAAM,CAAC,UAAU,CAAC;IACvD,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,eAAe,EAAE,MAAM,CAAC,UAAU,CAAC;IAWzF;;;;;;;;;;OAUG;IACH,KAAK,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;CAG/F;AAED,MAAM,WAAW,sBAAsB;IACrC,UAAU,EAAE,KAAK,CAAC,sBAAsB,CAAC,QAAQ,CAAC,CAAC;IAEnD;;OAEG;IACH,MAAM,EAAE,WAAW,GAAG,YAAY,GAAG,cAAc,GAAG,wBAAwB,CAAC;IAE/E;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,QAAQ;QACvB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,oBAAoB,EAAE,MAAM,CAAC;QAE7B;;;;;WAKG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;;;;;WAMG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;CACF;AAED,MAAM,WAAW,oBAAqB,SAAQ,UAAU;IACtD,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACnC;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH;AAED,OAAO,EAAE,eAAe,EAAE,CAAC"}
+{"version":3,"file":"credit-notes.d.ts","sourceRoot":"","sources":["../src/resources/credit-notes.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,KAAK,MAAM,oBAAiB;AACnC,OAAO,EAAE,eAAe,EAAE,oBAAiB;AAC3C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAQ,KAAK,UAAU,EAAE,WAAW,EAAE,8BAA2B;AACxE,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D;;;GAGG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,MAAM,CAAC,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAI7F;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,eAAe,EAAE,MAAM,CAAC,UAAU,CAAC;IAIlD;;;;;;;;;;OAUG;IACH,KAAK,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;CAGrF;AAED,MAAM,WAAW,sBAAsB;IACrC,UAAU,EAAE,KAAK,CAAC,sBAAsB,CAAC,QAAQ,CAAC,CAAC;IAEnD;;OAEG;IACH,MAAM,EAAE,WAAW,GAAG,YAAY,GAAG,cAAc,GAAG,wBAAwB,CAAC;IAE/E;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,QAAQ;QACvB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,oBAAoB,EAAE,MAAM,CAAC;QAE7B;;;;;WAKG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;;;;;WAMG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;CACF;AAED,MAAM,WAAW,oBAAqB,SAAQ,UAAU;IACtD,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACnC;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH;AAED,OAAO,EAAE,KAAK,eAAe,EAAE,CAAC"}

package/resources/credit-notes.js

@@ -1,11 +1,10 @@
 "use strict";
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CreditNotesPage = exports.CreditNotes = void 0;
-const resource_1 = require("../resource.js");
-const core_1 = require("../core.js");
-const shared_1 = require("./shared.js");
-Object.defineProperty(exports, "CreditNotesPage", { enumerable: true, get: function () { return shared_1.CreditNotesPage; } });
+exports.CreditNotes = void 0;
+const resource_1 = require("../core/resource.js");
+const pagination_1 = require("../core/pagination.js");
+const path_1 = require("../internal/utils/path.js");
 /**
  * The [Credit Note](/invoicing/credit-notes) resource represents a credit that has been applied to a
  * particular invoice.
@@ -56,11 +55,21 @@ class CreditNotes extends resource_1.APIResource {
     create(body, options) {
         return this._client.post('/credit_notes', { body, ...options });
     }
+    /**
+     * Get a paginated list of CreditNotes. Users can also filter by customer_id,
+     * subscription_id, or external_customer_id. The credit notes will be returned in
+     * reverse chronological order by `creation_time`.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const creditNote of client.creditNotes.list()) {
+     *   // ...
+     * }
+     * ```
+     */
     list(query = {}, options) {
-        if ((0, core_1.isRequestOptions)(query)) {
-            return this.list({}, query);
-        }
-        return this._client.getAPIList('/credit_notes', shared_1.CreditNotesPage, { query, ...options });
+        return this._client.getAPIList('/credit_notes', (pagination_1.Page), { query, ...options });
     }
     /**
      * This endpoint is used to fetch a single [`Credit Note`](/invoicing/credit-notes)
@@ -74,7 +83,7 @@ class CreditNotes extends resource_1.APIResource {
      * ```
      */
     fetch(creditNoteId, options) {
-        return this._client.get(`/credit_notes/${creditNoteId}`, options);
+        return this._client.get((0, path_1.path) `/credit_notes/${creditNoteId}`, options);
     }
 }
 exports.CreditNotes = CreditNotes;

package/resources/credit-notes.js.map

@@ -1 +1 @@
-{"version":3,"file":"credit-notes.js","sourceRoot":"","sources":["../src/resources/credit-notes.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAC1C,qCAA2C;AAG3C,wCAA2C;AAgLlC,gGAhLA,wBAAe,OAgLA;AA7KxB;;;GAGG;AACH,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,MAAM,CAAC,IAA4B,EAAE,OAA6B;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;IAoBD,IAAI,CACF,QAAoD,EAAE,EACtD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,eAAe,EAAE,wBAAe,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,YAAoB,EAAE,OAA6B;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,YAAY,EAAE,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;CACF;AAzFD,kCAyFC"}
+{"version":3,"file":"credit-notes.js","sourceRoot":"","sources":["../src/resources/credit-notes.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,sDAAwE;AAExE,oDAA8C;AAE9C;;;GAGG;AACH,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,MAAM,CAAC,IAA4B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,QAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,eAAe,EAAE,CAAA,iBAAuB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClG,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,YAAoB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,iBAAiB,YAAY,EAAE,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;CACF;AAjFD,kCAiFC"}

package/resources/credit-notes.mjs

@@ -1,7 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-import { APIResource } from "../resource.mjs";
-import { isRequestOptions } from "../core.mjs";
-import { CreditNotesPage } from "./shared.mjs";
+import { APIResource } from "../core/resource.mjs";
+import { Page } from "../core/pagination.mjs";
+import { path } from "../internal/utils/path.mjs";
 /**
  * The [Credit Note](/invoicing/credit-notes) resource represents a credit that has been applied to a
  * particular invoice.
@@ -52,11 +52,21 @@ export class CreditNotes extends APIResource {
     create(body, options) {
         return this._client.post('/credit_notes', { body, ...options });
     }
+    /**
+     * Get a paginated list of CreditNotes. Users can also filter by customer_id,
+     * subscription_id, or external_customer_id. The credit notes will be returned in
+     * reverse chronological order by `creation_time`.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const creditNote of client.creditNotes.list()) {
+     *   // ...
+     * }
+     * ```
+     */
     list(query = {}, options) {
-        if (isRequestOptions(query)) {
-            return this.list({}, query);
-        }
-        return this._client.getAPIList('/credit_notes', CreditNotesPage, { query, ...options });
+        return this._client.getAPIList('/credit_notes', (Page), { query, ...options });
     }
     /**
      * This endpoint is used to fetch a single [`Credit Note`](/invoicing/credit-notes)
@@ -70,8 +80,7 @@ export class CreditNotes extends APIResource {
      * ```
      */
     fetch(creditNoteId, options) {
-        return this._client.get(`/credit_notes/${creditNoteId}`, options);
+        return this._client.get(path `/credit_notes/${creditNoteId}`, options);
     }
 }
-export { CreditNotesPage };
 //# sourceMappingURL=credit-notes.mjs.map

package/resources/credit-notes.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"credit-notes.mjs","sourceRoot":"","sources":["../src/resources/credit-notes.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAGpB,EAAE,eAAe,EAAE;AAG1B;;;GAGG;AACH,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,MAAM,CAAC,IAA4B,EAAE,OAA6B;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;IAoBD,IAAI,CACF,QAAoD,EAAE,EACtD,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,eAAe,EAAE,eAAe,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,YAAoB,EAAE,OAA6B;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,YAAY,EAAE,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;CACF;AAgFD,OAAO,EAAE,eAAe,EAAE,CAAC"}
+{"version":3,"file":"credit-notes.mjs","sourceRoot":"","sources":["../src/resources/credit-notes.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAI/C,OAAO,EAAE,IAAI,EAAgC,+BAA2B;AAExE,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C;;;GAGG;AACH,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,MAAM,CAAC,IAA4B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,QAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,eAAe,EAAE,CAAA,IAAuB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClG,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,YAAoB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,iBAAiB,YAAY,EAAE,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;CACF"}

package/resources/customers/balance-transactions.d.mts

@@ -0,0 +1,135 @@
+import { APIResource } from "../../core/resource.mjs";
+import * as Shared from "../shared.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { Page, type PageParams, PagePromise } from "../../core/pagination.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+/**
+ * A customer is a buyer of your products, and the other party to the billing relationship.
+ *
+ * In Orb, customers are assigned system generated identifiers automatically, but it's often desirable to have these
+ * match existing identifiers in your system. To avoid having to denormalize Orb ID information, you can pass in an
+ * `external_customer_id` with your own identifier. See
+ * [Customer ID Aliases](/events-and-metrics/customer-aliases) for further information about how these
+ * aliases work in Orb.
+ *
+ * In addition to having an identifier in your system, a customer may exist in a payment provider solution like
+ * Stripe. Use the `payment_provider_id` and the `payment_provider` enum field to express this mapping.
+ *
+ * A customer also has a timezone (from the standard [IANA timezone database](https://www.iana.org/time-zones)), which
+ * defaults to your account's timezone. See [Timezone localization](/essentials/timezones) for
+ * information on what this timezone parameter influences within Orb.
+ */
+export declare class BalanceTransactions extends APIResource {
+    /**
+     * Creates an immutable balance transaction that updates the customer's balance and
+     * returns back the newly created transaction.
+     */
+    create(customerId: string, body: BalanceTransactionCreateParams, options?: RequestOptions): APIPromise<BalanceTransactionCreateResponse>;
+    /**
+     * ## The customer balance
+     *
+     * The customer balance is an amount in the customer's currency, which Orb
+     * automatically applies to subsequent invoices. This balance can be adjusted
+     * manually via Orb's webapp on the customer details page. You can use this balance
+     * to provide a fixed mid-period credit to the customer. Commonly, this is done due
+     * to system downtime/SLA violation, or an adhoc adjustment discussed with the
+     * customer.
+     *
+     * If the balance is a positive value at the time of invoicing, it represents that
+     * the customer has credit that should be used to offset the amount due on the next
+     * issued invoice. In this case, Orb will automatically reduce the next invoice by
+     * the balance amount, and roll over any remaining balance if the invoice is fully
+     * discounted.
+     *
+     * If the balance is a negative value at the time of invoicing, Orb will increase
+     * the invoice's amount due with a positive adjustment, and reset the balance to 0.
+     *
+     * This endpoint retrieves all customer balance transactions in reverse
+     * chronological order for a single customer, providing a complete audit trail of
+     * all adjustments and invoice applications.
+     */
+    list(customerId: string, query?: BalanceTransactionListParams | null | undefined, options?: RequestOptions): PagePromise<BalanceTransactionListResponsesPage, BalanceTransactionListResponse>;
+}
+export type BalanceTransactionListResponsesPage = Page<BalanceTransactionListResponse>;
+export interface BalanceTransactionCreateResponse {
+    /**
+     * A unique id for this transaction.
+     */
+    id: string;
+    action: 'applied_to_invoice' | 'manual_adjustment' | 'prorated_refund' | 'revert_prorated_refund' | 'return_from_voiding' | 'credit_note_applied' | 'credit_note_voided' | 'overpayment_refund' | 'external_payment' | 'small_invoice_carryover';
+    /**
+     * The value of the amount changed in the transaction.
+     */
+    amount: string;
+    /**
+     * The creation time of this transaction.
+     */
+    created_at: string;
+    credit_note: Shared.CreditNoteTiny | null;
+    /**
+     * An optional description provided for manual customer balance adjustments.
+     */
+    description: string | null;
+    /**
+     * The new value of the customer's balance prior to the transaction, in the
+     * customer's currency.
+     */
+    ending_balance: string;
+    invoice: Shared.InvoiceTiny | null;
+    /**
+     * The original value of the customer's balance prior to the transaction, in the
+     * customer's currency.
+     */
+    starting_balance: string;
+    type: 'increment' | 'decrement';
+}
+export interface BalanceTransactionListResponse {
+    /**
+     * A unique id for this transaction.
+     */
+    id: string;
+    action: 'applied_to_invoice' | 'manual_adjustment' | 'prorated_refund' | 'revert_prorated_refund' | 'return_from_voiding' | 'credit_note_applied' | 'credit_note_voided' | 'overpayment_refund' | 'external_payment' | 'small_invoice_carryover';
+    /**
+     * The value of the amount changed in the transaction.
+     */
+    amount: string;
+    /**
+     * The creation time of this transaction.
+     */
+    created_at: string;
+    credit_note: Shared.CreditNoteTiny | null;
+    /**
+     * An optional description provided for manual customer balance adjustments.
+     */
+    description: string | null;
+    /**
+     * The new value of the customer's balance prior to the transaction, in the
+     * customer's currency.
+     */
+    ending_balance: string;
+    invoice: Shared.InvoiceTiny | null;
+    /**
+     * The original value of the customer's balance prior to the transaction, in the
+     * customer's currency.
+     */
+    starting_balance: string;
+    type: 'increment' | 'decrement';
+}
+export interface BalanceTransactionCreateParams {
+    amount: string;
+    type: 'increment' | 'decrement';
+    /**
+     * An optional description that can be specified around this entry.
+     */
+    description?: string | null;
+}
+export interface BalanceTransactionListParams extends PageParams {
+    'operation_time[gt]'?: string | null;
+    'operation_time[gte]'?: string | null;
+    'operation_time[lt]'?: string | null;
+    'operation_time[lte]'?: string | null;
+}
+export declare namespace BalanceTransactions {
+    export { type BalanceTransactionCreateResponse as BalanceTransactionCreateResponse, type BalanceTransactionListResponse as BalanceTransactionListResponse, type BalanceTransactionListResponsesPage as BalanceTransactionListResponsesPage, type BalanceTransactionCreateParams as BalanceTransactionCreateParams, type BalanceTransactionListParams as BalanceTransactionListParams, };
+}
+//# sourceMappingURL=balance-transactions.d.mts.map

package/resources/customers/balance-transactions.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"balance-transactions.d.mts","sourceRoot":"","sources":["../../src/resources/customers/balance-transactions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,MAAM,sBAAkB;AACpC,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,WAAW,EAAE,kCAA8B;AAC3E,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,mBAAoB,SAAQ,WAAW;IAClD;;;OAGG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,8BAA8B,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gCAAgC,CAAC;IAI/C;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,IAAI,CACF,UAAU,EAAE,MAAM,EAClB,KAAK,GAAE,4BAA4B,GAAG,IAAI,GAAG,SAAc,EAC3D,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,mCAAmC,EAAE,8BAA8B,CAAC;CAOpF;AAED,MAAM,MAAM,mCAAmC,GAAG,IAAI,CAAC,8BAA8B,CAAC,CAAC;AAEvF,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,MAAM,EACF,oBAAoB,GACpB,mBAAmB,GACnB,iBAAiB,GACjB,wBAAwB,GACxB,qBAAqB,GACrB,qBAAqB,GACrB,oBAAoB,GACpB,oBAAoB,GACpB,kBAAkB,GAClB,yBAAyB,CAAC;IAE9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB,WAAW,EAAE,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB,OAAO,EAAE,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB,IAAI,EAAE,WAAW,GAAG,WAAW,CAAC;CACjC;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,MAAM,EACF,oBAAoB,GACpB,mBAAmB,GACnB,iBAAiB,GACjB,wBAAwB,GACxB,qBAAqB,GACrB,qBAAqB,GACrB,oBAAoB,GACpB,oBAAoB,GACpB,kBAAkB,GAClB,yBAAyB,CAAC;IAE9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB,WAAW,EAAE,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB,OAAO,EAAE,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB,IAAI,EAAE,WAAW,GAAG,WAAW,CAAC;CACjC;AAED,MAAM,WAAW,8BAA8B;IAC7C,MAAM,EAAE,MAAM,CAAC;IAEf,IAAI,EAAE,WAAW,GAAG,WAAW,CAAC;IAEhC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,MAAM,WAAW,4BAA6B,SAAQ,UAAU;IAC9D,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvC;AAED,MAAM,CAAC,OAAO,WAAW,mBAAmB,CAAC;IAC3C,OAAO,EACL,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}

package/resources/customers/balance-transactions.d.ts

@@ -1,7 +1,8 @@
-import { APIResource } from "../../resource.js";
-import * as Core from "../../core.js";
+import { APIResource } from "../../core/resource.js";
 import * as Shared from "../shared.js";
-import { Page, type PageParams } from "../../pagination.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { Page, type PageParams, PagePromise } from "../../core/pagination.js";
+import { RequestOptions } from "../../internal/request-options.js";
 /**
  * A customer is a buyer of your products, and the other party to the billing relationship.
  *
@@ -23,7 +24,7 @@ export declare class BalanceTransactions extends APIResource {
      * Creates an immutable balance transaction that updates the customer's balance and
      * returns back the newly created transaction.
      */
-    create(customerId: string, body: BalanceTransactionCreateParams, options?: Core.RequestOptions): Core.APIPromise<BalanceTransactionCreateResponse>;
+    create(customerId: string, body: BalanceTransactionCreateParams, options?: RequestOptions): APIPromise<BalanceTransactionCreateResponse>;
     /**
      * ## The customer balance
      *
@@ -47,11 +48,9 @@ export declare class BalanceTransactions extends APIResource {
      * chronological order for a single customer, providing a complete audit trail of
      * all adjustments and invoice applications.
      */
-    list(customerId: string, query?: BalanceTransactionListParams, options?: Core.RequestOptions): Core.PagePromise<BalanceTransactionListResponsesPage, BalanceTransactionListResponse>;
-    list(customerId: string, options?: Core.RequestOptions): Core.PagePromise<BalanceTransactionListResponsesPage, BalanceTransactionListResponse>;
-}
-export declare class BalanceTransactionListResponsesPage extends Page<BalanceTransactionListResponse> {
+    list(customerId: string, query?: BalanceTransactionListParams | null | undefined, options?: RequestOptions): PagePromise<BalanceTransactionListResponsesPage, BalanceTransactionListResponse>;
 }
+export type BalanceTransactionListResponsesPage = Page<BalanceTransactionListResponse>;
 export interface BalanceTransactionCreateResponse {
     /**
      * A unique id for this transaction.
@@ -131,6 +130,6 @@ export interface BalanceTransactionListParams extends PageParams {
     'operation_time[lte]'?: string | null;
 }
 export declare namespace BalanceTransactions {
-    export { type BalanceTransactionCreateResponse as BalanceTransactionCreateResponse, type BalanceTransactionListResponse as BalanceTransactionListResponse, BalanceTransactionListResponsesPage as BalanceTransactionListResponsesPage, type BalanceTransactionCreateParams as BalanceTransactionCreateParams, type BalanceTransactionListParams as BalanceTransactionListParams, };
+    export { type BalanceTransactionCreateResponse as BalanceTransactionCreateResponse, type BalanceTransactionListResponse as BalanceTransactionListResponse, type BalanceTransactionListResponsesPage as BalanceTransactionListResponsesPage, type BalanceTransactionCreateParams as BalanceTransactionCreateParams, type BalanceTransactionListParams as BalanceTransactionListParams, };
 }
 //# sourceMappingURL=balance-transactions.d.ts.map

package/resources/customers/balance-transactions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"balance-transactions.d.ts","sourceRoot":"","sources":["../../src/resources/customers/balance-transactions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,MAAM,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEzD;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,mBAAoB,SAAQ,WAAW;IAClD;;;OAGG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,8BAA8B,EACpC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,gCAAgC,CAAC;IAIpD;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,IAAI,CACF,UAAU,EAAE,MAAM,EAClB,KAAK,CAAC,EAAE,4BAA4B,EACpC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,mCAAmC,EAAE,8BAA8B,CAAC;IACxF,IAAI,CACF,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,mCAAmC,EAAE,8BAA8B,CAAC;CAezF;AAED,qBAAa,mCAAoC,SAAQ,IAAI,CAAC,8BAA8B,CAAC;CAAG;AAEhG,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,MAAM,EACF,oBAAoB,GACpB,mBAAmB,GACnB,iBAAiB,GACjB,wBAAwB,GACxB,qBAAqB,GACrB,qBAAqB,GACrB,oBAAoB,GACpB,oBAAoB,GACpB,kBAAkB,GAClB,yBAAyB,CAAC;IAE9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB,WAAW,EAAE,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB,OAAO,EAAE,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB,IAAI,EAAE,WAAW,GAAG,WAAW,CAAC;CACjC;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,MAAM,EACF,oBAAoB,GACpB,mBAAmB,GACnB,iBAAiB,GACjB,wBAAwB,GACxB,qBAAqB,GACrB,qBAAqB,GACrB,oBAAoB,GACpB,oBAAoB,GACpB,kBAAkB,GAClB,yBAAyB,CAAC;IAE9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB,WAAW,EAAE,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB,OAAO,EAAE,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB,IAAI,EAAE,WAAW,GAAG,WAAW,CAAC;CACjC;AAED,MAAM,WAAW,8BAA8B;IAC7C,MAAM,EAAE,MAAM,CAAC;IAEf,IAAI,EAAE,WAAW,GAAG,WAAW,CAAC;IAEhC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,MAAM,WAAW,4BAA6B,SAAQ,UAAU;IAC9D,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvC;AAID,MAAM,CAAC,OAAO,WAAW,mBAAmB,CAAC;IAC3C,OAAO,EACL,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,mCAAmC,IAAI,mCAAmC,EAC1E,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
+{"version":3,"file":"balance-transactions.d.ts","sourceRoot":"","sources":["../../src/resources/customers/balance-transactions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,MAAM,qBAAkB;AACpC,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,WAAW,EAAE,iCAA8B;AAC3E,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,mBAAoB,SAAQ,WAAW;IAClD;;;OAGG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,8BAA8B,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gCAAgC,CAAC;IAI/C;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,IAAI,CACF,UAAU,EAAE,MAAM,EAClB,KAAK,GAAE,4BAA4B,GAAG,IAAI,GAAG,SAAc,EAC3D,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,mCAAmC,EAAE,8BAA8B,CAAC;CAOpF;AAED,MAAM,MAAM,mCAAmC,GAAG,IAAI,CAAC,8BAA8B,CAAC,CAAC;AAEvF,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,MAAM,EACF,oBAAoB,GACpB,mBAAmB,GACnB,iBAAiB,GACjB,wBAAwB,GACxB,qBAAqB,GACrB,qBAAqB,GACrB,oBAAoB,GACpB,oBAAoB,GACpB,kBAAkB,GAClB,yBAAyB,CAAC;IAE9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB,WAAW,EAAE,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB,OAAO,EAAE,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB,IAAI,EAAE,WAAW,GAAG,WAAW,CAAC;CACjC;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,MAAM,EACF,oBAAoB,GACpB,mBAAmB,GACnB,iBAAiB,GACjB,wBAAwB,GACxB,qBAAqB,GACrB,qBAAqB,GACrB,oBAAoB,GACpB,oBAAoB,GACpB,kBAAkB,GAClB,yBAAyB,CAAC;IAE9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB,WAAW,EAAE,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB,OAAO,EAAE,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB,IAAI,EAAE,WAAW,GAAG,WAAW,CAAC;CACjC;AAED,MAAM,WAAW,8BAA8B;IAC7C,MAAM,EAAE,MAAM,CAAC;IAEf,IAAI,EAAE,WAAW,GAAG,WAAW,CAAC;IAEhC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,MAAM,WAAW,4BAA6B,SAAQ,UAAU;IAC9D,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvC;AAED,MAAM,CAAC,OAAO,WAAW,mBAAmB,CAAC;IAC3C,OAAO,EACL,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}

package/resources/customers/balance-transactions.js

@@ -1,10 +1,10 @@
 "use strict";
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BalanceTransactionListResponsesPage = exports.BalanceTransactions = void 0;
-const resource_1 = require("../../resource.js");
-const core_1 = require("../../core.js");
-const pagination_1 = require("../../pagination.js");
+exports.BalanceTransactions = void 0;
+const resource_1 = require("../../core/resource.js");
+const pagination_1 = require("../../core/pagination.js");
+const path_1 = require("../../internal/utils/path.js");
 /**
  * A customer is a buyer of your products, and the other party to the billing relationship.
  *
@@ -27,18 +27,34 @@ class BalanceTransactions extends resource_1.APIResource {
      * returns back the newly created transaction.
      */
     create(customerId, body, options) {
-        return this._client.post(`/customers/${customerId}/balance_transactions`, { body, ...options });
+        return this._client.post((0, path_1.path) `/customers/${customerId}/balance_transactions`, { body, ...options });
     }
+    /**
+     * ## The customer balance
+     *
+     * The customer balance is an amount in the customer's currency, which Orb
+     * automatically applies to subsequent invoices. This balance can be adjusted
+     * manually via Orb's webapp on the customer details page. You can use this balance
+     * to provide a fixed mid-period credit to the customer. Commonly, this is done due
+     * to system downtime/SLA violation, or an adhoc adjustment discussed with the
+     * customer.
+     *
+     * If the balance is a positive value at the time of invoicing, it represents that
+     * the customer has credit that should be used to offset the amount due on the next
+     * issued invoice. In this case, Orb will automatically reduce the next invoice by
+     * the balance amount, and roll over any remaining balance if the invoice is fully
+     * discounted.
+     *
+     * If the balance is a negative value at the time of invoicing, Orb will increase
+     * the invoice's amount due with a positive adjustment, and reset the balance to 0.
+     *
+     * This endpoint retrieves all customer balance transactions in reverse
+     * chronological order for a single customer, providing a complete audit trail of
+     * all adjustments and invoice applications.
+     */
     list(customerId, query = {}, options) {
-        if ((0, core_1.isRequestOptions)(query)) {
-            return this.list(customerId, {}, query);
-        }
-        return this._client.getAPIList(`/customers/${customerId}/balance_transactions`, BalanceTransactionListResponsesPage, { query, ...options });
+        return this._client.getAPIList((0, path_1.path) `/customers/${customerId}/balance_transactions`, (pagination_1.Page), { query, ...options });
     }
 }
 exports.BalanceTransactions = BalanceTransactions;
-class BalanceTransactionListResponsesPage extends pagination_1.Page {
-}
-exports.BalanceTransactionListResponsesPage = BalanceTransactionListResponsesPage;
-BalanceTransactions.BalanceTransactionListResponsesPage = BalanceTransactionListResponsesPage;
 //# sourceMappingURL=balance-transactions.js.map

package/resources/customers/balance-transactions.js.map

@@ -1 +1 @@
-{"version":3,"file":"balance-transactions.js","sourceRoot":"","sources":["../../src/resources/customers/balance-transactions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAG9C,oDAAyD;AAEzD;;;;;;;;;;;;;;;GAeG;AACH,MAAa,mBAAoB,SAAQ,sBAAW;IAClD;;;OAGG;IACH,MAAM,CACJ,UAAkB,EAClB,IAAoC,EACpC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,UAAU,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClG,CAAC;IAkCD,IAAI,CACF,UAAkB,EAClB,QAA4D,EAAE,EAC9D,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACzC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,cAAc,UAAU,uBAAuB,EAC/C,mCAAmC,EACnC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF;AA3DD,kDA2DC;AAED,MAAa,mCAAoC,SAAQ,iBAAoC;CAAG;AAAhG,kFAAgG;AA+HhG,mBAAmB,CAAC,mCAAmC,GAAG,mCAAmC,CAAC"}
+{"version":3,"file":"balance-transactions.js","sourceRoot":"","sources":["../../src/resources/customers/balance-transactions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAGlD,yDAA2E;AAE3E,uDAAiD;AAEjD;;;;;;;;;;;;;;;GAeG;AACH,MAAa,mBAAoB,SAAQ,sBAAW;IAClD;;;OAGG;IACH,MAAM,CACJ,UAAkB,EAClB,IAAoC,EACpC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,cAAc,UAAU,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtG,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,IAAI,CACF,UAAkB,EAClB,QAAyD,EAAE,EAC3D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,cAAc,UAAU,uBAAuB,EACnD,CAAA,iBAAoC,CAAA,EACpC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF;AA/CD,kDA+CC"}