@peable.to/contracts 0.4.0 → 1.1.0

package/dist/types/resources/payments/testHelpers.d.ts

@@ -0,0 +1,178 @@
+import { z } from 'zod';
+/**
+ * Test helpers for payment intents — test mode only. They drive a test-mode
+ * payment through the SAME state machine a real one moves through, with the
+ * same events and webhooks, so an integration is exercised end to end without
+ * a wallet.
+ */
+export declare const simulateFaircoinPaymentParams: z.ZodObject<{
+    outcome: z.ZodOptional<z.ZodEnum<{
+        underpaid: "underpaid";
+        settled: "settled";
+    }>>;
+}, z.core.$strict>;
+export type SimulateFaircoinPaymentParams = z.input<typeof simulateFaircoinPaymentParams>;
+export declare const paymentIntentTestHelperRoutes: readonly [{
+    readonly operationId: "simulateFaircoinPayment";
+    readonly method: "post";
+    readonly path: "/v1/test_helpers/payment_intents/{id}/simulate_faircoin_payment";
+    readonly tag: "Test helpers";
+    readonly summary: "Simulate a FairCoin payment";
+    readonly description: "Pretend the payer broadcast and the chain confirmed (or underpaid) a FairCoin payment in `requires_action`. A live credential is refused with 403 `test_mode_only`.";
+    readonly auth: "service";
+    readonly scope: "payments:write";
+    readonly idempotent: true;
+    readonly testModeOnly: true;
+    readonly params: {
+        readonly id: "The payment intent (`pi_…`).";
+    };
+    readonly body: z.ZodObject<{
+        outcome: z.ZodOptional<z.ZodEnum<{
+            underpaid: "underpaid";
+            settled: "settled";
+        }>>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        id: z.ZodString;
+        object: z.ZodLiteral<"payment_intent">;
+        livemode: z.ZodBoolean;
+        status: z.ZodEnum<{
+            succeeded: "succeeded";
+            canceled: "canceled";
+            requires_payment_method: "requires_payment_method";
+            requires_confirmation: "requires_confirmation";
+            requires_action: "requires_action";
+            processing: "processing";
+            requires_capture: "requires_capture";
+        }>;
+        rail: z.ZodEnum<{
+            card: "card";
+            faircoin: "faircoin";
+        }>;
+        payment_method_types: z.ZodArray<z.ZodEnum<{
+            card: "card";
+            faircoin: "faircoin";
+            sepa_debit: "sepa_debit";
+            ideal: "ideal";
+            bancontact: "bancontact";
+            eps: "eps";
+        }>>;
+        payment_method_configuration_details: z.ZodNullable<z.ZodObject<{
+            id: z.ZodString;
+        }, z.core.$strict>>;
+        amount: z.ZodString;
+        amount_capturable: z.ZodString;
+        amount_received: z.ZodString;
+        amount_refunded: z.ZodString;
+        currency: z.ZodEnum<{
+            FAIR: "FAIR";
+            EUR: "EUR";
+            USD: "USD";
+            GBP: "GBP";
+            CHF: "CHF";
+            SEK: "SEK";
+            NOK: "NOK";
+            DKK: "DKK";
+            PLN: "PLN";
+            CZK: "CZK";
+            CAD: "CAD";
+            AUD: "AUD";
+            JPY: "JPY";
+        }>;
+        capture_method: z.ZodEnum<{
+            manual: "manual";
+            automatic: "automatic";
+        }>;
+        setup_future_usage: z.ZodNullable<z.ZodEnum<{
+            off_session: "off_session";
+            on_session: "on_session";
+        }>>;
+        customer: z.ZodNullable<z.ZodType<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">, z.core.$ZodTypeInternals<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">>>>;
+        payment_method: z.ZodNullable<z.ZodType<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">, z.core.$ZodTypeInternals<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">>>>;
+        latest_charge: z.ZodNullable<z.ZodType<string | import("../..").Ref<"charge">, string | import("../..").Ref<"charge">, z.core.$ZodTypeInternals<string | import("../..").Ref<"charge">, string | import("../..").Ref<"charge">>>>;
+        next_action: z.ZodNullable<z.ZodDiscriminatedUnion<[z.ZodObject<{
+            type: z.ZodLiteral<"faircoin_payment">;
+            faircoin_payment: z.ZodObject<{
+                address: z.ZodString;
+                network: z.ZodEnum<{
+                    mainnet: "mainnet";
+                    testnet: "testnet";
+                }>;
+                amount: z.ZodString;
+                currency: z.ZodLiteral<"FAIR">;
+                uri: z.ZodString;
+            }, z.core.$strict>;
+        }, z.core.$strict>, z.ZodObject<{
+            type: z.ZodLiteral<"use_peable_sdk">;
+        }, z.core.$strict>], "type">>;
+        last_payment_error: z.ZodNullable<z.ZodObject<{
+            type: z.ZodEnum<{
+                api_error: "api_error";
+                card_error: "card_error";
+                payment_error: "payment_error";
+            }>;
+            code: z.ZodNullable<z.ZodString>;
+            decline_code: z.ZodNullable<z.ZodString>;
+            message: z.ZodString;
+        }, z.core.$strict>>;
+        cancellation_reason: z.ZodNullable<z.ZodEnum<{
+            duplicate: "duplicate";
+            fraudulent: "fraudulent";
+            automatic: "automatic";
+            abandoned: "abandoned";
+            requested_by_customer: "requested_by_customer";
+            underpaid: "underpaid";
+        }>>;
+        canceled_at: z.ZodNullable<z.ZodNumber>;
+        description: z.ZodNullable<z.ZodString>;
+        receipt_email: z.ZodNullable<z.ZodString>;
+        statement_descriptor_suffix: z.ZodNullable<z.ZodString>;
+        shipping: z.ZodNullable<z.ZodObject<{
+            name: z.ZodString;
+            phone: z.ZodNullable<z.ZodString>;
+            address: z.ZodObject<{
+                line1: z.ZodNullable<z.ZodString>;
+                line2: z.ZodNullable<z.ZodString>;
+                city: z.ZodNullable<z.ZodString>;
+                state: z.ZodNullable<z.ZodString>;
+                postal_code: z.ZodNullable<z.ZodString>;
+                country: z.ZodNullable<z.ZodString>;
+            }, z.core.$strict>;
+            carrier: z.ZodNullable<z.ZodString>;
+            tracking_number: z.ZodNullable<z.ZodString>;
+        }, z.core.$strict>>;
+        faircoin: z.ZodNullable<z.ZodObject<{
+            network: z.ZodEnum<{
+                mainnet: "mainnet";
+                testnet: "testnet";
+            }>;
+            address: z.ZodString;
+            txid: z.ZodNullable<z.ZodString>;
+            confirmations: z.ZodNumber;
+            required_confirmations: z.ZodNumber;
+        }, z.core.$strict>>;
+        merchant_id: z.ZodString;
+        connected_account: z.ZodNullable<z.ZodType<string | import("../..").Ref<"connected_account">, string | import("../..").Ref<"connected_account">, z.core.$ZodTypeInternals<string | import("../..").Ref<"connected_account">, string | import("../..").Ref<"connected_account">>>>;
+        application_fee_amount: z.ZodNullable<z.ZodString>;
+        transfer_data: z.ZodNullable<z.ZodObject<{
+            destination: z.ZodString;
+            amount: z.ZodNullable<z.ZodString>;
+        }, z.core.$strict>>;
+        on_behalf_of: z.ZodNullable<z.ZodString>;
+        client_secret: z.ZodString;
+        client_action: z.ZodOptional<z.ZodObject<{
+            kind: z.ZodEnum<{
+                client_secret: "client_secret";
+                redirect: "redirect";
+            }>;
+            value: z.ZodString;
+            publishable_key: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>>;
+        metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+        expires_at: z.ZodNumber;
+        can_expire: z.ZodBoolean;
+        created: z.ZodNumber;
+        updated_at: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly sdk: "testHelpers.paymentIntents.simulateFaircoinPayment";
+}];