brainerce 1.63.0 → 2.0.0

package/dist/index.d.mts

@@ -619,6 +619,15 @@ interface ProductMetafield {
      */
     name?: string;
 }
+/**
+ * Publish state of a product. **Lowercase**, unlike order statuses.
+ *
+ * `active` is visible to shoppers; `draft` is merchant-only. The backend
+ * validates this exact pair on both the query filter and the write DTOs, and
+ * defaults a product to `active`. There is no `archived` product state on this
+ * platform. Archiving exists for modifier groups and modifiers, not products.
+ */
+type ProductStatus = 'active' | 'draft';
 interface Product {
     id: string;
     name: string;
@@ -707,7 +716,7 @@ interface Product {
     /** ISO 4217 currency of `displayPrice` (the buyer's region currency). */
     displayCurrency?: string;
     /** Product status (active, draft). Always returned by backend. */
-    status: string;
+    status: ProductStatus;
     type: 'SIMPLE' | 'VARIABLE';
     /** Whether product is downloadable/digital. */
     isDownloadable?: boolean;
@@ -838,6 +847,20 @@ interface ProductReviewImageAdmin extends ProductReviewImage {
     hiddenAt: string | null;
     createdAt: string;
 }
+/**
+ * Moderation states of a marketplace **app** submission, the values the
+ * platform stores on an app review submission while Brainerce staff approve or
+ * reject a listed app.
+ *
+ * ⛔ **This has nothing to do with product reviews.** Customer product reviews
+ * publish immediately and carry no status field at all: see `ProductReview`
+ * below. Do not build a product-review moderation queue on this type; the
+ * platform does not have one.
+ *
+ * Exported for completeness of the platform vocabulary. No SDK method returns
+ * or accepts it today.
+ */
+type ReviewStatus = 'PENDING' | 'IN_REVIEW' | 'APPROVED' | 'REJECTED' | 'CHANGES_REQUESTED';
 /**
  * Product review submitted by a customer.
  * Reviews publish immediately (no PENDING state). Merchants hide via the admin
@@ -990,8 +1013,13 @@ interface ProductVariant {
     } | null;
     /** Display position/order for sorting variants */
     position: number;
-    /** Variant status */
-    status?: string | null;
+    /**
+     * Variant publish state. Same lowercase pair as `ProductStatus`, and the
+     * backend validates it with the same `active` / `draft` enum on the create
+     * and update DTOs. Null when the merchant never set it, which the server
+     * treats as `active`.
+     */
+    status?: VariantStatus | null;
     createdAt: string;
     updatedAt: string;
     /** Per-sales-channel field overrides keyed by connectionId */
@@ -1441,7 +1469,7 @@ interface ProductQueryParams {
     page?: number;
     limit?: number;
     search?: string;
-    status?: 'active' | 'draft';
+    status?: ProductStatus;
     /** Filter by category IDs (comma-separated or array) */
     categories?: string | string[];
     /** Filter by brand IDs (comma-separated or array) */
@@ -1467,8 +1495,27 @@ interface ProductQueryParams {
      * ```
      */
     metafields?: Record<string, string | string[]>;
-    /** Sort by field (default: menuOrder) */
-    sortBy?: 'name' | 'price' | 'createdAt';
+    /**
+     * Sort field. **Which values actually take effect depends on the SDK mode.**
+     *
+     * - `storeId` (public storefront) and `apiKey` (admin) modes validate against
+     *   the full set: `name`, `price`, `createdAt`, `updatedAt`, `menuOrder`.
+     *   Anything outside it is rejected with a 400.
+     * - `salesChannelId` (vibe-coded) mode honours only `name`, `price` and
+     *   `createdAt`. It does **not** reject `updatedAt` or `menuOrder`; it
+     *   silently ignores them and returns the merchant's curated order instead,
+     *   so a sort that looks accepted may simply not have happened.
+     *
+     * Omit `sortBy` entirely and every mode returns the merchant's curated order
+     * (`menuOrder` ascending, then newest first). That is the right default for a
+     * storefront listing, because it is the order the merchant arranged in the
+     * dashboard.
+     *
+     * `price` sorts on the stored `basePrice` column. For VARIABLE products that
+     * can differ from the effective price a shopper sees, which is the minimum
+     * across variants.
+     */
+    sortBy?: 'name' | 'price' | 'createdAt' | 'updatedAt' | 'menuOrder';
     sortOrder?: 'asc' | 'desc';
     /** Locale for translated content (e.g., "he", "es"). Falls back to store default. */
     locale?: string;
@@ -1598,7 +1645,7 @@ interface CreateProductDto {
     basePrice: number;
     salePrice?: number;
     costPrice?: number;
-    status?: 'active' | 'draft';
+    status?: ProductStatus;
     type?: 'SIMPLE' | 'VARIABLE';
     isDownloadable?: boolean;
     /** Existing category IDs to assign. Unknown/cross-store IDs are rejected with 400. To assign by name (auto-creating if missing), use `categoryNames`. */
@@ -1732,7 +1779,7 @@ interface UpdateProductDto {
     basePrice?: number;
     salePrice?: number | null;
     costPrice?: number | null;
-    status?: 'active' | 'draft';
+    status?: ProductStatus;
     isDownloadable?: boolean;
     /** Existing category IDs to assign (replaces the current set). Pass `[]` to clear. Unknown/cross-store IDs are rejected with 400. To assign by name (auto-creating if missing), use `categoryNames`. */
     categories?: string[];
@@ -1886,10 +1933,21 @@ interface OrderStatusChange {
     note?: string | null;
 }
 /**
- * Order status values are **lowercase**.
- * Do NOT use uppercase values like 'COMPLETED' or 'CANCELLED'.
+ * The canonical order statuses. **The wire format is UPPERCASE.**
+ *
+ * These are the exact values the API returns on `Order.status` and the exact
+ * values it accepts when you set a status. Send `'CANCELLED'`, never
+ * `'cancelled'`.
+ *
+ * The server enforces a state machine on top of this list, so not every value
+ * is reachable from every other one. Terminal states (`CANCELLED`, `REFUNDED`)
+ * do not transition anywhere.
+ *
+ * **Breaking change in SDK 2.0.** Earlier releases declared a shorter,
+ * lowercase union that never matched the API. If you were comparing against
+ * `'pending'` or `'cancelled'`, uppercase those comparisons.
  */
-type OrderStatus = 'pending' | 'processing' | 'shipped' | 'delivered' | 'cancelled' | 'refunded';
+type OrderStatus = 'DRAFT' | 'PENDING' | 'PROCESSING' | 'ON_HOLD' | 'PAID' | 'SHIPPED' | 'DELIVERED' | 'COMPLETED' | 'FULFILLED' | 'CANCELLED' | 'REFUNDED' | 'PARTIALLY_REFUNDED';
 interface OrderCustomer {
     email: string;
     name?: string;
@@ -1991,6 +2049,11 @@ interface OrderDownloadLink {
 interface OrderQueryParams {
     page?: number;
     limit?: number;
+    /**
+     * Filter by canonical status, UPPERCASE. The server also accepts the id of a
+     * custom status label for stores using that feature, which this union does
+     * not model. Cast if you need to filter by a label id.
+     */
     status?: OrderStatus;
     sortBy?: 'createdAt' | 'totalAmount';
     sortOrder?: 'asc' | 'desc';
@@ -3039,6 +3102,19 @@ type GuestCheckoutStartResponse = {
     message: string;
 };
 type CheckoutStatus = 'PENDING' | 'SHIPPING_SET' | 'PAYMENT_PENDING' | 'PAYMENT_PROCESSING' | 'COMPLETED' | 'FAILED' | 'EXPIRED';
+/**
+ * How the order reaches the customer. **Lowercase**, unlike `CheckoutStatus`.
+ *
+ * `shipping` is the server default when a checkout is created. `pickup` means
+ * the customer collects from a store location, so the checkout carries a
+ * `pickupLocation` instead of a shipping address, and shipping rates are not
+ * quoted. Set it with `client.setDeliveryType(checkoutId, deliveryType)`.
+ *
+ * These two are the only values the API accepts. Checkout custom fields are
+ * also gated on this value, so a field scoped to pickup does not appear on a
+ * shipping checkout.
+ */
+type DeliveryType = 'shipping' | 'pickup';
 /**
  * Individual tax line item in the breakdown
  * @example
@@ -3188,6 +3264,13 @@ interface CheckoutLineItem {
         name: string;
         sku: string;
         images?: ProductImage[];
+        /**
+         * Whether this product is a digital/downloadable one. The server always
+         * sends it on checkout line items, so this is how you detect an
+         * all-digital cart: `items.every(i => i.product.isDownloadable)`. Use that
+         * to skip the shipping address step and the delivery-method picker.
+         */
+        isDownloadable?: boolean;
     };
     /**
      * Nested variant information (null for simple products).
@@ -3406,7 +3489,7 @@ interface Checkout {
     /** Customer ID if linked to a customer account */
     customerId?: string | null;
     /** Delivery method: "shipping" (default) or "pickup" */
-    deliveryType?: 'shipping' | 'pickup';
+    deliveryType?: DeliveryType;
     /** Pickup location details (when deliveryType is "pickup") */
     pickupLocation?: PickupLocation | null;
     /** Shipping address (required before selecting shipping) */
@@ -3901,7 +3984,19 @@ interface MediaAsset {
     alt: string | null;
     createdAt: string;
 }
-/** Query params for `listMedia`. */
+/**
+ * Query params for `listMedia`.
+ *
+ * These three are the complete set. The public `GET /api/v1/media` endpoint
+ * that this SDK calls reads only `page`, `limit` and `search`, and `search`
+ * matches on name and filename.
+ *
+ * ⛔ The dashboard's own media browser has a richer filter set (asset type,
+ * sort field, sort direction, in-use vs unused, folder scope), but that lives
+ * on a **different** internal route. Sending those names here does nothing:
+ * they are dropped without an error, and you get an unfiltered first page back
+ * that looks like a successful filter.
+ */
 interface ListMediaParams {
     page?: number;
     limit?: number;
@@ -3936,6 +4031,16 @@ interface Refund {
     currency: string;
     reason?: string;
     items?: RefundLineItemResponse[];
+    /**
+     * ⛔ **Deliberately left as `string`, because the casing is not consistent
+     * across the two methods that return this type.**
+     *
+     * `createRefund()` passes the stored payment-refund status straight through,
+     * so you get an UPPERCASE `PaymentRecordStatus` value such as `'PENDING'`.
+     * `getOrderRefunds()` lowercases it on the way out, so the same refund comes
+     * back as `'pending'`. Compare case-insensitively
+     * (`status.toUpperCase() === 'PENDING'`) rather than against a literal.
+     */
     status: string;
 }
 interface UpdateOrderShippingDto {
@@ -4389,6 +4494,20 @@ interface PaymentIntent {
     /** Runtime client SDK overrides (merged with provider manifest config) */
     clientSdk?: PaymentClientSdk;
 }
+/**
+ * The stored payment-record vocabulary. **UPPERCASE.**
+ *
+ * These are the values the platform writes to a payment record, a payment
+ * refund record, and a checkout's `paymentStatus` column. `CAPTURED` is the
+ * only state that means the money actually moved. `AUTHORIZED` is a hold, not
+ * a charge, and only a `CAPTURED` payment can be refunded.
+ *
+ * **This is not the same thing as the `PaymentStatus` interface below**, which
+ * is the live checkout-polling object and carries its own lowercase
+ * `pending | processing | succeeded | failed | canceled` field. It is also not
+ * what `Refund.status` returns: see the note on `Refund`.
+ */
+type PaymentRecordStatus = 'PENDING' | 'AUTHORIZED' | 'CAPTURED' | 'FAILED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'CANCELLED';
 /**
  * Payment status for a checkout.
  * Use this to poll for payment completion after redirect-based flows.
@@ -7853,85 +7972,56 @@ declare class BrainerceClient {
      */
     updateOrder(orderId: string, data: UpdateOrderDto): Promise<Order>;
     /**
-     * Update order status
+     * Update order status.
+     *
+     * **Not callable — use {@link updateOrder} instead.** Status changes do work
+     * over the API key, just by a different route.
+     *
+     * @deprecated Call `updateOrder(orderId, { status })`.
      *
      * @example
      * ```typescript
-     * const order = await client.updateOrderStatus('order_123', 'shipped');
+     * const order = await client.updateOrder('order_123', { status: 'SHIPPED' });
      * ```
      */
     updateOrderStatus(orderId: string, status: string): Promise<Order>;
     /**
-     * Update order payment method
-     * Note: Only WooCommerce supports syncing payment method changes back to platform
+     * Update order payment method.
      *
-     * @example
-     * ```typescript
-     * const order = await client.updatePaymentMethod('order_123', 'credit_card');
-     * ```
+     * **Not callable.** The API-key `/v1` surface has no payment-method route,
+     * so this throws in every mode. Change the payment method from the
+     * dashboard until the route ships.
      */
     updatePaymentMethod(orderId: string, paymentMethod: string): Promise<Order>;
     /**
-     * Update order notes
+     * Update order notes.
      *
-     * @example
-     * ```typescript
-     * const order = await client.updateOrderNotes('order_123', 'Customer requested gift wrapping');
-     * ```
+     * **Not callable.** The API-key `/v1` surface has no order-notes route, so
+     * this throws in every mode. Edit notes from the dashboard until the route
+     * ships.
      */
     updateOrderNotes(orderId: string, notes: string): Promise<Order>;
     /**
-     * Get refunds for an order
-     * Returns refunds from the source platform (Shopify/WooCommerce only)
+     * Get refunds for an order.
      *
-     * @example
-     * ```typescript
-     * const refunds = await client.getOrderRefunds('order_123');
-     * console.log('Total refunds:', refunds.length);
-     * ```
+     * **Not callable.** The API-key `/v1` surface has no refunds route, so this
+     * throws in every mode. Read refunds from the dashboard until the route
+     * ships.
      */
     getOrderRefunds(orderId: string): Promise<Refund[]>;
     /**
-     * Create a refund for an order
-     * Creates refund on the source platform (Shopify/WooCommerce only)
-     *
-     * @example
-     * ```typescript
-     * // Full refund
-     * const refund = await client.createRefund('order_123', {
-     *   type: 'full',
-     *   restockInventory: true,
-     *   notifyCustomer: true,
-     *   reason: 'Customer request',
-     * });
+     * Create a refund for an order.
      *
-     * // Partial refund
-     * const partialRefund = await client.createRefund('order_123', {
-     *   type: 'partial',
-     *   items: [
-     *     { lineItemId: 'item_456', quantity: 1 },
-     *   ],
-     *   restockInventory: true,
-     * });
-     * ```
+     * **Not callable.** The API-key `/v1` surface has no refunds route, so this
+     * throws in every mode. Refund from the dashboard until the route ships.
      */
     createRefund(orderId: string, data: CreateRefundDto): Promise<Refund>;
     /**
-     * Update order shipping address
-     * Syncs to source platform (Shopify/WooCommerce only)
+     * Update order shipping address.
      *
-     * @example
-     * ```typescript
-     * const order = await client.updateOrderShipping('order_123', {
-     *   firstName: 'John',
-     *   lastName: 'Doe',
-     *   line1: '456 New Address',
-     *   city: 'Los Angeles',
-     *   state: 'CA',
-     *   country: 'US',
-     *   postalCode: '90001',
-     * });
-     * ```
+     * **Not callable.** The API-key `/v1` surface has no order-shipping route,
+     * so this throws in every mode. Correct the address from the dashboard
+     * until the route ships.
      */
     updateOrderShipping(orderId: string, data: UpdateOrderShippingDto): Promise<Order>;
     /**
@@ -8039,14 +8129,12 @@ declare class BrainerceClient {
         }>;
     }>>;
     /**
-     * Cancel an order
-     * Works for Shopify and WooCommerce orders that haven't been fulfilled
+     * Cancel an order.
      *
-     * @example
-     * ```typescript
-     * const order = await client.cancelOrder('order_123');
-     * console.log('Order status:', order.status); // 'cancelled'
-     * ```
+     * **Not callable.** The API-key `/v1` surface has no cancel route, so this
+     * throws in every mode. A status move to cancelled may be reachable through
+     * {@link updateOrder} depending on what the order's state machine allows;
+     * otherwise cancel from the dashboard.
      */
     cancelOrder(orderId: string): Promise<Order>;
     /**
@@ -8061,89 +8149,51 @@ declare class BrainerceClient {
      * ship date is not rewritten, and no fulfilment event fires. That is the way
      * to fix a mistyped tracking number.
      *
-     * @example
-     * ```typescript
-     * // First fulfilment — emails the shopper by default.
-     * await client.fulfillOrder('order_123', {
-     *   trackingNumber: '1Z999AA10123456784',
-     *   trackingCompany: 'UPS',
-     *   trackingUrl: 'https://www.ups.com/track?tracknum=1Z999AA10123456784',
-     *   notifyCustomer: true,
-     * });
-     *
-     * // Correction — silent unless you opt back in.
-     * await client.fulfillOrder('order_123', {
-     *   trackingNumber: '1Z999AA10123456785',
-     * });
-     * ```
+     * **Not callable.** The API-key `/v1` surface has no fulfil route, so this
+     * throws in every mode. To ship an order over the API today, buy a label
+     * with {@link createShippingLabel} — the carrier's webhooks then move the
+     * shipment through in-transit and delivered on their own. Otherwise fulfil
+     * from the dashboard.
      */
     fulfillOrder(orderId: string, data?: FulfillOrderDto): Promise<Order>;
     /**
-     * Sync draft orders from connected platforms
+     * Sync draft orders from connected platforms.
      *
-     * @example
-     * ```typescript
-     * const result = await client.syncDraftOrders();
-     * console.log('Draft orders synced');
-     * ```
+     * **Not callable.** The API-key `/v1` surface has no draft-order routes at
+     * all, so this throws in every mode. {@link triggerSync} covers a general
+     * platform sync; draft orders are managed from the dashboard.
      */
     syncDraftOrders(): Promise<{
         message: string;
     }>;
     /**
-     * Complete a draft order (convert to regular order)
+     * Complete a draft order (convert to regular order).
      *
-     * @example
-     * ```typescript
-     * const order = await client.completeDraftOrder('draft_123', {
-     *   paymentPending: false,
-     * });
-     * ```
+     * **Not callable.** The API-key `/v1` surface has no draft-order routes at
+     * all, so this throws in every mode. Complete drafts from the dashboard.
      */
     completeDraftOrder(orderId: string, data?: CompleteDraftDto): Promise<Order>;
     /**
-     * Send invoice for a draft order
+     * Send invoice for a draft order.
      *
-     * @example
-     * ```typescript
-     * await client.sendDraftInvoice('draft_123', {
-     *   to: 'customer@example.com',
-     *   subject: 'Your Invoice',
-     *   customMessage: 'Thank you for your order!',
-     * });
-     * ```
+     * **Not callable.** The API-key `/v1` surface has no draft-order routes at
+     * all, so this throws in every mode. Send the invoice from the dashboard.
      */
     sendDraftInvoice(orderId: string, data?: SendInvoiceDto): Promise<{
         message: string;
     }>;
     /**
-     * Delete a draft order
+     * Delete a draft order.
      *
-     * @example
-     * ```typescript
-     * await client.deleteDraftOrder('draft_123');
-     * ```
+     * **Not callable.** The API-key `/v1` surface has no draft-order routes at
+     * all, so this throws in every mode. Delete drafts from the dashboard.
      */
     deleteDraftOrder(orderId: string): Promise<void>;
     /**
-     * Update a draft order
+     * Update a draft order.
      *
-     * @example
-     * ```typescript
-     * const order = await client.updateDraftOrder('draft_123', {
-     *   note: 'Updated customer note',
-     *   email: 'newemail@example.com',
-     *   shippingAddress: {
-     *     firstName: 'John',
-     *     lastName: 'Doe',
-     *     address1: '123 Main St',
-     *     city: 'New York',
-     *     province: 'NY',
-     *     country: 'US',
-     *     zip: '10001',
-     *   },
-     * });
-     * ```
+     * **Not callable.** The API-key `/v1` surface has no draft-order routes at
+     * all, so this throws in every mode. Edit drafts from the dashboard.
      */
     updateDraftOrder(orderId: string, data: UpdateDraftDto): Promise<Order>;
     /**
@@ -8152,7 +8202,14 @@ declare class BrainerceClient {
      */
     updateInventory(productId: string, data: UpdateInventoryDto): Promise<void>;
     /**
-     * Get current inventory for a product
+     * Get current inventory for a product.
+     *
+     * **Admin mode only** — the API key needs the `inventory:read` scope.
+     *
+     * This used to request `/api/v1/inventory/:productId`, which does not
+     * exist and 404'd silently. The live route is product-scoped:
+     * `GET /api/v1/products/:id/inventory`. A product with no inventory row
+     * reads back as all zeroes rather than 404ing.
      */
     getInventory(productId: string): Promise<{
         available: number;
@@ -8160,16 +8217,16 @@ declare class BrainerceClient {
         total: number;
     }>;
     /**
-     * Edit inventory manually with reason for audit trail
+     * Edit inventory manually with a reason for the audit trail.
      *
-     * @example
-     * ```typescript
-     * const inventory = await client.editInventory({
-     *   productId: 'prod_123',
-     *   newTotal: 100,
-     *   reason: 'Restocked from warehouse',
-     * });
-     * ```
+     * **Not callable.** The API-key `/v1` surface carries no `inventory`
+     * namespace, so this throws in every mode.
+     *
+     * {@link updateInventory} is the closest working call: it sets the same
+     * absolute stock level over `PUT /api/v1/products/:id/inventory`, but the
+     * reason is not yours to choose — the server records a generic
+     * "Updated via External API" against the audit trail. If the reason text
+     * matters, make the edit from the dashboard.
      */
     editInventory(data: EditInventoryDto): Promise<{
         total: number;
@@ -8177,41 +8234,29 @@ declare class BrainerceClient {
         available: number;
     }>;
     /**
-     * Get inventory sync status for all products in the store
+     * Get inventory sync status for all products in the store.
      *
-     * @example
-     * ```typescript
-     * const status = await client.getInventorySyncStatus();
-     * console.log(`${status.pending} products pending sync`);
-     * console.log(`Last sync: ${status.lastSyncAt}`);
-     * ```
+     * **Not callable.** The API-key `/v1` surface carries no `inventory`
+     * namespace, so this throws in every mode. Sync state is visible in the
+     * dashboard; {@link getSyncStatus} covers platform sync jobs.
      */
     getInventorySyncStatus(): Promise<InventorySyncStatus>;
     /**
-     * Get inventory for multiple products at once
+     * Get inventory for multiple products at once.
      *
-     * @example
-     * ```typescript
-     * const inventories = await client.getBulkInventory(['prod_123', 'prod_456', 'prod_789']);
-     * inventories.forEach(inv => {
-     *   console.log(`${inv.productId}: ${inv.available} available`);
-     * });
-     * ```
+     * **Not callable.** The API-key `/v1` surface carries no `inventory`
+     * namespace, so this throws in every mode. There is no bulk stock read on
+     * the API key today: fall back to {@link getInventory} per product, or read
+     * the stock that {@link getProducts} already returns on each product.
      */
     getBulkInventory(productIds: string[]): Promise<BulkInventoryResponse[]>;
     /**
-     * Reconcile inventory between Brainerce and connected platforms
-     * Detects and optionally fixes discrepancies
-     *
-     * @example
-     * ```typescript
-     * // Reconcile single product (dry run)
-     * const result = await client.reconcileInventory({ productId: 'prod_123' });
+     * Reconcile inventory between Brainerce and connected platforms.
+     * Detects and optionally fixes discrepancies.
      *
-     * // Reconcile all products with auto-fix
-     * const summary = await client.reconcileInventory({ autoFix: true });
-     * console.log(`Reconciled ${summary.reconciled} products`);
-     * ```
+     * **Not callable.** The API-key `/v1` surface carries no `inventory`
+     * namespace, so this throws in every mode, `autoFix` included. Reconcile
+     * from the dashboard.
      */
     reconcileInventory(options?: {
         productId?: string;
@@ -8221,6 +8266,10 @@ declare class BrainerceClient {
      * Check stock availability for one or more items before adding to cart or checkout
      * Use this to validate stock before operations that might fail due to insufficient inventory
      *
+     * **Vibe-coded or storefront mode only.** There is no stock-check route on
+     * the API-key `/v1` surface; in admin mode this throws. The same applies to
+     * {@link checkCartStock}, which routes through here.
+     *
      * @example
      * ```typescript
      * // Check if items are available before adding to cart
@@ -8485,20 +8534,32 @@ declare class BrainerceClient {
      * Request a password reset email for a customer
      * Works in vibe-coded, storefront, and admin mode
      *
-     * The `resetUrl` MUST be supplied explicitly in non-browser (SSR / Node)
-     * contexts — auto-deriving it from `window.location.origin` is impossible
-     * there and historically resulted in `undefined` being sent to the backend,
-     * which then bounced the email to a broken link. In browser contexts the
-     * origin is still used as a fallback but the SDK logs a one-time warning
-     * recommending an explicit value so server-rendered + proxied dashboards
-     * don't silently rely on the wrong host.
+     * The reset link's host is chosen by the server, not by the caller: it is
+     * derived from the sales channel's own domain, falling back to the backend's
+     * configured frontend URL, and the request is rejected if neither resolves.
+     *
+     * The SDK used to send a `resetUrl` in the request body. The backend
+     * deliberately removed that field: any caller could submit an arbitrary URL
+     * and have it emailed, from a Brainerce-domained sender, to the address
+     * holder — a phishing-link injection. `ForgotPasswordDto` now declares
+     * `email` and nothing else, and the API's global validation pipe runs with
+     * `whitelist` + `forbidNonWhitelisted`, so a body carrying `resetUrl` fails
+     * the whole call with `400 property resetUrl should not exist`. Only `email`
+     * is sent.
+     *
+     * The endpoint always answers 200 so it cannot be used to enumerate
+     * accounts; the mail is only sent when a matching customer exists.
      *
      * @param email - Customer email address
-     * @param options - Optional settings
-     * @param options.resetUrl - Reset URL the email links should point to.
-     *   Required outside the browser; recommended inside it.
+     * @param options - Accepted for source compatibility only. Ignored.
      */
     forgotPassword(email: string, options?: {
+        /**
+         * @deprecated Ignored, and never sent. The server derives the reset URL
+         *   itself (sales-channel domain, then the configured frontend URL) and
+         *   rejects the field outright, so passing it has no effect. To change
+         *   where reset links point, set the sales channel's domain.
+         */
         resetUrl?: string;
     }): Promise<{
         message: string;
@@ -12232,7 +12293,7 @@ declare class BrainerceError extends Error {
     constructor(message: string, statusCode: number, details?: unknown);
 }
 
-declare const SDK_VERSION = "1.60.0";
+declare const SDK_VERSION = "2.0.0";
 
 /**
  * Verify a webhook signature from Brainerce
@@ -12733,4 +12794,4 @@ interface CategorySitemapOptions {
  */
 declare function getCategorySitemapEntries(client: BrainerceClient, opts: CategorySitemapOptions): Promise<SitemapEntry[]>;
 
-export { type AddToCartDto, type AddressDetailsResult, type AddressSuggestion, type AnnouncementContent, type AnnouncementSeverity, type AppliedDiscount, type ApplyCouponDto, type AttachModifierGroupInput, type Attribute, type AttributeOption, type AttributeSource, type AvailabilityClock, type BlogPost, type BlogPostListParams, type BlogPostListResponse, type BlogSitemapOptions, type BrainerceApiError, BrainerceClient, type BrainerceClientOptions, BrainerceError, type Brand, type BulkCreateProductsDto, type BulkCreateProductsError, type BulkCreateProductsJob, type BulkCreateProductsStatus, type BulkInventoryResponse, type BulkSaveVariantsDto, type BulkSaveVariantsResponse, type BulkVariantInput, type BusinessHoursWindow, type Cart, type CartAppliedDiscount, type CartBundleOffer, type CartBundlesResponse, type CartIncludeOption, type CartIncludeOptions, type CartItem, type CartItemModifierLine, type CartNudge, type CartRecommendationsResponse, type CartStatus, type CartUpgradeSuggestion, type CartUpgradesResponse, type CartWithIncludes, type Category, type CategoryDetail, type CategoryNode, type CategorySitemapOptions, type CategorySuggestion, type Checkout, type CheckoutAddress, type CheckoutBumpsResponse, type CheckoutCustomFieldDefinition, type CheckoutFieldPricing, type CheckoutFieldVisibility, type CheckoutLineItem, type CheckoutPrefillData, type CheckoutStatus, type CompleteCheckoutResponse, type CompleteDraftDto, type ConfigureOAuthProviderDto as ConfigureOAuthProviderInput, type ConflictStatus, type ConnectorPlatform, type ContactFormFieldType, type ContactFormFieldValidation, type ContactFormPublic, type ContactFormPublicField, type ContactFormSummary, type Content, type ContentDataMap, type ContentStatus, type ContentSummary, type ContentType, type Coupon, type CouponCreateResponse, type CouponQueryParams, type CouponStatus, type CouponType, type CouponValidationWarning, type CreateAddressDto, type CreateAttributeDto as CreateAttributeInput, type CreateAttributeOptionDto as CreateAttributeOptionInput, type CreateBrandDto as CreateBrandInput, type CreateCategoryDto as CreateCategoryInput, type CreateCheckoutDto, type CreateContentInput, type CreateCouponDto, type CreateCustomApiDto, type CreateCustomerDto, type CreateEmailTemplateDto as CreateEmailTemplateInput, type CreateGuestOrderDto, type CreateInquiryInput, type CreateInquiryResponse, type CreateMetafieldDefinitionDto as CreateMetafieldDefinitionInput, type CreateModifierGroupInput, type CreateModifierInput, type CreateOrderDto, type CreateProductDto, type CreateRefundDto, type CreateShippingRateDto as CreateShippingRateInput, type CreateShippingZoneDto as CreateShippingZoneInput, type CreateTagDto as CreateTagInput, type CreateTaxRateDto as CreateTaxRateInput, type CreateVariantDto, type CustomApiAuthType, type CustomApiConnectionStatus, type CustomApiCredentials, type CustomApiIntegration, type CustomApiSyncConfig, type CustomApiSyncDirection, type CustomApiTestResult, type Customer, type CustomerAddress, type CustomerAuthResponse, type CustomerOAuthProvider, type CustomerProfile, type CustomerQueryParams, type DateAvailabilityConstraints, type DateAvailabilitySurface, type DateFieldParseResult, type DeleteProductResponse, type DiscountBanner, type DiscountRuleType, type DownloadFile, type DraftLineItem, type EditInventoryDto, type EmailDomain, type EmailEventSettings, type EmailEventType, type EmailSettings, type EmailTemplate, type EmailTemplatePreview, type EmailTemplatesResponse, type EmailVerificationResponse, type ExtendReservationResponse, type FaqContent, type FaqItem, type FooterColumn, type FooterContent, type FooterLink, type FooterSocialLink, type FormatPriceOptions, type FormatProductPriceOptions, type FreeAllocationPolicy, type FulfillOrderDto, type GuestCheckoutStartResponse, type GuestOrderResponse, type HeaderContent, type HeaderCta, type HeaderLogo, type HeaderNavItem, type InsufficientStockError, type InventoryInfo, type InventoryReservationStrategy, type InventorySyncStatus, type InventoryTrackingMode, type InvitationStatus, type InviteMemberDto as InviteMemberInput, type InviteStoreMemberDto as InviteStoreMemberInput, type JsonLdOptions, type ListModifierGroupsParams, type LocalCart, type LocalCartItem, type LockedVariant, type LoyaltyNextTierSummary, type LoyaltyReward, type LoyaltyStatus, type LoyaltyTierSummary, type MergeCartsDto, type MetafieldConflict, type MetafieldConflictResolution, type MetafieldDefinition, type MetafieldFilter, type MetafieldFilterValue, type MetafieldFiltersResponse, type MetafieldType, type Modifier, type ModifierGroup, type ModifierSelection, type ModifierSelectionType, type ModifierValidationCode, type ModifierValidationError, type ModifierValidationFailedError, type MyProductReview, type OAuthAuthorizeResponse, type OAuthCallbackResponse, type OAuthConnection, type OAuthConnectionsResponse, type OAuthProviderConfig, type OAuthProviderType, type OAuthProvidersResponse, type Order, type OrderAddress, type OrderBump, type OrderCustomer, type OrderDownloadLink, type OrderItem, type OrderQueryParams, type OrderStatus, type OrderStatusChange, type PageContent, type PageSeo, type PaginatedResponse, type ParsedDateFieldValue, type PaymentClientSdk, type PaymentConfig, type PaymentIntent, type PaymentProvider, type PaymentProviderConfig, type PaymentProvidersConfig, type PaymentStatus, type PaymentUrlOptions, type PickupLocation, type PlatformCouponCapabilities, type PlatformMetafieldMetadata, type PreviewEmailTemplateDto as PreviewEmailTemplateInput, type PriceDriftError, type Product, type ProductAttributeInput, type ProductAvailability, type ProductCustomizationField, type ProductDiscount, type ProductDiscountBadge, type ProductImage, type ProductMetafield, type ProductMetafieldValue, type ProductModifierGroupAttachment, type ProductQueryParams, type ProductRecommendation, type ProductRecommendationsResponse, type ProductRelationType, type ProductReview, type ProductReviewAdmin, type ProductSitemapOptions, type ProductSuggestion, type ProductUnavailableError, type ProductVariant, type PublicMetafieldDefinition, type PublishProductResponse, RTL_LOCALES, type RecommendationVariant, type ReconcileInventoryResponse, type RedeemRewardResult, type ReferralInfo, type Refund, type RefundLineItem, type RefundLineItemResponse, type RefundType, type RegisterCustomerDto, type RelativeDateBounds, type ReservationInfo, type ResolveMetafieldConflictDto as ResolveMetafieldConflictInput, type ResolveSyncConflictDto as ResolveSyncConflictInput, type RichTextContent, SDK_VERSION, type SearchSuggestions, type SelectPickupLocationDto, type SelectShippingMethodDto, type SendInvoiceDto, type SessionCartRef, type SetBillingAddressDto, type SetCheckoutCustomFieldsDto, type SetCheckoutCustomerDto, type SetDefinitionProductsDto as SetDefinitionProductsInput, type SetMetafieldPlatformsDto as SetMetafieldPlatformsInput, type SetShippingAddressDto, type SetShippingAddressResponse, type ShippingDestinations, type ShippingLine, type ShippingRate, type ShippingRateConfig, type ShippingRateType, type ShippingSummaryEntry, type ShippingZone, type ShippingZoneQueryParams, type SitemapEntry, type StockAvailabilityRequest, type StockAvailabilityResponse, type StockAvailabilityResult, type StoreInfo, type StoreInvitation, type StoreInvitationDetails, type StoreMember, type StorePermission, type StoreRole, type StoreTeamResponse, type StoreTracking, type SubmitProductReviewInput, type SupportedLocaleObject, type SyncConflict, type SyncConflictResolution, type SyncJob, type Tag, type TaxBreakdown, type TaxBreakdownItem, type TaxRate, type TaxonomyQueryParams, type TeamInvitation, type TeamInvitationsResponse, type TeamMember, type TeamMembersResponse, type TeamRole, type TrackingEventItem, type TrackingEventName, type TrackingEventPayload, type UpdateAddressDto, type UpdateAttachmentInput, type UpdateAttributeDto as UpdateAttributeInput, type UpdateAttributeOptionDto as UpdateAttributeOptionInput, type UpdateBrandDto as UpdateBrandInput, type UpdateCartItemDto, type UpdateCategoryDto as UpdateCategoryInput, type UpdateContentInput, type UpdateCouponDto, type UpdateCustomApiDto, type UpdateCustomerDto, type UpdateDraftDto, type UpdateEmailSettingsDto as UpdateEmailSettingsInput, type UpdateEmailTemplateDto as UpdateEmailTemplateInput, type UpdateInventoryDto, type UpdateMemberRoleDto as UpdateMemberRoleInput, type UpdateMetafieldDefinitionDto as UpdateMetafieldDefinitionInput, type UpdateModifierGroupInput, type UpdateModifierInput, type UpdateOAuthProviderDto as UpdateOAuthProviderInput, type UpdateOrderDto, type UpdateOrderShippingDto, type UpdateProductDto, type UpdateShippingRateDto as UpdateShippingRateInput, type UpdateShippingZoneDto as UpdateShippingZoneInput, type UpdateStoreMemberDto as UpdateStoreMemberInput, type UpdateTagDto as UpdateTagInput, type UpdateTaxRateDto as UpdateTaxRateInput, type UpdateVariantDto, type UpdateVariantInventoryDto, type UpsertProductMetafieldDto as UpsertProductMetafieldInput, type UserStore, type UserStorePermissions, type VariantInventoryResponse, type VariantPlatformOverlay, type VariantStatus, type WaitForOrderOptions, type WaitForOrderResult, type WebhookEvent, type WebhookEventType, type WriteProductReviewInput, buildArticleJsonLd, buildBreadcrumbJsonLd, buildCollectionPageJsonLd, buildOrganizationJsonLd, buildProductFaqJsonLd, buildProductJsonLd, buildWebsiteJsonLd, computeAvailableSlots, createWebhookHandler, deriveSeoDescription, enableDevGuards, formatMoney, formatPrice, formatProductPrice, formatVariantPrice, getBlogSitemapEntries, getBusinessHoursForDate, getCartItemImage, getCartItemName, getCartTotals, getCategorySitemapEntries, getDescriptionContent, getDirectionForLocale, formatPrice as getPriceDisplay, getProductCustomizationFields, getProductMetafield, getProductMetafieldValue, getProductMetafieldsByType, getProductPrice, getProductPriceInfo, getProductSitemapEntries, getProductSwatches, getStockStatus, getVariantOptions, getVariantPrice, isAllowedPaymentUrl, isCalendarDateAllowed, isCouponApplicableToProduct, isDateValueAllowed, isHtmlDescription, isWebhookEventType, jsonLdScriptProps, parseDateFieldValue, parseWebhookEvent, resolveRelativeBounds, resolveStoreLocalParts, safePaymentRedirect, stripHtml, validateDateAvailabilityConfig, verifyWebhook };
+export { type AddToCartDto, type AddressDetailsResult, type AddressSuggestion, type AnnouncementContent, type AnnouncementSeverity, type AppliedDiscount, type ApplyCouponDto, type AttachModifierGroupInput, type Attribute, type AttributeOption, type AttributeSource, type AvailabilityClock, type BlogPost, type BlogPostListParams, type BlogPostListResponse, type BlogSitemapOptions, type BrainerceApiError, BrainerceClient, type BrainerceClientOptions, BrainerceError, type Brand, type BulkCreateProductsDto, type BulkCreateProductsError, type BulkCreateProductsJob, type BulkCreateProductsStatus, type BulkInventoryResponse, type BulkSaveVariantsDto, type BulkSaveVariantsResponse, type BulkVariantInput, type BusinessHoursWindow, type Cart, type CartAppliedDiscount, type CartBundleOffer, type CartBundlesResponse, type CartIncludeOption, type CartIncludeOptions, type CartItem, type CartItemModifierLine, type CartNudge, type CartRecommendationsResponse, type CartStatus, type CartUpgradeSuggestion, type CartUpgradesResponse, type CartWithIncludes, type Category, type CategoryDetail, type CategoryNode, type CategorySitemapOptions, type CategorySuggestion, type Checkout, type CheckoutAddress, type CheckoutBumpsResponse, type CheckoutCustomFieldDefinition, type CheckoutFieldPricing, type CheckoutFieldVisibility, type CheckoutLineItem, type CheckoutPrefillData, type CheckoutStatus, type CompleteCheckoutResponse, type CompleteDraftDto, type ConfigureOAuthProviderDto as ConfigureOAuthProviderInput, type ConflictStatus, type ConnectorPlatform, type ContactFormFieldType, type ContactFormFieldValidation, type ContactFormPublic, type ContactFormPublicField, type ContactFormSummary, type Content, type ContentDataMap, type ContentStatus, type ContentSummary, type ContentType, type Coupon, type CouponCreateResponse, type CouponQueryParams, type CouponStatus, type CouponType, type CouponValidationWarning, type CreateAddressDto, type CreateAttributeDto as CreateAttributeInput, type CreateAttributeOptionDto as CreateAttributeOptionInput, type CreateBrandDto as CreateBrandInput, type CreateCategoryDto as CreateCategoryInput, type CreateCheckoutDto, type CreateContentInput, type CreateCouponDto, type CreateCustomApiDto, type CreateCustomerDto, type CreateEmailTemplateDto as CreateEmailTemplateInput, type CreateGuestOrderDto, type CreateInquiryInput, type CreateInquiryResponse, type CreateMetafieldDefinitionDto as CreateMetafieldDefinitionInput, type CreateModifierGroupInput, type CreateModifierInput, type CreateOrderDto, type CreateProductDto, type CreateRefundDto, type CreateShippingRateDto as CreateShippingRateInput, type CreateShippingZoneDto as CreateShippingZoneInput, type CreateTagDto as CreateTagInput, type CreateTaxRateDto as CreateTaxRateInput, type CreateVariantDto, type CustomApiAuthType, type CustomApiConnectionStatus, type CustomApiCredentials, type CustomApiIntegration, type CustomApiSyncConfig, type CustomApiSyncDirection, type CustomApiTestResult, type Customer, type CustomerAddress, type CustomerAuthResponse, type CustomerOAuthProvider, type CustomerProfile, type CustomerQueryParams, type DateAvailabilityConstraints, type DateAvailabilitySurface, type DateFieldParseResult, type DeleteProductResponse, type DeliveryType, type DiscountBanner, type DiscountRuleType, type DownloadFile, type DraftLineItem, type EditInventoryDto, type EmailDomain, type EmailEventSettings, type EmailEventType, type EmailSettings, type EmailTemplate, type EmailTemplatePreview, type EmailTemplatesResponse, type EmailVerificationResponse, type ExtendReservationResponse, type FaqContent, type FaqItem, type FooterColumn, type FooterContent, type FooterLink, type FooterSocialLink, type FormatPriceOptions, type FormatProductPriceOptions, type FreeAllocationPolicy, type FulfillOrderDto, type GuestCheckoutStartResponse, type GuestOrderResponse, type HeaderContent, type HeaderCta, type HeaderLogo, type HeaderNavItem, type InsufficientStockError, type InventoryInfo, type InventoryReservationStrategy, type InventorySyncStatus, type InventoryTrackingMode, type InvitationStatus, type InviteMemberDto as InviteMemberInput, type InviteStoreMemberDto as InviteStoreMemberInput, type JsonLdOptions, type ListModifierGroupsParams, type LocalCart, type LocalCartItem, type LockedVariant, type LoyaltyNextTierSummary, type LoyaltyReward, type LoyaltyStatus, type LoyaltyTierSummary, type MergeCartsDto, type MetafieldConflict, type MetafieldConflictResolution, type MetafieldDefinition, type MetafieldFilter, type MetafieldFilterValue, type MetafieldFiltersResponse, type MetafieldType, type Modifier, type ModifierGroup, type ModifierSelection, type ModifierSelectionType, type ModifierValidationCode, type ModifierValidationError, type ModifierValidationFailedError, type MyProductReview, type OAuthAuthorizeResponse, type OAuthCallbackResponse, type OAuthConnection, type OAuthConnectionsResponse, type OAuthProviderConfig, type OAuthProviderType, type OAuthProvidersResponse, type Order, type OrderAddress, type OrderBump, type OrderCustomer, type OrderDownloadLink, type OrderItem, type OrderQueryParams, type OrderStatus, type OrderStatusChange, type PageContent, type PageSeo, type PaginatedResponse, type ParsedDateFieldValue, type PaymentClientSdk, type PaymentConfig, type PaymentIntent, type PaymentProvider, type PaymentProviderConfig, type PaymentProvidersConfig, type PaymentRecordStatus, type PaymentStatus, type PaymentUrlOptions, type PickupLocation, type PlatformCouponCapabilities, type PlatformMetafieldMetadata, type PreviewEmailTemplateDto as PreviewEmailTemplateInput, type PriceDriftError, type Product, type ProductAttributeInput, type ProductAvailability, type ProductCustomizationField, type ProductDiscount, type ProductDiscountBadge, type ProductImage, type ProductMetafield, type ProductMetafieldValue, type ProductModifierGroupAttachment, type ProductQueryParams, type ProductRecommendation, type ProductRecommendationsResponse, type ProductRelationType, type ProductReview, type ProductReviewAdmin, type ProductSitemapOptions, type ProductStatus, type ProductSuggestion, type ProductUnavailableError, type ProductVariant, type PublicMetafieldDefinition, type PublishProductResponse, RTL_LOCALES, type RecommendationVariant, type ReconcileInventoryResponse, type RedeemRewardResult, type ReferralInfo, type Refund, type RefundLineItem, type RefundLineItemResponse, type RefundType, type RegisterCustomerDto, type RelativeDateBounds, type ReservationInfo, type ResolveMetafieldConflictDto as ResolveMetafieldConflictInput, type ResolveSyncConflictDto as ResolveSyncConflictInput, type ReviewStatus, type RichTextContent, SDK_VERSION, type SearchSuggestions, type SelectPickupLocationDto, type SelectShippingMethodDto, type SendInvoiceDto, type SessionCartRef, type SetBillingAddressDto, type SetCheckoutCustomFieldsDto, type SetCheckoutCustomerDto, type SetDefinitionProductsDto as SetDefinitionProductsInput, type SetMetafieldPlatformsDto as SetMetafieldPlatformsInput, type SetShippingAddressDto, type SetShippingAddressResponse, type ShippingDestinations, type ShippingLine, type ShippingRate, type ShippingRateConfig, type ShippingRateType, type ShippingSummaryEntry, type ShippingZone, type ShippingZoneQueryParams, type SitemapEntry, type StockAvailabilityRequest, type StockAvailabilityResponse, type StockAvailabilityResult, type StoreInfo, type StoreInvitation, type StoreInvitationDetails, type StoreMember, type StorePermission, type StoreRole, type StoreTeamResponse, type StoreTracking, type SubmitProductReviewInput, type SupportedLocaleObject, type SyncConflict, type SyncConflictResolution, type SyncJob, type Tag, type TaxBreakdown, type TaxBreakdownItem, type TaxRate, type TaxonomyQueryParams, type TeamInvitation, type TeamInvitationsResponse, type TeamMember, type TeamMembersResponse, type TeamRole, type TrackingEventItem, type TrackingEventName, type TrackingEventPayload, type UpdateAddressDto, type UpdateAttachmentInput, type UpdateAttributeDto as UpdateAttributeInput, type UpdateAttributeOptionDto as UpdateAttributeOptionInput, type UpdateBrandDto as UpdateBrandInput, type UpdateCartItemDto, type UpdateCategoryDto as UpdateCategoryInput, type UpdateContentInput, type UpdateCouponDto, type UpdateCustomApiDto, type UpdateCustomerDto, type UpdateDraftDto, type UpdateEmailSettingsDto as UpdateEmailSettingsInput, type UpdateEmailTemplateDto as UpdateEmailTemplateInput, type UpdateInventoryDto, type UpdateMemberRoleDto as UpdateMemberRoleInput, type UpdateMetafieldDefinitionDto as UpdateMetafieldDefinitionInput, type UpdateModifierGroupInput, type UpdateModifierInput, type UpdateOAuthProviderDto as UpdateOAuthProviderInput, type UpdateOrderDto, type UpdateOrderShippingDto, type UpdateProductDto, type UpdateShippingRateDto as UpdateShippingRateInput, type UpdateShippingZoneDto as UpdateShippingZoneInput, type UpdateStoreMemberDto as UpdateStoreMemberInput, type UpdateTagDto as UpdateTagInput, type UpdateTaxRateDto as UpdateTaxRateInput, type UpdateVariantDto, type UpdateVariantInventoryDto, type UpsertProductMetafieldDto as UpsertProductMetafieldInput, type UserStore, type UserStorePermissions, type VariantInventoryResponse, type VariantPlatformOverlay, type VariantStatus, type WaitForOrderOptions, type WaitForOrderResult, type WebhookEvent, type WebhookEventType, type WriteProductReviewInput, buildArticleJsonLd, buildBreadcrumbJsonLd, buildCollectionPageJsonLd, buildOrganizationJsonLd, buildProductFaqJsonLd, buildProductJsonLd, buildWebsiteJsonLd, computeAvailableSlots, createWebhookHandler, deriveSeoDescription, enableDevGuards, formatMoney, formatPrice, formatProductPrice, formatVariantPrice, getBlogSitemapEntries, getBusinessHoursForDate, getCartItemImage, getCartItemName, getCartTotals, getCategorySitemapEntries, getDescriptionContent, getDirectionForLocale, formatPrice as getPriceDisplay, getProductCustomizationFields, getProductMetafield, getProductMetafieldValue, getProductMetafieldsByType, getProductPrice, getProductPriceInfo, getProductSitemapEntries, getProductSwatches, getStockStatus, getVariantOptions, getVariantPrice, isAllowedPaymentUrl, isCalendarDateAllowed, isCouponApplicableToProduct, isDateValueAllowed, isHtmlDescription, isWebhookEventType, jsonLdScriptProps, parseDateFieldValue, parseWebhookEvent, resolveRelativeBounds, resolveStoreLocalParts, safePaymentRedirect, stripHtml, validateDateAvailabilityConfig, verifyWebhook };