@peable.to/contracts 0.3.0 → 1.0.0

package/dist/types/resources/checkout/shared.d.ts

@@ -0,0 +1,419 @@
+import { z } from 'zod';
+import { type Expand } from '../../common/objects';
+/**
+ * What Checkout Sessions and Payment Links share: the `item` a line renders
+ * as, the collection options (address, phone, tax id, terms, custom fields),
+ * the payer-facing merchant and branding, and the request halves of those.
+ * One shape rule is written once, so a link and a session refuse the same
+ * mistake with the same `param`.
+ */
+/** The payment rail: FairCoin on chain, or a card (and the methods riding on it). */
+export declare const railSchema: z.ZodEnum<{
+    card: "card";
+    faircoin: "faircoin";
+}>;
+export declare const checkoutAdjustableQuantitySchema: z.ZodObject<{
+    enabled: z.ZodBoolean;
+    minimum: z.ZodNullable<z.ZodNumber>;
+    maximum: z.ZodNullable<z.ZodNumber>;
+}, z.core.$strict>;
+export type CheckoutAdjustableQuantity = z.output<typeof checkoutAdjustableQuantitySchema>;
+/** One line of a session or link — Stripe's `item`. */
+export declare const checkoutLineItemSchema: z.ZodObject<{
+    id: z.ZodString;
+    object: z.ZodLiteral<"item">;
+    description: z.ZodString;
+    price: z.ZodNullable<z.ZodType<string | import("../..").Ref<"price">, string | import("../..").Ref<"price">, z.core.$ZodTypeInternals<string | import("../..").Ref<"price">, string | import("../..").Ref<"price">>>>;
+    product: z.ZodNullable<z.ZodType<string | import("../..").Ref<"product">, string | import("../..").Ref<"product">, z.core.$ZodTypeInternals<string | import("../..").Ref<"product">, string | import("../..").Ref<"product">>>>;
+    images: z.ZodArray<z.ZodString>;
+    quantity: z.ZodNumber;
+    adjustable_quantity: z.ZodNullable<z.ZodObject<{
+        enabled: z.ZodBoolean;
+        minimum: z.ZodNullable<z.ZodNumber>;
+        maximum: z.ZodNullable<z.ZodNumber>;
+    }, z.core.$strict>>;
+    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";
+    }>;
+    unit_amount: z.ZodNullable<z.ZodString>;
+    amount_subtotal: z.ZodString;
+    amount_discount: z.ZodString;
+    amount_tax: z.ZodString;
+    amount_total: z.ZodString;
+}, z.core.$strict>;
+export type CheckoutLineItem = Expand<z.output<typeof checkoutLineItemSchema>>;
+declare module '../../common/objects' {
+    interface ObjectMap {
+        item: CheckoutLineItem;
+    }
+}
+export declare const checkoutTaxIdSchema: z.ZodObject<{
+    type: z.ZodEnum<{
+        eu_vat: "eu_vat";
+        gb_vat: "gb_vat";
+        ch_vat: "ch_vat";
+        no_vat: "no_vat";
+        us_ein: "us_ein";
+        ca_bn: "ca_bn";
+    }>;
+    value: z.ZodString;
+}, z.core.$strict>;
+export type CheckoutTaxId = z.output<typeof checkoutTaxIdSchema>;
+/** What the payer told checkout about themselves — Stripe's `customer_details`. */
+export declare const checkoutCustomerDetailsSchema: z.ZodObject<{
+    email: z.ZodNullable<z.ZodString>;
+    name: z.ZodNullable<z.ZodString>;
+    phone: z.ZodNullable<z.ZodString>;
+    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>>;
+    tax_ids: z.ZodArray<z.ZodObject<{
+        type: z.ZodEnum<{
+            eu_vat: "eu_vat";
+            gb_vat: "gb_vat";
+            ch_vat: "ch_vat";
+            no_vat: "no_vat";
+            us_ein: "us_ein";
+            ca_bn: "ca_bn";
+        }>;
+        value: z.ZodString;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type CheckoutCustomerDetails = z.output<typeof checkoutCustomerDetailsSchema>;
+export declare const checkoutShippingDetailsSchema: z.ZodObject<{
+    name: 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>;
+}, z.core.$strict>;
+export type CheckoutShippingDetails = z.output<typeof checkoutShippingDetailsSchema>;
+export declare const checkoutCustomFieldLabelSchema: z.ZodObject<{
+    type: z.ZodLiteral<"custom">;
+    custom: z.ZodString;
+}, z.core.$strict>;
+export type CheckoutCustomFieldLabel = z.output<typeof checkoutCustomFieldLabelSchema>;
+export declare const checkoutCustomFieldDropdownOptionSchema: z.ZodObject<{
+    label: z.ZodString;
+    value: z.ZodString;
+}, z.core.$strict>;
+export type CheckoutCustomFieldDropdownOption = z.output<typeof checkoutCustomFieldDropdownOptionSchema>;
+/** A merchant-defined field the payer fills in; `value`s are what they entered. */
+export declare const checkoutCustomFieldSchema: z.ZodObject<{
+    key: z.ZodString;
+    label: z.ZodObject<{
+        type: z.ZodLiteral<"custom">;
+        custom: z.ZodString;
+    }, z.core.$strict>;
+    type: z.ZodEnum<{
+        text: "text";
+        numeric: "numeric";
+        dropdown: "dropdown";
+    }>;
+    optional: z.ZodBoolean;
+    dropdown: z.ZodNullable<z.ZodObject<{
+        options: z.ZodArray<z.ZodObject<{
+            label: z.ZodString;
+            value: z.ZodString;
+        }, z.core.$strict>>;
+        value: z.ZodNullable<z.ZodString>;
+    }, z.core.$strict>>;
+    text: z.ZodNullable<z.ZodObject<{
+        minimum_length: z.ZodNullable<z.ZodNumber>;
+        maximum_length: z.ZodNullable<z.ZodNumber>;
+        value: z.ZodNullable<z.ZodString>;
+    }, z.core.$strict>>;
+    numeric: z.ZodNullable<z.ZodObject<{
+        minimum_length: z.ZodNullable<z.ZodNumber>;
+        maximum_length: z.ZodNullable<z.ZodNumber>;
+        value: z.ZodNullable<z.ZodString>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type CheckoutCustomField = z.output<typeof checkoutCustomFieldSchema>;
+export declare const checkoutDiscountSchema: z.ZodObject<{
+    coupon: z.ZodString;
+    promotion_code: z.ZodNullable<z.ZodString>;
+}, z.core.$strict>;
+export type CheckoutDiscount = z.output<typeof checkoutDiscountSchema>;
+export declare const checkoutTotalDetailsSchema: z.ZodObject<{
+    amount_discount: z.ZodString;
+    amount_tax: z.ZodString;
+    amount_shipping: z.ZodString;
+}, z.core.$strict>;
+export type CheckoutTotalDetails = z.output<typeof checkoutTotalDetailsSchema>;
+/**
+ * `automatic_tax` — Peable Tax (ADR 0011). `requires_location_inputs` until
+ * the payer gave an address Peable Tax can locate them with; `failed` when the
+ * sale is covered and could not be priced (checkout refuses to proceed: tax
+ * fails CLOSED, never zero).
+ */
+export declare const checkoutAutomaticTaxSchema: z.ZodObject<{
+    enabled: z.ZodBoolean;
+    status: z.ZodNullable<z.ZodEnum<{
+        requires_location_inputs: "requires_location_inputs";
+        failed: "failed";
+        complete: "complete";
+    }>>;
+}, z.core.$strict>;
+export type CheckoutAutomaticTax = z.output<typeof checkoutAutomaticTaxSchema>;
+export declare const checkoutConsentCollectionSchema: z.ZodObject<{
+    terms_of_service: z.ZodEnum<{
+        none: "none";
+        required: "required";
+    }>;
+}, z.core.$strict>;
+export type CheckoutConsentCollection = z.output<typeof checkoutConsentCollectionSchema>;
+export declare const checkoutConsentSchema: z.ZodObject<{
+    terms_of_service: z.ZodNullable<z.ZodLiteral<"accepted">>;
+}, z.core.$strict>;
+export type CheckoutConsent = z.output<typeof checkoutConsentSchema>;
+/** The collection options, as a session or link reports them. */
+export declare const collectionResponseFields: {
+    billing_address_collection: z.ZodEnum<{
+        auto: "auto";
+        required: "required";
+    }>;
+    shipping_address_collection: z.ZodNullable<z.ZodObject<{
+        allowed_countries: z.ZodArray<z.ZodString>;
+    }, z.core.$strict>>;
+    phone_number_collection: z.ZodObject<{
+        enabled: z.ZodBoolean;
+    }, z.core.$strict>;
+    tax_id_collection: z.ZodObject<{
+        enabled: z.ZodBoolean;
+    }, z.core.$strict>;
+    custom_fields: z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        label: z.ZodObject<{
+            type: z.ZodLiteral<"custom">;
+            custom: z.ZodString;
+        }, z.core.$strict>;
+        type: z.ZodEnum<{
+            text: "text";
+            numeric: "numeric";
+            dropdown: "dropdown";
+        }>;
+        optional: z.ZodBoolean;
+        dropdown: z.ZodNullable<z.ZodObject<{
+            options: z.ZodArray<z.ZodObject<{
+                label: z.ZodString;
+                value: z.ZodString;
+            }, z.core.$strict>>;
+            value: z.ZodNullable<z.ZodString>;
+        }, z.core.$strict>>;
+        text: z.ZodNullable<z.ZodObject<{
+            minimum_length: z.ZodNullable<z.ZodNumber>;
+            maximum_length: z.ZodNullable<z.ZodNumber>;
+            value: z.ZodNullable<z.ZodString>;
+        }, z.core.$strict>>;
+        numeric: z.ZodNullable<z.ZodObject<{
+            minimum_length: z.ZodNullable<z.ZodNumber>;
+            maximum_length: z.ZodNullable<z.ZodNumber>;
+            value: z.ZodNullable<z.ZodString>;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>;
+    consent_collection: z.ZodNullable<z.ZodObject<{
+        terms_of_service: z.ZodEnum<{
+            none: "none";
+            required: "required";
+        }>;
+    }, z.core.$strict>>;
+};
+/** The public, secret-free merchant identity a payer surface renders. */
+export declare const merchantDisplaySchema: z.ZodObject<{
+    name: z.ZodString;
+    avatar_url: z.ZodNullable<z.ZodString>;
+    logo_url: z.ZodNullable<z.ZodString>;
+    description: z.ZodNullable<z.ZodString>;
+}, z.core.$strict>;
+export type MerchantDisplay = z.output<typeof merchantDisplaySchema>;
+/**
+ * Branding as a payer surface renders it: every field resolved (defaults
+ * filled in), the logo and icon as URLs the gateway built through Oxy's media
+ * chokepoint — a withheld file is `null`, never a broken image.
+ */
+export declare const checkoutBrandingSchema: z.ZodObject<{
+    icon_url: z.ZodNullable<z.ZodString>;
+    logo_url: z.ZodNullable<z.ZodString>;
+    primary_color: z.ZodString;
+    accent_color: z.ZodString;
+    font: z.ZodEnum<{
+        system: "system";
+        inter: "inter";
+        roboto: "roboto";
+        open_sans: "open_sans";
+        lato: "lato";
+        source_sans: "source_sans";
+        noto_sans: "noto_sans";
+        serif: "serif";
+        monospace: "monospace";
+    }>;
+    border_style: z.ZodEnum<{
+        rounded: "rounded";
+        rectangular: "rectangular";
+        pill: "pill";
+    }>;
+}, z.core.$strict>;
+export type CheckoutBranding = z.output<typeof checkoutBrandingSchema>;
+export declare const checkoutIdParam: z.ZodString;
+export declare const countryCodeParam: z.ZodString;
+/** A base-unit amount in a request. */
+export declare const amountParam: z.ZodString;
+/**
+ * A redirect target. `https` only, except `http://localhost` for development —
+ * a payer is sent there after paying, so an `http` URL elsewhere would leak the
+ * session id in the clear. `{CHECKOUT_SESSION_ID}` may appear anywhere.
+ */
+export declare const redirectUrlParam: z.ZodString;
+/** `auto` follows the payer's browser: parsed as `null`. */
+export declare const localeParam: z.ZodPipe<z.ZodEnum<{
+    en: "en";
+    es: "es";
+    fr: "fr";
+    de: "de";
+    it: "it";
+    pt: "pt";
+    auto: "auto";
+}>, z.ZodTransform<"en" | "es" | "fr" | "de" | "it" | "pt" | null, "en" | "es" | "fr" | "de" | "it" | "pt" | "auto">>;
+export declare const checkoutEmailParam: z.ZodString;
+declare const customFieldParam: z.ZodObject<{
+    key: z.ZodString;
+    label: z.ZodObject<{
+        type: z.ZodLiteral<"custom">;
+        custom: z.ZodString;
+    }, z.core.$strict>;
+    type: z.ZodEnum<{
+        text: "text";
+        numeric: "numeric";
+        dropdown: "dropdown";
+    }>;
+    optional: z.ZodOptional<z.ZodBoolean>;
+    dropdown: z.ZodOptional<z.ZodObject<{
+        options: z.ZodArray<z.ZodObject<{
+            label: z.ZodString;
+            value: z.ZodString;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>;
+    text: z.ZodOptional<z.ZodObject<{
+        minimum_length: z.ZodOptional<z.ZodNumber>;
+        maximum_length: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strict>>;
+    numeric: z.ZodOptional<z.ZodObject<{
+        minimum_length: z.ZodOptional<z.ZodNumber>;
+        maximum_length: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type CheckoutCustomFieldParams = z.input<typeof customFieldParam>;
+/** At most three, keys unique. */
+export declare const customFieldsParam: z.ZodArray<z.ZodObject<{
+    key: z.ZodString;
+    label: z.ZodObject<{
+        type: z.ZodLiteral<"custom">;
+        custom: z.ZodString;
+    }, z.core.$strict>;
+    type: z.ZodEnum<{
+        text: "text";
+        numeric: "numeric";
+        dropdown: "dropdown";
+    }>;
+    optional: z.ZodOptional<z.ZodBoolean>;
+    dropdown: z.ZodOptional<z.ZodObject<{
+        options: z.ZodArray<z.ZodObject<{
+            label: z.ZodString;
+            value: z.ZodString;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>;
+    text: z.ZodOptional<z.ZodObject<{
+        minimum_length: z.ZodOptional<z.ZodNumber>;
+        maximum_length: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strict>>;
+    numeric: z.ZodOptional<z.ZodObject<{
+        minimum_length: z.ZodOptional<z.ZodNumber>;
+        maximum_length: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strict>>;
+}, z.core.$strict>>;
+/** The collection options, as a request names them — shared by sessions and links. */
+export declare const collectionParams: {
+    billing_address_collection: z.ZodOptional<z.ZodEnum<{
+        auto: "auto";
+        required: "required";
+    }>>;
+    shipping_address_collection: z.ZodOptional<z.ZodObject<{
+        allowed_countries: z.ZodArray<z.ZodString>;
+    }, z.core.$strict>>;
+    phone_number_collection: z.ZodOptional<z.ZodObject<{
+        enabled: z.ZodBoolean;
+    }, z.core.$strict>>;
+    tax_id_collection: z.ZodOptional<z.ZodObject<{
+        enabled: z.ZodBoolean;
+    }, z.core.$strict>>;
+    consent_collection: z.ZodOptional<z.ZodObject<{
+        terms_of_service: z.ZodOptional<z.ZodEnum<{
+            none: "none";
+            required: "required";
+        }>>;
+    }, z.core.$strict>>;
+    custom_fields: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        label: z.ZodObject<{
+            type: z.ZodLiteral<"custom">;
+            custom: z.ZodString;
+        }, z.core.$strict>;
+        type: z.ZodEnum<{
+            text: "text";
+            numeric: "numeric";
+            dropdown: "dropdown";
+        }>;
+        optional: z.ZodOptional<z.ZodBoolean>;
+        dropdown: z.ZodOptional<z.ZodObject<{
+            options: z.ZodArray<z.ZodObject<{
+                label: z.ZodString;
+                value: z.ZodString;
+            }, z.core.$strict>>;
+        }, z.core.$strict>>;
+        text: z.ZodOptional<z.ZodObject<{
+            minimum_length: z.ZodOptional<z.ZodNumber>;
+            maximum_length: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strict>>;
+        numeric: z.ZodOptional<z.ZodObject<{
+            minimum_length: z.ZodOptional<z.ZodNumber>;
+            maximum_length: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>>;
+};
+export declare const adjustableQuantityParam: z.ZodObject<{
+    enabled: z.ZodBoolean;
+    minimum: z.ZodOptional<z.ZodNumber>;
+    maximum: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strict>;
+export type AdjustableQuantityParams = z.output<typeof adjustableQuantityParam>;
+export declare const quantityParam: z.ZodNumber;
+/** Stripe's defaults: 0–99 when enabled. */
+export declare function adjustableBoundsOf(adjustable: AdjustableQuantityParams | undefined): {
+    minimum: number;
+    maximum: number;
+} | null;
+/** The refusals of a line's `quantity` against its `adjustable_quantity`. */
+export declare function adjustableIssues(quantity: number, adjustable: AdjustableQuantityParams | undefined, ctx: z.RefinementCtx): void;
+export {};