@peable.to/contracts 0.4.0 → 1.1.0

package/dist/types/resources/core/paymentMethods.d.ts

@@ -0,0 +1,336 @@
+import { z } from 'zod';
+import { type Expand } from '../../common/objects';
+/**
+ * PaymentMethods (`pm_…`) — Peable's wrapper over a provider payment method
+ * (ADR 0016). Card details are collected by the provider's own Elements in the
+ * browser; the card number never reaches Peable. A FairCoin customer has no
+ * payment method: signing stays on the payer's device.
+ */
+/** Card details safe to show: never the number, never the CVC. */
+export declare const cardDetailsSchema: 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>;
+export type CardDetails = z.output<typeof cardDetailsSchema>;
+export declare const billingDetailsSchema: 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>;
+export type BillingDetails = z.output<typeof billingDetailsSchema>;
+export declare const paymentMethodSchema: z.ZodObject<{
+    id: z.ZodString;
+    object: z.ZodLiteral<"payment_method">;
+    livemode: z.ZodBoolean;
+    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>;
+    billing_details: 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>;
+    customer: z.ZodNullable<z.ZodType<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">, z.core.$ZodTypeInternals<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">>>>;
+    metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+    created: z.ZodNumber;
+}, z.core.$strict>;
+export type PaymentMethod = Expand<z.output<typeof paymentMethodSchema>>;
+declare module '../../common/objects' {
+    interface ObjectMap {
+        payment_method: PaymentMethod;
+    }
+}
+/**
+ * Billing details (each named field replaces that field) and metadata (a
+ * patch). Orbit's record of the card holder; the provider's copy is not
+ * rewritten — the card was verified against what the payer entered there.
+ */
+export declare const updatePaymentMethodParams: z.ZodObject<{
+    billing_details: z.ZodOptional<z.ZodObject<{
+        address: z.ZodOptional<z.ZodObject<{
+            line1: z.ZodOptional<z.ZodString>;
+            line2: z.ZodOptional<z.ZodString>;
+            city: z.ZodOptional<z.ZodString>;
+            state: z.ZodOptional<z.ZodString>;
+            postal_code: z.ZodOptional<z.ZodString>;
+            country: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>>;
+        email: z.ZodOptional<z.ZodEmail>;
+        name: z.ZodOptional<z.ZodString>;
+        phone: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>;
+    metadata: z.ZodOptional<z.ZodPipe<z.ZodRecord<z.ZodString, z.ZodString>, z.ZodTransform<import("../..").MetadataPatch, Record<string, string>>>>;
+    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>;
+export type UpdatePaymentMethodParams = z.input<typeof updatePaymentMethodParams>;
+export declare const detachPaymentMethodParams: 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>;
+export type DetachPaymentMethodParams = z.input<typeof detachPaymentMethodParams>;
+/** `customer` is REQUIRED: Stripe lists a customer's methods, never a merchant's whole wallet. */
+export declare const listPaymentMethodsQuery: 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>>>;
+    customer: z.ZodString;
+    type: z.ZodOptional<z.ZodLiteral<"card">>;
+}, z.core.$strict>;
+export type ListPaymentMethodsParams = z.input<typeof listPaymentMethodsQuery>;
+export declare const paymentMethodRoutes: readonly [{
+    readonly operationId: "listPaymentMethods";
+    readonly method: "get";
+    readonly path: "/v1/payment_methods";
+    readonly tag: "Payment methods";
+    readonly summary: "List a customer's payment methods";
+    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>>>;
+        customer: z.ZodString;
+        type: z.ZodOptional<z.ZodLiteral<"card">>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        object: z.ZodLiteral<"list">;
+        data: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            object: z.ZodLiteral<"payment_method">;
+            livemode: z.ZodBoolean;
+            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>;
+            billing_details: 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>;
+            customer: z.ZodNullable<z.ZodType<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">, z.core.$ZodTypeInternals<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">>>>;
+            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: "paymentMethods.list";
+    readonly expandable: "payment_method";
+}, {
+    readonly operationId: "retrievePaymentMethod";
+    readonly method: "get";
+    readonly path: "/v1/payment_methods/{id}";
+    readonly tag: "Payment methods";
+    readonly summary: "Retrieve a payment method";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    readonly params: {
+        readonly id: "The payment method (`pm_…`).";
+    };
+    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<"payment_method">;
+        livemode: z.ZodBoolean;
+        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>;
+        billing_details: 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>;
+        customer: z.ZodNullable<z.ZodType<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">, z.core.$ZodTypeInternals<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">>>>;
+        metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+        created: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly sdk: "paymentMethods.retrieve";
+    readonly expandable: "payment_method";
+}, {
+    readonly operationId: "updatePaymentMethod";
+    readonly method: "post";
+    readonly path: "/v1/payment_methods/{id}";
+    readonly tag: "Payment methods";
+    readonly summary: "Update a payment method";
+    readonly auth: "service";
+    readonly scope: "payments:write";
+    readonly idempotent: true;
+    readonly params: {
+        readonly id: "The payment method (`pm_…`).";
+    };
+    readonly body: z.ZodObject<{
+        billing_details: z.ZodOptional<z.ZodObject<{
+            address: z.ZodOptional<z.ZodObject<{
+                line1: z.ZodOptional<z.ZodString>;
+                line2: z.ZodOptional<z.ZodString>;
+                city: z.ZodOptional<z.ZodString>;
+                state: z.ZodOptional<z.ZodString>;
+                postal_code: z.ZodOptional<z.ZodString>;
+                country: z.ZodOptional<z.ZodString>;
+            }, z.core.$strict>>;
+            email: z.ZodOptional<z.ZodEmail>;
+            name: z.ZodOptional<z.ZodString>;
+            phone: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>>;
+        metadata: z.ZodOptional<z.ZodPipe<z.ZodRecord<z.ZodString, z.ZodString>, z.ZodTransform<import("../..").MetadataPatch, Record<string, string>>>>;
+        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<"payment_method">;
+        livemode: z.ZodBoolean;
+        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>;
+        billing_details: 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>;
+        customer: z.ZodNullable<z.ZodType<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">, z.core.$ZodTypeInternals<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">>>>;
+        metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+        created: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly sdk: "paymentMethods.update";
+    readonly expandable: "payment_method";
+}, {
+    readonly operationId: "detachPaymentMethod";
+    readonly method: "post";
+    readonly path: "/v1/payment_methods/{id}/detach";
+    readonly tag: "Payment methods";
+    readonly summary: "Detach a payment method";
+    readonly description: "Permanently. A second detach answers the detached method.";
+    readonly auth: "service";
+    readonly scope: "payments:write";
+    readonly idempotent: true;
+    readonly params: {
+        readonly id: "The payment method (`pm_…`).";
+    };
+    readonly body: 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<"payment_method">;
+        livemode: z.ZodBoolean;
+        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>;
+        billing_details: 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>;
+        customer: z.ZodNullable<z.ZodType<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">, z.core.$ZodTypeInternals<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">>>>;
+        metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+        created: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly sdk: "paymentMethods.detach";
+    readonly expandable: "payment_method";
+}];