@metronome/sdk 0.3.0 → 2.0.0

package/resources/v1/invoices.d.ts

@@ -1,8 +1,26 @@
-import { APIResource } from "../../resource.js";
-import * as Core from "../../core.js";
+import { APIResource } from "../../core/resource.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
 export declare class Invoices extends APIResource {
     /**
-     * Regenerate a voided contract invoice
+     * This endpoint regenerates a voided invoice and recalculates the invoice based on
+     * up-to-date rates, available balances, and other fees regardless of the billing
+     * period.
+     *
+     * ### Use this endpoint to:
+     *
+     * Recalculate an invoice with updated rate terms, available balance, and fees to
+     * correct billing disputes or discrepancies
+     *
+     * ### Key response fields:
+     *
+     * The regenerated invoice id, which is distinct from the previously voided
+     * invoice.
+     *
+     * ### Usage guidelines:
+     *
+     * If an invoice is attached to a contract with a billing provider on it, the
+     * regenerated invoice will be distributed based on the configuration.
      *
      * @example
      * ```ts
@@ -11,9 +29,13 @@ export declare class Invoices extends APIResource {
      * });
      * ```
      */
-    regenerate(body: InvoiceRegenerateParams, options?: Core.RequestOptions): Core.APIPromise<InvoiceRegenerateResponse>;
+    regenerate(body: InvoiceRegenerateParams, options?: RequestOptions): APIPromise<InvoiceRegenerateResponse>;
     /**
-     * Void an invoice
+     * Permanently cancels an invoice by setting its status to voided, preventing
+     * collection and removing it from customer billing. Use this to correct billing
+     * errors, cancel incorrect charges, or handle disputed invoices that should not be
+     * collected. Returns the voided invoice ID with the status change applied
+     * immediately to stop any payment processing.
      *
      * @example
      * ```ts
@@ -22,7 +44,7 @@ export declare class Invoices extends APIResource {
      * });
      * ```
      */
-    void(body: InvoiceVoidParams, options?: Core.RequestOptions): Core.APIPromise<InvoiceVoidResponse>;
+    void(body: InvoiceVoidParams, options?: RequestOptions): APIPromise<InvoiceVoidResponse>;
 }
 export interface InvoiceRegenerateResponse {
     data?: InvoiceRegenerateResponse.Data;

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

@@ -1 +1 @@
-{"version":3,"file":"invoices.d.ts","sourceRoot":"","sources":["../../src/resources/v1/invoices.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AAEnC,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;OASG;IACH,UAAU,CACR,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,yBAAyB,CAAC;IAI7C;;;;;;;;;OASG;IACH,IAAI,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;CAGnG;AAED,MAAM,WAAW,yBAAyB;IACxC,IAAI,CAAC,EAAE,yBAAyB,CAAC,IAAI,CAAC;CACvC;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,CAAC,EAAE,mBAAmB,CAAC,IAAI,CAAC;CACjC;AAED,yBAAiB,mBAAmB,CAAC;IACnC,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}
+{"version":3,"file":"invoices.d.ts","sourceRoot":"","sources":["../../src/resources/v1/invoices.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,UAAU,CAAC,IAAI,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;IAI1G;;;;;;;;;;;;;OAaG;IACH,IAAI,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;CAGzF;AAED,MAAM,WAAW,yBAAyB;IACxC,IAAI,CAAC,EAAE,yBAAyB,CAAC,IAAI,CAAC;CACvC;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,CAAC,EAAE,mBAAmB,CAAC,IAAI,CAAC;CACjC;AAED,yBAAiB,mBAAmB,CAAC;IACnC,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}

package/resources/v1/invoices.js

@@ -2,10 +2,27 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Invoices = void 0;
-const resource_1 = require("../../resource.js");
+const resource_1 = require("../../core/resource.js");
 class Invoices extends resource_1.APIResource {
     /**
-     * Regenerate a voided contract invoice
+     * This endpoint regenerates a voided invoice and recalculates the invoice based on
+     * up-to-date rates, available balances, and other fees regardless of the billing
+     * period.
+     *
+     * ### Use this endpoint to:
+     *
+     * Recalculate an invoice with updated rate terms, available balance, and fees to
+     * correct billing disputes or discrepancies
+     *
+     * ### Key response fields:
+     *
+     * The regenerated invoice id, which is distinct from the previously voided
+     * invoice.
+     *
+     * ### Usage guidelines:
+     *
+     * If an invoice is attached to a contract with a billing provider on it, the
+     * regenerated invoice will be distributed based on the configuration.
      *
      * @example
      * ```ts
@@ -18,7 +35,11 @@ class Invoices extends resource_1.APIResource {
         return this._client.post('/v1/invoices/regenerate', { body, ...options });
     }
     /**
-     * Void an invoice
+     * Permanently cancels an invoice by setting its status to voided, preventing
+     * collection and removing it from customer billing. Use this to correct billing
+     * errors, cancel incorrect charges, or handle disputed invoices that should not be
+     * collected. Returns the voided invoice ID with the status change applied
+     * immediately to stop any payment processing.
      *
      * @example
      * ```ts

package/resources/v1/invoices.js.map

@@ -1 +1 @@
-{"version":3,"file":"invoices.js","sourceRoot":"","sources":["../../src/resources/v1/invoices.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAG7C,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;OASG;IACH,UAAU,CACR,IAA6B,EAC7B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CAAC,IAAuB,EAAE,OAA6B;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;CACF;AA/BD,4BA+BC"}
+{"version":3,"file":"invoices.js","sourceRoot":"","sources":["../../src/resources/v1/invoices.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,UAAU,CAAC,IAA6B,EAAE,OAAwB;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,CAAC,IAAuB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;CACF;AAjDD,4BAiDC"}

package/resources/v1/invoices.mjs

@@ -1,8 +1,25 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-import { APIResource } from "../../resource.mjs";
+import { APIResource } from "../../core/resource.mjs";
 export class Invoices extends APIResource {
     /**
-     * Regenerate a voided contract invoice
+     * This endpoint regenerates a voided invoice and recalculates the invoice based on
+     * up-to-date rates, available balances, and other fees regardless of the billing
+     * period.
+     *
+     * ### Use this endpoint to:
+     *
+     * Recalculate an invoice with updated rate terms, available balance, and fees to
+     * correct billing disputes or discrepancies
+     *
+     * ### Key response fields:
+     *
+     * The regenerated invoice id, which is distinct from the previously voided
+     * invoice.
+     *
+     * ### Usage guidelines:
+     *
+     * If an invoice is attached to a contract with a billing provider on it, the
+     * regenerated invoice will be distributed based on the configuration.
      *
      * @example
      * ```ts
@@ -15,7 +32,11 @@ export class Invoices extends APIResource {
         return this._client.post('/v1/invoices/regenerate', { body, ...options });
     }
     /**
-     * Void an invoice
+     * Permanently cancels an invoice by setting its status to voided, preventing
+     * collection and removing it from customer billing. Use this to correct billing
+     * errors, cancel incorrect charges, or handle disputed invoices that should not be
+     * collected. Returns the voided invoice ID with the status change applied
+     * immediately to stop any payment processing.
      *
      * @example
      * ```ts

package/resources/v1/invoices.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"invoices.mjs","sourceRoot":"","sources":["../../src/resources/v1/invoices.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAGtB,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;OASG;IACH,UAAU,CACR,IAA6B,EAC7B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CAAC,IAAuB,EAAE,OAA6B;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;CACF"}
+{"version":3,"file":"invoices.mjs","sourceRoot":"","sources":["../../src/resources/v1/invoices.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,UAAU,CAAC,IAA6B,EAAE,OAAwB;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,CAAC,IAAuB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;CACF"}

package/resources/v1/payments.d.mts

@@ -0,0 +1,116 @@
+import { APIResource } from "../../core/resource.mjs";
+import * as Shared from "../shared.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { BodyCursorPage, type BodyCursorPageParams, PagePromise } from "../../core/pagination.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+export declare class Payments extends APIResource {
+    /**
+     * Fetch all payment attempts for the given invoice.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const payment of client.v1.payments.list({
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   invoice_id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+     *   statuses: ['pending', 'requires_intervention'],
+     * })) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(body: PaymentListParams, options?: RequestOptions): PagePromise<PaymentsBodyCursorPage, Payment>;
+    /**
+     * Trigger a new attempt by canceling any existing attempts for this invoice and
+     * creating a new Payment. This will trigger another attempt to charge the
+     * Customer's configured Payment Gateway. Payment can only be attempted if all of
+     * the following are true:
+     *
+     * - The Metronome Invoice is finalized
+     * - PLG Invoicing is configured for the Customer
+     * - You cannot attempt payments for invoices that have already been `paid` or
+     *   `voided`.
+     *
+     * Attempting to payment on an ineligible Invoice or Customer will result in a
+     * `400` response.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.payments.attempt({
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   invoice_id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+     * });
+     * ```
+     */
+    attempt(body: PaymentAttemptParams, options?: RequestOptions): APIPromise<PaymentAttemptResponse>;
+    /**
+     * Cancel an existing payment attempt for an invoice.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.payments.cancel({
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   invoice_id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+     * });
+     * ```
+     */
+    cancel(body: PaymentCancelParams, options?: RequestOptions): APIPromise<PaymentCancelResponse>;
+}
+export type PaymentsBodyCursorPage = BodyCursorPage<Payment>;
+export interface Payment {
+    id: string;
+    amount?: number;
+    amount_paid?: number;
+    contract_id?: string;
+    created_at?: string;
+    customer_id?: string;
+    error_message?: string;
+    fiat_credit_type?: Shared.CreditTypeData;
+    invoice_id?: string;
+    payment_gateway?: Payment.PaymentGateway;
+    status?: PaymentStatus;
+    updated_at?: string;
+}
+export declare namespace Payment {
+    interface PaymentGateway {
+        stripe: PaymentGateway.Stripe;
+        type: 'stripe';
+    }
+    namespace PaymentGateway {
+        interface Stripe {
+            payment_intent_id: string;
+            error?: Stripe.Error;
+        }
+        namespace Stripe {
+            interface Error {
+                code?: string;
+                decline_code?: string;
+                type?: string;
+            }
+        }
+    }
+}
+export type PaymentStatus = 'pending' | 'requires_intervention' | 'paid' | 'canceled';
+export interface PaymentAttemptResponse {
+    data: Payment;
+}
+export interface PaymentCancelResponse {
+    data: Payment;
+}
+export interface PaymentListParams extends BodyCursorPageParams {
+    customer_id: string;
+    invoice_id: string;
+    statuses?: Array<PaymentStatus>;
+}
+export interface PaymentAttemptParams {
+    customer_id: string;
+    invoice_id: string;
+}
+export interface PaymentCancelParams {
+    customer_id: string;
+    invoice_id: string;
+}
+export declare namespace Payments {
+    export { type Payment as Payment, type PaymentStatus as PaymentStatus, type PaymentAttemptResponse as PaymentAttemptResponse, type PaymentCancelResponse as PaymentCancelResponse, type PaymentsBodyCursorPage as PaymentsBodyCursorPage, type PaymentListParams as PaymentListParams, type PaymentAttemptParams as PaymentAttemptParams, type PaymentCancelParams as PaymentCancelParams, };
+}
+//# sourceMappingURL=payments.d.mts.map

package/resources/v1/payments.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payments.d.mts","sourceRoot":"","sources":["../../src/resources/v1/payments.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE,KAAK,oBAAoB,EAAE,WAAW,EAAE;OAC1D,EAAE,cAAc,EAAE;AAEzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;OAcG;IACH,IAAI,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,WAAW,CAAC,sBAAsB,EAAE,OAAO,CAAC;IAQrG;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,OAAO,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIjG;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;CAG/F;AAED,MAAM,MAAM,sBAAsB,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;AAE7D,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IAEX,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,gBAAgB,CAAC,EAAE,MAAM,CAAC,cAAc,CAAC;IAEzC,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,eAAe,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC;IAEzC,MAAM,CAAC,EAAE,aAAa,CAAC;IAEvB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,yBAAiB,OAAO,CAAC;IACvB,UAAiB,cAAc;QAC7B,MAAM,EAAE,cAAc,CAAC,MAAM,CAAC;QAE9B,IAAI,EAAE,QAAQ,CAAC;KAChB;IAED,UAAiB,cAAc,CAAC;QAC9B,UAAiB,MAAM;YACrB,iBAAiB,EAAE,MAAM,CAAC;YAE1B,KAAK,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC;SACtB;QAED,UAAiB,MAAM,CAAC;YACtB,UAAiB,KAAK;gBACpB,IAAI,CAAC,EAAE,MAAM,CAAC;gBAEd,YAAY,CAAC,EAAE,MAAM,CAAC;gBAEtB,IAAI,CAAC,EAAE,MAAM,CAAC;aACf;SACF;KACF;CACF;AAED,MAAM,MAAM,aAAa,GAAG,SAAS,GAAG,uBAAuB,GAAG,MAAM,GAAG,UAAU,CAAC;AAEtF,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,iBAAkB,SAAQ,oBAAoB;IAC7D,WAAW,EAAE,MAAM,CAAC;IAEpB,UAAU,EAAE,MAAM,CAAC;IAEnB,QAAQ,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;CACjC;AAED,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,MAAM,CAAC;IAEpB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,mBAAmB;IAClC,WAAW,EAAE,MAAM,CAAC;IAEpB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}

package/resources/v1/payments.d.ts

@@ -0,0 +1,116 @@
+import { APIResource } from "../../core/resource.js";
+import * as Shared from "../shared.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { BodyCursorPage, type BodyCursorPageParams, PagePromise } from "../../core/pagination.js";
+import { RequestOptions } from "../../internal/request-options.js";
+export declare class Payments extends APIResource {
+    /**
+     * Fetch all payment attempts for the given invoice.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const payment of client.v1.payments.list({
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   invoice_id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+     *   statuses: ['pending', 'requires_intervention'],
+     * })) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(body: PaymentListParams, options?: RequestOptions): PagePromise<PaymentsBodyCursorPage, Payment>;
+    /**
+     * Trigger a new attempt by canceling any existing attempts for this invoice and
+     * creating a new Payment. This will trigger another attempt to charge the
+     * Customer's configured Payment Gateway. Payment can only be attempted if all of
+     * the following are true:
+     *
+     * - The Metronome Invoice is finalized
+     * - PLG Invoicing is configured for the Customer
+     * - You cannot attempt payments for invoices that have already been `paid` or
+     *   `voided`.
+     *
+     * Attempting to payment on an ineligible Invoice or Customer will result in a
+     * `400` response.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.payments.attempt({
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   invoice_id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+     * });
+     * ```
+     */
+    attempt(body: PaymentAttemptParams, options?: RequestOptions): APIPromise<PaymentAttemptResponse>;
+    /**
+     * Cancel an existing payment attempt for an invoice.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.payments.cancel({
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   invoice_id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+     * });
+     * ```
+     */
+    cancel(body: PaymentCancelParams, options?: RequestOptions): APIPromise<PaymentCancelResponse>;
+}
+export type PaymentsBodyCursorPage = BodyCursorPage<Payment>;
+export interface Payment {
+    id: string;
+    amount?: number;
+    amount_paid?: number;
+    contract_id?: string;
+    created_at?: string;
+    customer_id?: string;
+    error_message?: string;
+    fiat_credit_type?: Shared.CreditTypeData;
+    invoice_id?: string;
+    payment_gateway?: Payment.PaymentGateway;
+    status?: PaymentStatus;
+    updated_at?: string;
+}
+export declare namespace Payment {
+    interface PaymentGateway {
+        stripe: PaymentGateway.Stripe;
+        type: 'stripe';
+    }
+    namespace PaymentGateway {
+        interface Stripe {
+            payment_intent_id: string;
+            error?: Stripe.Error;
+        }
+        namespace Stripe {
+            interface Error {
+                code?: string;
+                decline_code?: string;
+                type?: string;
+            }
+        }
+    }
+}
+export type PaymentStatus = 'pending' | 'requires_intervention' | 'paid' | 'canceled';
+export interface PaymentAttemptResponse {
+    data: Payment;
+}
+export interface PaymentCancelResponse {
+    data: Payment;
+}
+export interface PaymentListParams extends BodyCursorPageParams {
+    customer_id: string;
+    invoice_id: string;
+    statuses?: Array<PaymentStatus>;
+}
+export interface PaymentAttemptParams {
+    customer_id: string;
+    invoice_id: string;
+}
+export interface PaymentCancelParams {
+    customer_id: string;
+    invoice_id: string;
+}
+export declare namespace Payments {
+    export { type Payment as Payment, type PaymentStatus as PaymentStatus, type PaymentAttemptResponse as PaymentAttemptResponse, type PaymentCancelResponse as PaymentCancelResponse, type PaymentsBodyCursorPage as PaymentsBodyCursorPage, type PaymentListParams as PaymentListParams, type PaymentAttemptParams as PaymentAttemptParams, type PaymentCancelParams as PaymentCancelParams, };
+}
+//# sourceMappingURL=payments.d.ts.map

package/resources/v1/payments.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payments.d.ts","sourceRoot":"","sources":["../../src/resources/v1/payments.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE,KAAK,oBAAoB,EAAE,WAAW,EAAE;OAC1D,EAAE,cAAc,EAAE;AAEzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;OAcG;IACH,IAAI,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,WAAW,CAAC,sBAAsB,EAAE,OAAO,CAAC;IAQrG;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,OAAO,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIjG;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;CAG/F;AAED,MAAM,MAAM,sBAAsB,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;AAE7D,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IAEX,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,gBAAgB,CAAC,EAAE,MAAM,CAAC,cAAc,CAAC;IAEzC,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,eAAe,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC;IAEzC,MAAM,CAAC,EAAE,aAAa,CAAC;IAEvB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,yBAAiB,OAAO,CAAC;IACvB,UAAiB,cAAc;QAC7B,MAAM,EAAE,cAAc,CAAC,MAAM,CAAC;QAE9B,IAAI,EAAE,QAAQ,CAAC;KAChB;IAED,UAAiB,cAAc,CAAC;QAC9B,UAAiB,MAAM;YACrB,iBAAiB,EAAE,MAAM,CAAC;YAE1B,KAAK,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC;SACtB;QAED,UAAiB,MAAM,CAAC;YACtB,UAAiB,KAAK;gBACpB,IAAI,CAAC,EAAE,MAAM,CAAC;gBAEd,YAAY,CAAC,EAAE,MAAM,CAAC;gBAEtB,IAAI,CAAC,EAAE,MAAM,CAAC;aACf;SACF;KACF;CACF;AAED,MAAM,MAAM,aAAa,GAAG,SAAS,GAAG,uBAAuB,GAAG,MAAM,GAAG,UAAU,CAAC;AAEtF,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,iBAAkB,SAAQ,oBAAoB;IAC7D,WAAW,EAAE,MAAM,CAAC;IAEpB,UAAU,EAAE,MAAM,CAAC;IAEnB,QAAQ,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;CACjC;AAED,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,MAAM,CAAC;IAEpB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,mBAAmB;IAClC,WAAW,EAAE,MAAM,CAAC;IAEpB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}

package/resources/v1/payments.js

@@ -0,0 +1,71 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Payments = void 0;
+const resource_1 = require("../../core/resource.js");
+const pagination_1 = require("../../core/pagination.js");
+class Payments extends resource_1.APIResource {
+    /**
+     * Fetch all payment attempts for the given invoice.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const payment of client.v1.payments.list({
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   invoice_id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+     *   statuses: ['pending', 'requires_intervention'],
+     * })) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(body, options) {
+        return this._client.getAPIList('/v1/payments/list', (pagination_1.BodyCursorPage), {
+            body,
+            method: 'post',
+            ...options,
+        });
+    }
+    /**
+     * Trigger a new attempt by canceling any existing attempts for this invoice and
+     * creating a new Payment. This will trigger another attempt to charge the
+     * Customer's configured Payment Gateway. Payment can only be attempted if all of
+     * the following are true:
+     *
+     * - The Metronome Invoice is finalized
+     * - PLG Invoicing is configured for the Customer
+     * - You cannot attempt payments for invoices that have already been `paid` or
+     *   `voided`.
+     *
+     * Attempting to payment on an ineligible Invoice or Customer will result in a
+     * `400` response.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.payments.attempt({
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   invoice_id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+     * });
+     * ```
+     */
+    attempt(body, options) {
+        return this._client.post('/v1/payments/attempt', { body, ...options });
+    }
+    /**
+     * Cancel an existing payment attempt for an invoice.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.payments.cancel({
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   invoice_id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+     * });
+     * ```
+     */
+    cancel(body, options) {
+        return this._client.post('/v1/payments/cancel', { body, ...options });
+    }
+}
+exports.Payments = Payments;
+//# sourceMappingURL=payments.js.map

package/resources/v1/payments.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payments.js","sourceRoot":"","sources":["../../src/resources/v1/payments.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAGlD,yDAA+F;AAG/F,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;;;;;;OAcG;IACH,IAAI,CAAC,IAAuB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mBAAmB,EAAE,CAAA,2BAAuB,CAAA,EAAE;YAC3E,IAAI;YACJ,MAAM,EAAE,MAAM;YACd,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,OAAO,CAAC,IAA0B,EAAE,OAAwB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;CACF;AAhED,4BAgEC"}

package/resources/v1/payments.mjs

@@ -0,0 +1,67 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import { BodyCursorPage } from "../../core/pagination.mjs";
+export class Payments extends APIResource {
+    /**
+     * Fetch all payment attempts for the given invoice.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const payment of client.v1.payments.list({
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   invoice_id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+     *   statuses: ['pending', 'requires_intervention'],
+     * })) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(body, options) {
+        return this._client.getAPIList('/v1/payments/list', (BodyCursorPage), {
+            body,
+            method: 'post',
+            ...options,
+        });
+    }
+    /**
+     * Trigger a new attempt by canceling any existing attempts for this invoice and
+     * creating a new Payment. This will trigger another attempt to charge the
+     * Customer's configured Payment Gateway. Payment can only be attempted if all of
+     * the following are true:
+     *
+     * - The Metronome Invoice is finalized
+     * - PLG Invoicing is configured for the Customer
+     * - You cannot attempt payments for invoices that have already been `paid` or
+     *   `voided`.
+     *
+     * Attempting to payment on an ineligible Invoice or Customer will result in a
+     * `400` response.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.payments.attempt({
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   invoice_id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+     * });
+     * ```
+     */
+    attempt(body, options) {
+        return this._client.post('/v1/payments/attempt', { body, ...options });
+    }
+    /**
+     * Cancel an existing payment attempt for an invoice.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.payments.cancel({
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   invoice_id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+     * });
+     * ```
+     */
+    cancel(body, options) {
+        return this._client.post('/v1/payments/cancel', { body, ...options });
+    }
+}
+//# sourceMappingURL=payments.mjs.map

package/resources/v1/payments.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"payments.mjs","sourceRoot":"","sources":["../../src/resources/v1/payments.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,cAAc,EAA0C;AAGjE,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;OAcG;IACH,IAAI,CAAC,IAAuB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mBAAmB,EAAE,CAAA,cAAuB,CAAA,EAAE;YAC3E,IAAI;YACJ,MAAM,EAAE,MAAM;YACd,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,OAAO,CAAC,IAA0B,EAAE,OAAwB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;CACF"}