@peable.to/contracts 0.4.0 → 1.0.0

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

@@ -0,0 +1,390 @@
+import { z } from 'zod';
+import { type Expand } from '../../common/objects';
+/**
+ * Charges (`ch_…`) — the read-only record of the money a CARD PaymentIntent
+ * moved (ADR 0019). Peable's object over the provider's charge, which stays an
+ * internal binding (ADR 0016). A FairCoin payment has no charge: its chain side
+ * is `PaymentIntent.faircoin`.
+ */
+export declare const chargeOutcomeSchema: z.ZodObject<{
+    network_status: z.ZodNullable<z.ZodString>;
+    risk_level: z.ZodNullable<z.ZodString>;
+    type: z.ZodNullable<z.ZodString>;
+    seller_message: z.ZodNullable<z.ZodString>;
+}, z.core.$strict>;
+export type ChargeOutcome = z.output<typeof chargeOutcomeSchema>;
+export declare const chargeSchema: z.ZodObject<{
+    id: z.ZodString;
+    object: z.ZodLiteral<"charge">;
+    livemode: z.ZodBoolean;
+    payment_intent: z.ZodType<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">, z.core.$ZodTypeInternals<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">>>;
+    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">>>>;
+    amount: z.ZodString;
+    amount_captured: 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";
+    }>;
+    status: z.ZodLiteral<"succeeded">;
+    paid: z.ZodBoolean;
+    captured: z.ZodBoolean;
+    refunded: z.ZodBoolean;
+    disputed: z.ZodBoolean;
+    outcome: z.ZodNullable<z.ZodObject<{
+        network_status: z.ZodNullable<z.ZodString>;
+        risk_level: z.ZodNullable<z.ZodString>;
+        type: z.ZodNullable<z.ZodString>;
+        seller_message: z.ZodNullable<z.ZodString>;
+    }, z.core.$strict>>;
+    billing_details: z.ZodNullable<z.ZodObject<{
+        address: z.ZodNullable<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>>;
+        email: z.ZodNullable<z.ZodString>;
+        name: z.ZodNullable<z.ZodString>;
+        phone: z.ZodNullable<z.ZodString>;
+    }, z.core.$strict>>;
+    payment_method_details: z.ZodNullable<z.ZodObject<{
+        type: z.ZodLiteral<"card">;
+        card: z.ZodObject<{
+            brand: z.ZodNullable<z.ZodString>;
+            last4: z.ZodNullable<z.ZodString>;
+            exp_month: z.ZodNullable<z.ZodNumber>;
+            exp_year: z.ZodNullable<z.ZodNumber>;
+            country: z.ZodNullable<z.ZodString>;
+            funding: z.ZodNullable<z.ZodString>;
+        }, z.core.$strict>;
+    }, z.core.$strict>>;
+    receipt_url: z.ZodNullable<z.ZodString>;
+    balance_transaction: z.ZodNullable<z.ZodString>;
+    application_fee: z.ZodNullable<z.ZodString>;
+    application_fee_amount: z.ZodNullable<z.ZodString>;
+    description: z.ZodNullable<z.ZodString>;
+    receipt_email: z.ZodNullable<z.ZodString>;
+    metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+    created: z.ZodNumber;
+}, z.core.$strict>;
+export type Charge = Expand<z.output<typeof chargeSchema>>;
+declare module '../../common/objects' {
+    interface ObjectMap {
+        charge: Charge;
+    }
+}
+export declare const listChargesQuery: z.ZodObject<{
+    limit: z.ZodPipe<z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>, z.ZodTransform<number, number | undefined>>;
+    starting_after: z.ZodOptional<z.ZodString>;
+    ending_before: z.ZodOptional<z.ZodString>;
+    created: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>, z.ZodTransform<import("../..").RangeFilter, number>>, z.ZodPipe<z.ZodObject<{
+        gt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+        gte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+        lt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+        lte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+    }, z.core.$strict>, z.ZodTransform<import("../..").RangeFilter, {
+        gt?: number | undefined;
+        gte?: number | undefined;
+        lt?: number | undefined;
+        lte?: number | undefined;
+    }>>]>>;
+    expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
+    payment_intent: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+export type ListChargesParams = z.input<typeof listChargesQuery>;
+export declare const chargeRoutes: readonly [{
+    readonly operationId: "listCharges";
+    readonly method: "get";
+    readonly path: "/v1/charges";
+    readonly tag: "Charges";
+    readonly summary: "List charges";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    readonly query: z.ZodObject<{
+        limit: z.ZodPipe<z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>, z.ZodTransform<number, number | undefined>>;
+        starting_after: z.ZodOptional<z.ZodString>;
+        ending_before: z.ZodOptional<z.ZodString>;
+        created: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>, z.ZodTransform<import("../..").RangeFilter, number>>, z.ZodPipe<z.ZodObject<{
+            gt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+            gte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+            lt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+            lte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+        }, z.core.$strict>, z.ZodTransform<import("../..").RangeFilter, {
+            gt?: number | undefined;
+            gte?: number | undefined;
+            lt?: number | undefined;
+            lte?: number | undefined;
+        }>>]>>;
+        expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
+        payment_intent: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        object: z.ZodLiteral<"list">;
+        data: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            object: z.ZodLiteral<"charge">;
+            livemode: z.ZodBoolean;
+            payment_intent: z.ZodType<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">, z.core.$ZodTypeInternals<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">>>;
+            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">>>>;
+            amount: z.ZodString;
+            amount_captured: 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";
+            }>;
+            status: z.ZodLiteral<"succeeded">;
+            paid: z.ZodBoolean;
+            captured: z.ZodBoolean;
+            refunded: z.ZodBoolean;
+            disputed: z.ZodBoolean;
+            outcome: z.ZodNullable<z.ZodObject<{
+                network_status: z.ZodNullable<z.ZodString>;
+                risk_level: z.ZodNullable<z.ZodString>;
+                type: z.ZodNullable<z.ZodString>;
+                seller_message: z.ZodNullable<z.ZodString>;
+            }, z.core.$strict>>;
+            billing_details: z.ZodNullable<z.ZodObject<{
+                address: z.ZodNullable<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>>;
+                email: z.ZodNullable<z.ZodString>;
+                name: z.ZodNullable<z.ZodString>;
+                phone: z.ZodNullable<z.ZodString>;
+            }, z.core.$strict>>;
+            payment_method_details: z.ZodNullable<z.ZodObject<{
+                type: z.ZodLiteral<"card">;
+                card: z.ZodObject<{
+                    brand: z.ZodNullable<z.ZodString>;
+                    last4: z.ZodNullable<z.ZodString>;
+                    exp_month: z.ZodNullable<z.ZodNumber>;
+                    exp_year: z.ZodNullable<z.ZodNumber>;
+                    country: z.ZodNullable<z.ZodString>;
+                    funding: z.ZodNullable<z.ZodString>;
+                }, z.core.$strict>;
+            }, z.core.$strict>>;
+            receipt_url: z.ZodNullable<z.ZodString>;
+            balance_transaction: z.ZodNullable<z.ZodString>;
+            application_fee: z.ZodNullable<z.ZodString>;
+            application_fee_amount: z.ZodNullable<z.ZodString>;
+            description: z.ZodNullable<z.ZodString>;
+            receipt_email: z.ZodNullable<z.ZodString>;
+            metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+            created: z.ZodNumber;
+        }, z.core.$strict>>;
+        has_more: z.ZodBoolean;
+        url: z.ZodString;
+    }, z.core.$strict>;
+    readonly sdk: "charges.list";
+    readonly expandable: "charge";
+}, {
+    readonly operationId: "retrieveCharge";
+    readonly method: "get";
+    readonly path: "/v1/charges/{id}";
+    readonly tag: "Charges";
+    readonly summary: "Retrieve a charge";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    readonly params: {
+        readonly id: "The charge (`ch_…`).";
+    };
+    readonly query: z.ZodObject<{
+        expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        id: z.ZodString;
+        object: z.ZodLiteral<"charge">;
+        livemode: z.ZodBoolean;
+        payment_intent: z.ZodType<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">, z.core.$ZodTypeInternals<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">>>;
+        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">>>>;
+        amount: z.ZodString;
+        amount_captured: 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";
+        }>;
+        status: z.ZodLiteral<"succeeded">;
+        paid: z.ZodBoolean;
+        captured: z.ZodBoolean;
+        refunded: z.ZodBoolean;
+        disputed: z.ZodBoolean;
+        outcome: z.ZodNullable<z.ZodObject<{
+            network_status: z.ZodNullable<z.ZodString>;
+            risk_level: z.ZodNullable<z.ZodString>;
+            type: z.ZodNullable<z.ZodString>;
+            seller_message: z.ZodNullable<z.ZodString>;
+        }, z.core.$strict>>;
+        billing_details: z.ZodNullable<z.ZodObject<{
+            address: z.ZodNullable<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>>;
+            email: z.ZodNullable<z.ZodString>;
+            name: z.ZodNullable<z.ZodString>;
+            phone: z.ZodNullable<z.ZodString>;
+        }, z.core.$strict>>;
+        payment_method_details: z.ZodNullable<z.ZodObject<{
+            type: z.ZodLiteral<"card">;
+            card: z.ZodObject<{
+                brand: z.ZodNullable<z.ZodString>;
+                last4: z.ZodNullable<z.ZodString>;
+                exp_month: z.ZodNullable<z.ZodNumber>;
+                exp_year: z.ZodNullable<z.ZodNumber>;
+                country: z.ZodNullable<z.ZodString>;
+                funding: z.ZodNullable<z.ZodString>;
+            }, z.core.$strict>;
+        }, z.core.$strict>>;
+        receipt_url: z.ZodNullable<z.ZodString>;
+        balance_transaction: z.ZodNullable<z.ZodString>;
+        application_fee: z.ZodNullable<z.ZodString>;
+        application_fee_amount: z.ZodNullable<z.ZodString>;
+        description: z.ZodNullable<z.ZodString>;
+        receipt_email: z.ZodNullable<z.ZodString>;
+        metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+        created: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly sdk: "charges.retrieve";
+    readonly expandable: "charge";
+}, {
+    readonly operationId: "searchCharges";
+    readonly method: "get";
+    readonly path: "/v1/charges/search";
+    readonly tag: "Charges";
+    readonly summary: "Search charges";
+    readonly description: "Stripe's query language over `amount`, `currency`, `customer`, `payment_intent`, `status`, `captured`, `refunded`, `disputed`, `created` and `metadata['key']`.";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    readonly query: z.ZodObject<{
+        query: z.ZodString;
+        limit: z.ZodPipe<z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>, z.ZodTransform<number, number | undefined>>;
+        page: z.ZodOptional<z.ZodString>;
+        expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        object: z.ZodLiteral<"search_result">;
+        data: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            object: z.ZodLiteral<"charge">;
+            livemode: z.ZodBoolean;
+            payment_intent: z.ZodType<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">, z.core.$ZodTypeInternals<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">>>;
+            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">>>>;
+            amount: z.ZodString;
+            amount_captured: 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";
+            }>;
+            status: z.ZodLiteral<"succeeded">;
+            paid: z.ZodBoolean;
+            captured: z.ZodBoolean;
+            refunded: z.ZodBoolean;
+            disputed: z.ZodBoolean;
+            outcome: z.ZodNullable<z.ZodObject<{
+                network_status: z.ZodNullable<z.ZodString>;
+                risk_level: z.ZodNullable<z.ZodString>;
+                type: z.ZodNullable<z.ZodString>;
+                seller_message: z.ZodNullable<z.ZodString>;
+            }, z.core.$strict>>;
+            billing_details: z.ZodNullable<z.ZodObject<{
+                address: z.ZodNullable<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>>;
+                email: z.ZodNullable<z.ZodString>;
+                name: z.ZodNullable<z.ZodString>;
+                phone: z.ZodNullable<z.ZodString>;
+            }, z.core.$strict>>;
+            payment_method_details: z.ZodNullable<z.ZodObject<{
+                type: z.ZodLiteral<"card">;
+                card: z.ZodObject<{
+                    brand: z.ZodNullable<z.ZodString>;
+                    last4: z.ZodNullable<z.ZodString>;
+                    exp_month: z.ZodNullable<z.ZodNumber>;
+                    exp_year: z.ZodNullable<z.ZodNumber>;
+                    country: z.ZodNullable<z.ZodString>;
+                    funding: z.ZodNullable<z.ZodString>;
+                }, z.core.$strict>;
+            }, z.core.$strict>>;
+            receipt_url: z.ZodNullable<z.ZodString>;
+            balance_transaction: z.ZodNullable<z.ZodString>;
+            application_fee: z.ZodNullable<z.ZodString>;
+            application_fee_amount: z.ZodNullable<z.ZodString>;
+            description: z.ZodNullable<z.ZodString>;
+            receipt_email: z.ZodNullable<z.ZodString>;
+            metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+            created: z.ZodNumber;
+        }, z.core.$strict>>;
+        has_more: z.ZodBoolean;
+        next_page: z.ZodNullable<z.ZodString>;
+        url: z.ZodString;
+        total_count: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strict>;
+    readonly sdk: "charges.search";
+    readonly expandable: "charge";
+}];