@behio/storefront-sdk 1.9.0 → 1.18.0

package/dist/{client-C635vSzU.d.ts → client-B29GktSJ.d.ts}

@@ -100,6 +100,13 @@ interface CheckoutSettings {
     requireGdprConsent: boolean;
     /** Default state of the newsletter opt-in on the checkout (or hide it). */
     newsletterOptInDefault: NewsletterOptInDefault;
+    /**
+     * Merchant collects consent for marketing SMS in the checkout. When true,
+     * render an OPTIONAL, unchecked checkbox in the contact step and send the
+     * answer as `smsConsent` in `checkout.createOrder`. Never make it required:
+     * order updates are transactional and need no consent, marketing does.
+     */
+    collectSmsConsent: boolean;
     /** Minimum order value in the shop default currency, or null when unset. */
     minOrderValue: number | null;
     /** Maximum order value in the shop default currency, or null when unset. */
@@ -173,6 +180,21 @@ interface ShopInfo {
      * than hardcoded template config.
      */
     quotesEnabled: boolean;
+    /**
+     * Countries the shop delivers to, derived from the ENABLED shipping methods
+     * (union of their allowed countries). `null` = no restriction (some enabled
+     * method ships anywhere), `[]` = no enabled shipping method. Limit the
+     * checkout country select to this list so a shopper from an unserved
+     * country learns it up front, not at the shipping step. Optional because
+     * cached ShopInfo payloads predating SDK 1.15.0 may still be served.
+     */
+    shippingCountries?: string[] | null;
+    /**
+     * Default currency per delivery country, e.g. `{SK: "EUR"}`. When the
+     * shopper picks such a country, switch the cart with `cart.setCurrency()`
+     * (and the display currency) unless they chose one themselves. SDK 1.17.0.
+     */
+    currencyByCountry?: Record<string, string>;
     /** Full merchant checkout & cart contract. Honour these in cart + checkout. */
     checkout: CheckoutSettings;
     /**
@@ -269,6 +291,45 @@ interface CheckoutPaymentMethod {
     feeCurrency?: string | null;
     /** Customer-safe slice of config: bank account, IBAN, instructions, … */
     publicConfig?: Record<string, unknown>;
+    /**
+     * Concrete payment instruments the provider offers for this method
+     * (card, Google Pay, Apple Pay, bank transfer with a bank grid, ...).
+     * Gateways such as GoPay require the customer to choose the instrument
+     * ALREADY IN THE CHECKOUT, so render them as tiles under the selected method
+     * and send the chosen `code` as `paymentInstrument` in `createOrder` (plus
+     * `paymentSwift` for `BANK_ACCOUNT`). `null` = the provider has no
+     * instruments (cash on delivery, plain bank transfer, Stripe hosted page);
+     * render nothing extra and send nothing extra. SDK 1.14.0.
+     */
+    instruments?: PaymentInstrument[] | null;
+}
+/**
+ * One payment instrument of a gateway method (SDK 1.14.0). The first item is
+ * the sensible default (card for GoPay). `swifts` is non-empty only for
+ * `BANK_ACCOUNT`, where the customer additionally picks a bank.
+ */
+interface PaymentInstrument {
+    /** Provider code: "PAYMENT_CARD" | "BANK_ACCOUNT" | "GPAY" | "APPLE_PAY" | "PAYPAL" | ... */
+    code: string;
+    /** Localized label (requested `locale`), e.g. "Platební karta". */
+    label: string;
+    /** Small logo URL or null. */
+    image: string | null;
+    /** Larger logo URL or null. */
+    imageLarge: string | null;
+    /** Banks for `BANK_ACCOUNT`; empty for every other instrument. */
+    swifts: PaymentSwift[];
+}
+/** One bank of a `BANK_ACCOUNT` instrument (SDK 1.14.0). */
+interface PaymentSwift {
+    /** SWIFT/BIC, e.g. "FIOBCZPP". Send it as `paymentSwift`. */
+    code: string;
+    /** Localized bank name. */
+    label: string;
+    /** Bank logo URL or null. */
+    image: string | null;
+    /** Instant online bank payment; show these first. */
+    online: boolean;
 }
 interface ProductPrice {
     amount: number;
@@ -996,6 +1057,12 @@ type AddressType = (typeof AddressTypes)[keyof typeof AddressTypes];
 interface ProductsQuery {
     page?: number;
     limit?: number;
+    /**
+     * Delivery country (ISO-2). Lets country-scoped price rules (for example a
+     * surcharge for SK) apply in the listing; the cart and checkout use the
+     * cart destination instead.
+     */
+    country?: string;
     /** Single category slug (OR logic with categories array) */
     category?: string;
     /** Multiple category slugs (OR logic — product in ANY of these categories) */
@@ -1148,20 +1215,48 @@ interface Cart {
     id: string;
     sessionToken?: string;
     items: CartItem[];
+    /** Sum of the lines at catalog prices: VAT included when the shop runs
+     *  `INCL_VAT`, VAT excluded when it runs `EXCL_VAT`. Not the payable amount,
+     *  that is `grandTotal`. */
     subtotal: number;
+    /** Discount from the applied code. Always based on `subtotal`, i.e. on the
+     *  prices the customer sees, so "10 % off 200" is 20 in both price modes. */
     discountTotal: number;
     discount?: CartDiscount;
     /** Auto-apply promotion discount lines (sale/BOGO). */
     appliedPromotions: CartPromotion[];
     /** Sum of `appliedPromotions[].discountAmount`; already reflected in `grandTotal`. */
     promotionDiscountTotal: number;
+    /** THE PAYABLE AMOUNT for the goods, VAT included, after discounts. This is
+     *  exactly what the customer pays for the cart lines, minus shipping and the
+     *  payment-method fee (both chosen at checkout and added to
+     *  `order.grandTotal`).
+     *
+     *  `grandTotal = netSubtotal + taxTotal - discounts` holds in BOTH price
+     *  modes: under `INCL_VAT` the VAT is extracted out of the price (the sum is
+     *  back to the catalog price), under `EXCL_VAT` it is added on top. Render
+     *  this as the cart total; do not add `taxTotal` to it. */
     grandTotal: number;
-    /** Total VAT contained in / added to the cart across all lines (GAP-30). An
-     *  estimate finalized at checkout once the shipping country is known. */
+    /** VAT contained in the prices (`INCL_VAT`) or added on top of them
+     *  (`EXCL_VAT`), across all lines (GAP-30). An estimate finalized at checkout
+     *  once the shipping country is known. */
     taxTotal: number;
     /** VAT split by rate for "DPH 21 %: X Kč" summary rows. Empty for a
      *  non-VAT-payer shop. */
     taxBreakdown: TaxBreakdownLine[];
+    /** Delivery country set via `cart.setDestination()`, null until known. SDK 1.17.0. */
+    shippingCountry: string | null;
+    /**
+     * Which VAT rule the cart uses: `DOMESTIC` (home rate), `OSS` (delivery
+     * country rate), `REVERSE_CHARGE` (EU business with a valid VAT ID, 0 %),
+     * `EXPORT` (outside the EU, 0 %). Show a note for the last two: the
+     * breakdown is empty then. SDK 1.17.0.
+     */
+    vatMode: "DOMESTIC" | "OSS" | "REVERSE_CHARGE" | "EXPORT";
+    /** B2B VAT ID set via `cart.setDestination()`. */
+    vatId: string | null;
+    /** VIES result for `vatId`: true valid, false invalid or unverifiable, null not given. */
+    vatIdValid: boolean | null;
     currency: string;
     itemCount: number;
     /** Applied gift cards (multi). They deduct at checkout (consumed in order, each
@@ -1219,6 +1314,8 @@ interface CheckoutAddress {
     street: string;
     city: string;
     zip: string;
+    /** State / province where the country needs it (US, CA, AU, BR, IN, MX). SDK 1.17.0. */
+    state?: string;
     country: string;
     phone?: string;
 }
@@ -1243,6 +1340,14 @@ interface CheckoutInput {
     termsConsent?: boolean;
     gdprConsent?: boolean;
     newsletterOptIn?: boolean;
+    /**
+     * Consent to marketing SMS, from the optional checkout checkbox. Render it
+     * only when `ShopInfo.checkout.collectSmsConsent` is true; shops that do not
+     * collect consent ignore the flag. The consent is stored against the phone
+     * number on the created order, so it needs a usable phone in the order or
+     * the shipping address, and it never blocks or fails the order.
+     */
+    smsConsent?: boolean;
     /**
      * Chosen shipping method. Required whenever the eshop has at least one
      * enabled shipping method — the backend rejects the order without it.
@@ -1262,7 +1367,33 @@ interface CheckoutInput {
      * the backend rejects the order without it. Snapshotted onto the order.
      */
     pickupPointId?: string;
+    /**
+     * Snapshot of the chosen point when it came from a carrier widget and may
+     * not be in Behio's cache yet (Packeta serves partner points too). Sent
+     * along with `pickupPointId`; ignored when the cache knows the point.
+     * SDK 1.16.0.
+     */
+    pickupPoint?: {
+        name: string;
+        street?: string;
+        city?: string;
+        zip?: string;
+        country?: string;
+    };
     paymentMethodId?: string;
+    /**
+     * Chosen instrument `code` of the payment method (SDK 1.14.0), e.g.
+     * "PAYMENT_CARD" | "GPAY" | "APPLE_PAY" | "BANK_ACCOUNT". Send it whenever the
+     * chosen method lists `instruments`; the gateway is then opened directly on
+     * that instrument. An instrument the method does not offer returns 400
+     * (`be.storefront.paymentInstrumentInvalid`).
+     */
+    paymentInstrument?: string;
+    /**
+     * Chosen bank SWIFT for `paymentInstrument: "BANK_ACCOUNT"` (SDK 1.14.0),
+     * from `PaymentInstrument.swifts[].code`. Ignored for other instruments.
+     */
+    paymentSwift?: string;
     /**
      * Loyalty points to redeem on this order. Validated server-side against the
      * customer's actual balance and the program's redemption cap; ignored for
@@ -1330,6 +1461,8 @@ interface OrderDetail extends OrderListItem {
     /** VAT split by rate (GAP-30), summed from the order lines. Render
      *  "DPH 21 %: X Kč" rows. Empty for a non-VAT order. */
     taxBreakdown: TaxBreakdownLine[];
+    /** DOMESTIC, OSS, REVERSE_CHARGE (no VAT, buyer accounts for it) or EXPORT (no VAT, outside EU). SDK 1.17.0. */
+    vatMode?: "DOMESTIC" | "OSS" | "REVERSE_CHARGE" | "EXPORT" | null;
     shippingTotal: number;
     discountTotal: number;
     fulfillmentStatus: FulfillmentStatus;
@@ -1673,6 +1806,19 @@ interface CustomerAddress {
     city: string;
     zip: string;
     country: string;
+    /** State / region for countries that need it (US, CA, AU). */
+    state?: string | null;
+    /** Company registration number. */
+    companyId?: string | null;
+    /** VAT ID. EU numbers are verified in VIES when the address is saved. */
+    vatId?: string | null;
+    /**
+     * VIES result at save time: true = valid, false = not confirmed, null = no
+     * VAT ID or not an EU number. Read-only, the server sets it.
+     */
+    vatIdValid?: boolean | null;
+    /** When the VAT ID was last checked (ms). Read-only. */
+    vatIdCheckedAt?: number | null;
     phone?: string;
 }
 interface Page {
@@ -1701,6 +1847,159 @@ interface PageAttachment {
     mimeType: string;
     fileSize: number;
 }
+interface BlogSettings {
+    postsPerPage?: number;
+    showAuthor?: boolean;
+    showReadingTime?: boolean;
+    showTags?: boolean;
+    layout?: "grid" | "list" | "magazine";
+}
+/** One blog (a group of posts). A site can have several: news, recipes, stories. */
+interface Blog {
+    /** URL segment: /blog/{handle} */
+    handle: string;
+    name: string;
+    description: string | null;
+    postCount: number;
+    settings: BlogSettings;
+    /** Latest publish time (epoch ms), for sitemaps. */
+    updatedAt: number | null;
+}
+interface BlogTag {
+    slug: string;
+    name: string;
+}
+interface BlogPostListItem {
+    slug: string;
+    title: string;
+    excerpt: string | null;
+    coverUrl: string | null;
+    publishedAt: number | null;
+    readingTimeMin: number | null;
+    authorName: string | null;
+    isFeatured: boolean;
+    tags: BlogTag[];
+}
+interface BlogPostsPage {
+    items: BlogPostListItem[];
+    total: number;
+    page: number;
+    limit: number;
+    totalPages: number;
+    /** Tags of the blog (for a filter). */
+    tags: BlogTag[];
+}
+interface BlogPostDetail {
+    slug: string;
+    blogHandle: string;
+    blogName: string;
+    title: string;
+    excerpt: string | null;
+    /** `{format: "html", html}` sanitised by the API; render with RichText. */
+    content: {
+        format?: string;
+        html?: string;
+    } & Record<string, unknown>;
+    coverUrl: string | null;
+    publishedAt: number | null;
+    updatedAt: number | null;
+    readingTimeMin: number | null;
+    authorName: string | null;
+    tags: BlogTag[];
+    seoTitle: string | null;
+    seoDescription: string | null;
+    ogImage: string | null;
+    /** Other posts of the same blog. */
+    related: BlogPostListItem[];
+}
+interface BlogPostsQuery {
+    locale?: string;
+    page?: number;
+    limit?: number;
+    /** Filter by tag slug. */
+    tag?: string;
+}
+type SiteFormFieldType = "text" | "email" | "phone" | "textarea" | "number" | "select" | "radio" | "checkbox" | "multiselect" | "date"
+/** "HH:MM" */
+ | "time"
+/** "YYYY-MM-DDTHH:MM" without a zone, as `<input type="datetime-local">` */
+ | "datetime"
+/** http(s) address */
+ | "url" | "hidden";
+interface SiteFormFieldOption {
+    value: string;
+    label: string;
+}
+/** One field of a merchant-defined form; render it by `type`. */
+interface SiteFormField {
+    /** Key in the submitted `data` object (lowercase, underscores). */
+    key: string;
+    type: SiteFormFieldType;
+    label: string;
+    placeholder?: string;
+    /** Help line under the field. */
+    help?: string;
+    required: boolean;
+    /** Present for select / radio / multiselect. */
+    options?: SiteFormFieldOption[];
+    /** Number: min/max value. Text: min/max length. */
+    min?: number;
+    max?: number;
+    /** Regular expression for text fields (without slashes). */
+    pattern?: string;
+    /** Layout hint: "half" fields sit side by side on wide screens. */
+    width?: "full" | "half";
+    /** Value of hidden fields (source, campaign) or a prefill for visible ones. */
+    defaultValue?: string;
+}
+interface StorefrontFormSettings {
+    submitLabel?: string;
+    /** Shown after a successful submit (also returned as `message`). */
+    successMessage?: string;
+    /** When set, redirect the visitor here after a successful submit. */
+    redirectUrl?: string;
+    /** Text of the consent checkbox. */
+    consentText?: string;
+    /** When true, `consent: true` is required for the submit to pass. */
+    requireConsent?: boolean;
+}
+/** Public definition of a form (`GET /forms/{slug}`). */
+interface StorefrontForm {
+    slug: string;
+    name: string;
+    description: string | null;
+    fields: SiteFormField[];
+    settings: StorefrontFormSettings;
+}
+interface StorefrontFormSubmitInput {
+    /** `{fieldKey: value}`; unknown keys are dropped server-side. */
+    data: Record<string, unknown>;
+    locale?: string;
+    /** URL of the page the form was submitted from (context for the merchant). */
+    page?: string;
+    /** Consent checkbox state (required when `settings.requireConsent`). */
+    consent?: boolean;
+    /**
+     * Honeypot. Render it as a visually hidden input and pass its value through
+     * untouched: a filled value is answered like a success but stored nowhere.
+     */
+    website?: string;
+}
+interface StorefrontFormSubmitResult {
+    ok: boolean;
+    /** Id of the stored submission (null when the form does not store responses). */
+    id: string | null;
+    /** `settings.successMessage`, when set. */
+    message: string | null;
+    /** `settings.redirectUrl`, when set. */
+    redirectUrl: string | null;
+}
+type StorefrontFormFieldErrorCode = "required" | "invalid" | "tooShort" | "tooLong" | "min" | "max" | "notOption" | "pattern";
+/** One per-field validation error of a rejected submit (`be.forms.validationFailed`). */
+interface StorefrontFormFieldError {
+    key: string;
+    code: StorefrontFormFieldErrorCode;
+}
 type BehioErrorCode = "UNAUTHORIZED" | "FORBIDDEN" | "NOT_FOUND" | "VALIDATION_ERROR" | "CONFLICT" | "RATE_LIMITED" | "CART_EMPTY" | "PRODUCT_NOT_FOUND" | "INVALID_CREDENTIALS" | "INVALID_DISCOUNT" | "DISCOUNT_EXPIRED" | "TOKEN_EXPIRED" | "TOKEN_INVALID" | "EMAIL_ALREADY_EXISTS" | "ORDER_NOT_CANCELLABLE" | "INTERNAL_ERROR" | "NETWORK_ERROR" | "TIMEOUT" | "UNKNOWN";
 declare class BehioApiError extends Error {
     readonly code: BehioErrorCode;
@@ -1905,6 +2204,27 @@ interface ShippingQuote extends ShippingMethodSummary {
  * `supportsPickupPoints`. Fetch with `behio.shipping.getPickupPoints()`,
  * then send the chosen `externalId` as `checkout.pickupPointId`.
  */
+/**
+ * Carrier map widget for choosing a pickup point in checkout. Present in
+ * `ShippingMethod.publicConfig.pickupWidget` when the merchant's carrier
+ * supports it (today Packeta: load https://widget.packeta.com/v6/www/js/library.js
+ * and call `Packeta.Widget.pick(apiKey, cb, {country, language})`; send
+ * `String(point.id)` back as `checkout.pickupPointId`). SDK 1.15.0.
+ * `provider: "behio"` (SDK 1.16.0) means "draw the map yourself from
+ * `getPickupPoints()` coordinates".
+ */
+type PickupWidgetConfig = {
+    provider: "packeta";
+    /** Public widget key (never the API password). */
+    apiKey: string;
+} | {
+    /**
+     * No carrier widget, but every point from `getPickupPoints()` carries
+     * `latitude`/`longitude`: render your own map (SDK 1.16.0; PPL, GLS,
+     * Aramex, Zaslat).
+     */
+    provider: "behio";
+};
 interface PickupPoint {
     /** Carrier-native id. Send this back as `checkout.pickupPointId`. */
     externalId: string;
@@ -2072,6 +2392,10 @@ interface GiftCardPurchaseInput {
     personalMessage?: string;
     /** Online payment method id (from listPaymentMethods) to start payment right away. */
     paymentMethodId?: string;
+    /** Instrument `code` of the chosen method (SDK 1.14.0), see `CheckoutInput.paymentInstrument`. */
+    paymentInstrument?: string;
+    /** Bank SWIFT for `paymentInstrument: "BANK_ACCOUNT"` (SDK 1.14.0). */
+    paymentSwift?: string;
     locale?: string;
 }
 interface GiftCardPurchaseResult {
@@ -2356,6 +2680,8 @@ declare class BehioStorefront {
     readonly orders: OrdersModule;
     readonly customer: CustomerModule;
     readonly pages: PagesModule;
+    readonly blog: BlogModule;
+    readonly forms: FormsModule;
     readonly wishlist: WishlistModule;
     readonly reviews: ReviewsModule;
     readonly returns: ReturnsModule;
@@ -2545,6 +2871,7 @@ declare class CatalogModule {
     getProduct(slug: string, options?: {
         locale?: string;
         currency?: string;
+        country?: string;
     }): Promise<SdkResult<ProductDetail>>;
     /**
      * URLs for the sitemap, already filtered by the merchant's indexing choice
@@ -2667,9 +2994,25 @@ declare class CatalogModule {
      * code is generated and emailed to the recipient once the order is paid.
      */
     purchaseGiftCard(input: GiftCardPurchaseInput): Promise<SdkResult<GiftCardPurchaseResult>>;
-    /** List configured payment methods (filtered by currency). */
+    /**
+     * List configured payment methods (filtered by currency). `locale` picks the
+     * language of `instruments[].label` / `swifts[].label` (SDK 1.14.0); pass the
+     * locale of the page so the instrument tiles read in the shopper's language.
+     */
     listPaymentMethods(opts?: {
         currency?: string;
+        locale?: string;
+        /** Delivery country (ISO): hides methods not valid there, orders them per country. SDK 1.15.0 */
+        country?: string;
+        /** Chosen shipping method: hides cash on delivery when the carrier cannot do it. SDK 1.15.0 */
+        shippingMethodId?: string;
+    }): Promise<SdkResult<{
+        items: CheckoutPaymentMethod[];
+    }>>;
+    /** Alias of `listPaymentMethods` (SDK 1.14.0). */
+    paymentMethods(opts?: {
+        currency?: string;
+        locale?: string;
     }): Promise<SdkResult<{
         items: CheckoutPaymentMethod[];
     }>>;
@@ -2719,6 +3062,22 @@ declare class CartModule {
      * ```
      */
     setCurrency(currency: string): Promise<SdkResult<Cart>>;
+    /**
+     * Tell the cart where the order will ship (and, for B2B, the buyer's VAT
+     * ID) so the VAT breakdown matches the checkout before the address form:
+     * destination-country rate (OSS), 0 % export outside the EU, or reverse
+     * charge for an EU business with a VIES-valid VAT ID. `cart.vatMode` says
+     * which rule applied. SDK 1.17.0.
+     *
+     * ```ts
+     * await client.cart.setDestination({ country: "SK" });
+     * await client.cart.setDestination({ vatId: "SK2020000001" }); // "" clears
+     * ```
+     */
+    setDestination(input: {
+        country?: string;
+        vatId?: string | null;
+    }): Promise<SdkResult<Cart>>;
     /** Update item quantity */
     updateQuantity(itemId: string, quantity: number): Promise<SdkResult<Cart>>;
     /** Remove item from cart */
@@ -2771,6 +3130,27 @@ declare class CheckoutModule {
 declare class OrdersModule {
     private client;
     constructor(client: BehioStorefront);
+    /**
+     * Ask the backend to re-check this order's payment with the gateway.
+     *
+     * Call it on the thank-you page the customer lands on after paying, BEFORE
+     * you read the order. Some gateways (Tatrapay+) have no server-to-server
+     * notification at all, so the customer's return is the only fast way the
+     * payment gets confirmed; for the others it is a safety net for a lost
+     * notification.
+     *
+     * The response is deliberately opaque (`{ok: true}` every time, even for an
+     * order number that does not exist): order numbers are sequential, so
+     * anything else would turn this into a probe for other people's orders.
+     * Read the actual state afterwards through a path that proves entitlement
+     * ({@link get}, {@link track} or the guest access-code flow).
+     *
+     * Never throws for a missing order and never blocks the page: treat a
+     * failure as "not confirmed yet", the backend poller catches up on its own.
+     */
+    syncPaymentOnReturn(orderNumber: string): Promise<SdkResult<{
+        ok: boolean;
+    }>>;
     /** List customer orders (requires auth) */
     list(options?: {
         page?: number;
@@ -2828,9 +3208,12 @@ declare class CustomerModule {
         items: CustomerAddress[];
     }>>;
     /** Create address */
-    createAddress(address: Omit<CustomerAddress, "id">): Promise<SdkResult<CustomerAddress>>;
-    /** Update address */
-    updateAddress(addressId: string, data: Partial<CustomerAddress>): Promise<SdkResult<CustomerAddress>>;
+    createAddress(address: Omit<CustomerAddress, "id" | "vatIdValid" | "vatIdCheckedAt">): Promise<SdkResult<CustomerAddress>>;
+    /**
+     * Update address. Partial: `{isDefault: true}` alone is a valid body. A
+     * changed `vatId` or `country` re-runs the VIES check on the server.
+     */
+    updateAddress(addressId: string, data: Partial<Omit<CustomerAddress, "id" | "vatIdValid" | "vatIdCheckedAt">>): Promise<SdkResult<CustomerAddress>>;
     /** Delete address */
     deleteAddress(addressId: string): Promise<SdkResult<void>>;
     /**
@@ -2951,6 +3334,37 @@ declare class PagesModule {
     /** Get page by slug */
     get(slug: string, locale?: string): Promise<SdkResult<PageDetail>>;
 }
+declare class BlogModule {
+    private client;
+    constructor(client: BehioStorefront);
+    /** List the site's blogs (active only). */
+    list(locale?: string): Promise<SdkResult<{
+        blogs: Blog[];
+    }>>;
+    /** Published posts of one blog, newest first (featured first), paginated. */
+    posts(handle: string, query?: BlogPostsQuery): Promise<SdkResult<BlogPostsPage>>;
+    /** One published post with sanitised HTML content and related posts. */
+    post(handle: string, slug: string, locale?: string): Promise<SdkResult<BlogPostDetail>>;
+}
+/**
+ * Merchant-defined forms (contact, demand, registration to an event...).
+ * The definition is public and cacheable; a submit is validated server-side
+ * against it, so the browser-side checks are only a courtesy. Works with
+ * website keys that have no e-shop attached.
+ */
+declare class FormsModule {
+    private client;
+    constructor(client: BehioStorefront);
+    /** Public definition of one form (fields + settings). 404 for an unknown or inactive slug. */
+    get(slug: string): Promise<SdkResult<StorefrontForm>>;
+    /**
+     * Submit a response. On `be.forms.validationFailed` the returned error
+     * carries per-field codes: read them with `formFieldErrors(error)`. Other
+     * rejections: `be.forms.consentRequired`, `be.forms.tooLarge`,
+     * `be.forms.formNotFound`; rate limit 10 submits per minute per visitor.
+     */
+    submit(slug: string, input: StorefrontFormSubmitInput): Promise<SdkResult<StorefrontFormSubmitResult>>;
+}
 declare class WishlistModule {
     private client;
     constructor(client: BehioStorefront);
@@ -3130,4 +3544,4 @@ declare class NewsletterModule {
     unsubscribe(email: string): Promise<SdkResult<NewsletterUnsubscribeResult>>;
 }
 
-export { type DigitalDownload as $, type ActivePromotion as A, BehioStorefront as B, type CookieConsent as C, type CertificateVerification as D, type CheckoutAddress as E, type CheckoutInput as F, type CheckoutPaymentMethod as G, type CheckoutSettings as H, type CookieConsentInput as I, type CourseAttachment as J, type CourseCertificate as K, type CourseComment as L, type CourseCommentReply as M, type CourseCommentsList as N, type CourseDetail as O, type ProductDetail as P, type CourseLesson as Q, type CourseListItem as R, type SdkResult as S, type CourseModule as T, type CoursePostedComment as U, type CourseProgress as V, type CourseTutorMessage as W, type CourseTutorThread as X, type CrossSellItem as Y, type CustomerAddress as Z, type CustomerProfile as _, type ProductVariant as a, type ProductParameter as a$, type DownloadUrl as a0, type Facet as a1, type FacetAvailability as a2, type FacetCategory as a3, type FacetLabel as a4, type FacetPriceRange as a5, type FacetRange as a6, type FacetRatingBucket as a7, type FacetValue as a8, type FacetsResponse as a9, type OrderAccessRequestResponse as aA, type OrderAccessVerifyResponse as aB, type OrderDetail as aC, type OrderItem as aD, type OrderListItem as aE, type OrderStatus as aF, type OrderStatusHistory as aG, OrderStatuses as aH, type OrderTracking as aI, type Page as aJ, type PageAttachment as aK, type PageDetail as aL, type PaginatedResponse as aM, type PaymentStatus as aN, PaymentStatuses as aO, type PickupPoint as aP, type PickupPointHours as aQ, type PickupPointsInput as aR, type PriceDisplay as aS, type ProductAssetGroup as aT, type ProductAssetItem as aU, type ProductAvailability as aV, type ProductGroup as aW, type ProductLabel as aX, type ProductListItem as aY, type ProductMedia as aZ, type ProductMediaVariant as a_, type FilterField as aa, type FulfillmentStatus as ab, FulfillmentStatuses as ac, type GiftCardBalance as ad, type GiftCardPurchaseInput as ae, type GiftCardPurchaseResult as af, type GiftCardSummary as ag, type LessonNote as ah, type LessonQuiz as ai, type LoginInput as aj, type LoyaltyBalance as ak, type LoyaltyNextTier as al, type LoyaltyProgram as am, type LoyaltySummary as an, type LoyaltyTier as ao, type LoyaltyTierPerks as ap, type LoyaltyTransaction as aq, type Menu as ar, type MenuItem as as, type MenuItemRef as at, type MenuItemType as au, type MessageResponse as av, type NewsletterOptInDefault as aw, type NewsletterSubscribeInput as ax, type NewsletterSubscribeResult as ay, type NewsletterUnsubscribeResult as az, type AddToCartInput as b, type ProductParameterGroup as b0, type ProductParametersResponse as b1, type ProductPrice as b2, type ProductPromotionSummary as b3, type ProductReview as b4, type ProductReviewsResponse as b5, type ProductSibling as b6, ProductSort as b7, type ProductSortValue as b8, type ProductVolumePrice as b9, type ShopScriptType as bA, type ShopScripts as bB, type ShopSeo as bC, type ShopSeoIdentity as bD, type Sitemap as bE, type SitemapEntry as bF, type StockBehavior as bG, type StockMode as bH, type SubmitQuoteInput as bI, type SubmitReturnInput as bJ, type SubmitReviewInput as bK, type Subscription as bL, type SubscriptionAction as bM, type SubscriptionFrequency as bN, type SubscriptionItem as bO, type SubscriptionStatus as bP, type TaxBreakdownLine as bQ, type VariantAxis as bR, type VariantAxisValue as bS, type WishlistItem as bT, err as bU, ok as bV, toSdkError as bW, type ProductsQuery as ba, type QuizAnswerInput as bb, type QuizAnswerResult as bc, type QuizQuestion as bd, type QuizResult as be, type QuoteItem as bf, type QuoteRequest as bg, type RegisterInput as bh, type RegisterResult as bi, type RequestInterceptor as bj, type RequestInterceptorConfig as bk, type ResponseInterceptor as bl, type ResponseInterceptorData as bm, type ReturnRequest as bn, type ReturnRequestItem as bo, type ReturnStatus as bp, type ReturnStatusItem as bq, type ReturnableOrder as br, type ReturnableOrderItem as bs, type SdkError as bt, type ShippingMethodSummary as bu, type ShippingQuote as bv, type ShippingQuoteInput as bw, type ShopInfo as bx, type ShopScript as by, type ShopScriptPlacement as bz, type AddressDetail as c, type AddressSuggestion as d, type AddressType as e, AddressTypes as f, type AuthTokens as g, type BackInStockSubscription as h, type BadgeTone as i, BehioApiError as j, type BehioErrorCode as k, type BehioEventHandler as l, type BehioEventType as m, BehioNetworkError as n, type BehioStorefrontConfig as o, type Bundle as p, type BundleItem as q, type Cart as r, type CartBundleLine as s, type CartBundleLineItem as t, type CartDiscount as u, type CartItem as v, type CartItemProduct as w, type CartPromotion as x, type Category as y, type CategoryDetail as z };
+export { type CourseModule as $, type ActivePromotion as A, BehioStorefront as B, type CookieConsent as C, type CartBundleLine as D, type CartBundleLineItem as E, type CartDiscount as F, type CartItem as G, type CartItemProduct as H, type CartPromotion as I, type Category as J, type CategoryDetail as K, type CertificateVerification as L, type CheckoutAddress as M, type CheckoutInput as N, type CheckoutPaymentMethod as O, type ProductDetail as P, type CheckoutSettings as Q, type CookieConsentInput as R, type SdkResult as S, type CourseAttachment as T, type CourseCertificate as U, type CourseComment as V, type CourseCommentReply as W, type CourseCommentsList as X, type CourseDetail as Y, type CourseLesson as Z, type CourseListItem as _, type ProductVariant as a, type PickupPointsInput as a$, type CoursePostedComment as a0, type CourseProgress as a1, type CourseTutorMessage as a2, type CourseTutorThread as a3, type CrossSellItem as a4, type CustomerAddress as a5, type CustomerProfile as a6, type DigitalDownload as a7, type DownloadUrl as a8, type Facet as a9, type MenuItem as aA, type MenuItemRef as aB, type MenuItemType as aC, type MessageResponse as aD, type NewsletterOptInDefault as aE, type NewsletterSubscribeInput as aF, type NewsletterSubscribeResult as aG, type NewsletterUnsubscribeResult as aH, type OrderAccessRequestResponse as aI, type OrderAccessVerifyResponse as aJ, type OrderDetail as aK, type OrderItem as aL, type OrderListItem as aM, type OrderStatus as aN, type OrderStatusHistory as aO, OrderStatuses as aP, type OrderTracking as aQ, type Page as aR, type PageAttachment as aS, type PageDetail as aT, type PaginatedResponse as aU, type PaymentInstrument as aV, type PaymentStatus as aW, PaymentStatuses as aX, type PaymentSwift as aY, type PickupPoint as aZ, type PickupPointHours as a_, type FacetAvailability as aa, type FacetCategory as ab, type FacetLabel as ac, type FacetPriceRange as ad, type FacetRange as ae, type FacetRatingBucket as af, type FacetValue as ag, type FacetsResponse as ah, type FilterField as ai, type FulfillmentStatus as aj, FulfillmentStatuses as ak, type GiftCardBalance as al, type GiftCardPurchaseInput as am, type GiftCardPurchaseResult as an, type GiftCardSummary as ao, type LessonNote as ap, type LessonQuiz as aq, type LoginInput as ar, type LoyaltyBalance as as, type LoyaltyNextTier as at, type LoyaltyProgram as au, type LoyaltySummary as av, type LoyaltyTier as aw, type LoyaltyTierPerks as ax, type LoyaltyTransaction as ay, type Menu as az, type StorefrontFormFieldError as b, type SubmitQuoteInput as b$, type PickupWidgetConfig as b0, type PriceDisplay as b1, type ProductAssetGroup as b2, type ProductAssetItem as b3, type ProductAvailability as b4, type ProductGroup as b5, type ProductLabel as b6, type ProductListItem as b7, type ProductMedia as b8, type ProductMediaVariant as b9, type ReturnStatus as bA, type ReturnStatusItem as bB, type ReturnableOrder as bC, type ReturnableOrderItem as bD, type SdkError as bE, type ShippingMethodSummary as bF, type ShippingQuote as bG, type ShippingQuoteInput as bH, type ShopInfo as bI, type ShopScript as bJ, type ShopScriptPlacement as bK, type ShopScriptType as bL, type ShopScripts as bM, type ShopSeo as bN, type ShopSeoIdentity as bO, type SiteFormField as bP, type SiteFormFieldOption as bQ, type SiteFormFieldType as bR, type Sitemap as bS, type SitemapEntry as bT, type StockBehavior as bU, type StockMode as bV, type StorefrontForm as bW, type StorefrontFormFieldErrorCode as bX, type StorefrontFormSettings as bY, type StorefrontFormSubmitInput as bZ, type StorefrontFormSubmitResult as b_, type ProductParameter as ba, type ProductParameterGroup as bb, type ProductParametersResponse as bc, type ProductPrice as bd, type ProductPromotionSummary as be, type ProductReview as bf, type ProductReviewsResponse as bg, type ProductSibling as bh, ProductSort as bi, type ProductSortValue as bj, type ProductVolumePrice as bk, type ProductsQuery as bl, type QuizAnswerInput as bm, type QuizAnswerResult as bn, type QuizQuestion as bo, type QuizResult as bp, type QuoteItem as bq, type QuoteRequest as br, type RegisterInput as bs, type RegisterResult as bt, type RequestInterceptor as bu, type RequestInterceptorConfig as bv, type ResponseInterceptor as bw, type ResponseInterceptorData as bx, type ReturnRequest as by, type ReturnRequestItem as bz, type AddToCartInput as c, type SubmitReturnInput as c0, type SubmitReviewInput as c1, type Subscription as c2, type SubscriptionAction as c3, type SubscriptionFrequency as c4, type SubscriptionItem as c5, type SubscriptionStatus as c6, type TaxBreakdownLine as c7, type VariantAxis as c8, type VariantAxisValue as c9, type WishlistItem as ca, err as cb, ok as cc, toSdkError as cd, type AddressDetail as d, type AddressSuggestion as e, type AddressType as f, AddressTypes as g, type AuthTokens as h, type BackInStockSubscription as i, type BadgeTone as j, BehioApiError as k, type BehioErrorCode as l, type BehioEventHandler as m, type BehioEventType as n, BehioNetworkError as o, type BehioStorefrontConfig as p, type Blog as q, type BlogPostDetail as r, type BlogPostListItem as s, type BlogPostsPage as t, type BlogPostsQuery as u, type BlogSettings as v, type BlogTag as w, type Bundle as x, type BundleItem as y, type Cart as z };