brainerce 2.4.0 → 2.5.0

package/dist/index.d.ts

@@ -776,6 +776,52 @@ interface ProductMetafield {
  * platform. Archiving exists for modifier groups and modifiers, not products.
  */
 type ProductStatus = 'active' | 'draft';
+/** One product inside a KIT, as the storefront sees it. Display only. */
+interface KitComponentSummary {
+    productId: string;
+    /** Set when the kit pins one variant of a variable component. */
+    variantId: string | null;
+    /** Component name, variant included when one is pinned. */
+    name: string;
+    sku: string | null;
+    /** Units of this component in ONE kit. A box with two glasses reads `2`. */
+    quantity: number;
+    /** Thumbnail: the pinned variant's image, else the product's first. */
+    image: string | null;
+}
+/** A kit's contents and derived pricing, from `getKitComponents`. */
+interface KitDetail {
+    components: Array<KitComponentSummary & {
+        id: string;
+        position: number;
+        /** Effective unit price of the component. String decimal. */
+        unitPrice: string;
+        /** `null` = not stock-tracked, and never limits the kit. */
+        available: number | null;
+    }>;
+    /** How the kit is priced. */
+    pricingMode: 'FIXED' | 'SUM' | 'SUM_MINUS_PERCENT';
+    /** Percent off the component sum. Only for `SUM_MINUS_PERCENT`. */
+    discountValue: number | null;
+    /** Resolved kit price. String decimal. */
+    price: string;
+    /**
+     * How `price` divides across the components, in order, in MINOR units.
+     * Sums exactly to `price`. This is the taxable amount per component and the
+     * credit amount per component on a refund.
+     */
+    allocationMinor: number[];
+    /** Sellable kits. `null` = unlimited; `0` = not sellable. */
+    available: number | null;
+}
+/** One component slot to write with `setKitComponents`. */
+interface KitComponentWriteInput {
+    componentProductId: string;
+    /** Required when the component product is VARIABLE. */
+    componentVariantId?: string | null;
+    /** Units of this component in ONE kit. */
+    quantity: number;
+}
 interface Product {
     id: string;
     name: string;
@@ -866,12 +912,46 @@ interface Product {
     /** Product status (active, draft). Always returned by backend. */
     status: ProductStatus;
     /**
-     * Catalog structure. `KIT` is a sellable kit ("maaraz") whose price and
-     * availability derive from its component products — it carries no inventory
-     * row of its own, and outside FIXED pricing its `basePrice` is a placeholder.
-     * Treat it as not-directly-purchasable unless you resolve its components.
+     * Catalog structure. `KIT` is a sellable kit ("maaraz") assembled from other
+     * catalog products. It IS directly purchasable: add the KIT'S OWN `productId`
+     * as ONE cart line, with no `variantId` (a kit has no variants and passing
+     * one is rejected) and no modifier `selections`. NEVER add its components as
+     * separate lines — that charges twice and reserves twice. It carries no
+     * inventory row of its own (read `kitAvailable`), and outside FIXED pricing
+     * its stored `basePrice` is a placeholder, though storefront reads overlay it
+     * with the resolved price.
      */
     type: 'SIMPLE' | 'VARIABLE' | 'KIT';
+    /**
+     * What a KIT contains, returned on the single-product (by slug) read only.
+     * Absent on every other product type and on list responses.
+     *
+     * Render it: a shopper looking at a gift box needs to see what is inside
+     * before buying. These are display rows, NOT separate line items — the kit is
+     * added to the cart as ONE line, and its components are reserved behind the
+     * scenes. Do not add them individually.
+     */
+    kitComponents?: KitComponentSummary[];
+    /**
+     * How many of this KIT can be sold: the component that runs out first decides.
+     * `null` means unlimited (every component untracked). `0` means not sellable,
+     * including a kit with no components. Absent on non-kits — a kit has no
+     * `inventory` block, so this is the field to read for stock.
+     */
+    kitAvailable?: number | null;
+    /**
+     * How this KIT is priced, and therefore whether its prices are real numbers
+     * or placeholders. Absent on non-kits.
+     *
+     * `FIXED` — `basePrice` and `salePrice` are the merchant's own values and
+     * behave exactly like any other product's, sale logic included.
+     * `SUM` / `SUM_MINUS_PERCENT` — the price is recomputed from the components on
+     * every read, so the storefront read overlays `basePrice` with the resolved
+     * figure and returns `salePrice: null`. Never cache a kit price or recompute
+     * one client-side in these modes, and do not present a "was" price: there
+     * isn't one.
+     */
+    kitPricingMode?: 'FIXED' | 'SUM' | 'SUM_MINUS_PERCENT';
     /** Whether product is downloadable/digital. */
     isDownloadable?: boolean;
     /** Download files available for this product (when isDownloadable is true) */
@@ -1806,6 +1886,15 @@ interface CreateProductDto {
      * its contents set before it can be sold.
      */
     type?: 'SIMPLE' | 'VARIABLE' | 'KIT';
+    /**
+     * How a `KIT` is priced. `FIXED` (default) — you set `basePrice` and it stays.
+     * `SUM` — the kit costs what its components cost, recomputed on every read.
+     * `SUM_MINUS_PERCENT` — that sum less `kitDiscountValue` percent.
+     * Ignored on `SIMPLE` and `VARIABLE`.
+     */
+    kitPricingMode?: 'FIXED' | 'SUM' | 'SUM_MINUS_PERCENT';
+    /** Percent off the component sum, 0-100. Only for `SUM_MINUS_PERCENT`. */
+    kitDiscountValue?: number;
     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`. */
     categories?: string[];
@@ -1927,6 +2016,15 @@ interface BulkCreateProductsError {
     message: string;
 }
 interface UpdateProductDto {
+    /**
+     * How a `KIT` is priced. `FIXED` (default) — you set `basePrice` and it stays.
+     * `SUM` — the kit costs what its components cost, recomputed on every read.
+     * `SUM_MINUS_PERCENT` — that sum less `kitDiscountValue` percent.
+     * Omit to leave the kit's current mode unchanged.
+     */
+    kitPricingMode?: 'FIXED' | 'SUM' | 'SUM_MINUS_PERCENT';
+    /** Percent off the component sum, 0-100. Only for `SUM_MINUS_PERCENT`. */
+    kitDiscountValue?: number;
     name?: string;
     slug?: string;
     sku?: string;
@@ -8591,6 +8689,52 @@ declare class BrainerceClient {
      * console.log('Product type:', product.type); // 'VARIABLE'
      * ```
      */
+    /**
+     * Read a kit's contents, with its resolved price and how many can be sold.
+     *
+     * A KIT is one purchasable product assembled from other catalog products. It
+     * holds no inventory of its own: `available` is whichever component runs out
+     * first. Outside `FIXED` pricing the product row's `basePrice` is a
+     * placeholder, so use the `price` returned here.
+     *
+     * Safe to call for any product — a non-KIT returns an empty, unsellable
+     * shape rather than throwing, so callers need not branch on product type.
+     *
+     * @example
+     * ```typescript
+     * const kit = await client.getKitComponents('prod_123');
+     * console.log(kit.price, kit.available, kit.components.length);
+     * ```
+     */
+    getKitComponents(productId: string): Promise<KitDetail>;
+    /**
+     * Replace a kit's contents, and optionally how it is priced.
+     *
+     * A full replace, not a patch: send the list you want the kit to end up with.
+     * Omit `pricingMode` to leave the kit's current mode untouched.
+     *
+     * Rejected: a product that is not a KIT, a component from another store, a
+     * component that is itself a KIT, a VARIABLE component with no variant
+     * pinned, a variant that does not belong to its product, and the same slot
+     * listed twice.
+     *
+     * @example
+     * ```typescript
+     * await client.setKitComponents('prod_123', {
+     *   components: [
+     *     { componentProductId: 'prod_bottle', quantity: 1 },
+     *     { componentProductId: 'prod_glass', quantity: 2 },
+     *   ],
+     *   pricingMode: 'SUM_MINUS_PERCENT',
+     *   discountValue: 10,
+     * });
+     * ```
+     */
+    setKitComponents(productId: string, body: {
+        components: KitComponentWriteInput[];
+        pricingMode?: 'FIXED' | 'SUM' | 'SUM_MINUS_PERCENT';
+        discountValue?: number;
+    }): Promise<KitDetail>;
     convertToVariable(productId: string): Promise<Product>;
     /**
      * Convert a VARIABLE product back to SIMPLE.
@@ -9801,10 +9945,20 @@ declare class BrainerceClient {
      * Rich Text, and Page.
      *
      * Works in all three SDK modes (vibe-coded, storefront, admin):
-     *   - **Public reads** (`get`, `list`, `getBySlug`): work in any mode.
-     *   - **Write operations** (`create`, `update`, `publish`, `unpublish`,
-     *     `remove`): admin mode only — they call `/api/content/...` with
-     *     the API key. Calling from storefront / vibe-coded mode throws.
+     *   - **Public reads** (`get`, `list`, `getBySlug`): storefront and
+     *     vibe-coded mode. There is no admin equivalent of a by-key/by-slug
+     *     read — in admin mode they throw and point you at `listAdmin()` /
+     *     `findById()`.
+     *   - **Admin reads** (`listAdmin`, `findById`) and **writes** (`create`,
+     *     `update`, `publish`, `unpublish`, `remove`): admin mode only — they
+     *     call `/api/content/...` with the API key. Calling from storefront /
+     *     vibe-coded mode throws.
+     *
+     * **⚠️ Every admin method takes an explicit `storeId`.** Admin mode has no
+     * ambient store (`storeId` is only set in storefront mode), and the routes
+     * are store-scoped: omitting it is rejected fail-closed by the store scope
+     * guard (`403 STORE_SCOPE_REQUIRED`). Pass the id of the store your API key
+     * is bound to — naming any other store is rejected as cross-tenant.
      *
      * **Default key:** every type has `'main'` as its universal default key.
      * Pass no argument to fetch the main entry; pass a custom key (e.g.
@@ -9829,12 +9983,15 @@ declare class BrainerceClient {
      *   });
      * }
      *
-     * // Admin — create a shipping FAQ in DRAFT
-     * await client.content.faq.create({
-     *   key: 'shipping',
-     *   name: 'Shipping FAQ',
-     *   data: { items: [{ question: '…', answer: '…' }] },
-     * });
+     * // Admin — create a shipping FAQ in DRAFT (storeId is required)
+     * await client.content.faq.create(
+     *   {
+     *     key: 'shipping',
+     *     name: 'Shipping FAQ',
+     *     data: { items: [{ question: '…', answer: '…' }] },
+     *   },
+     *   'store_123'
+     * );
      * ```
      */
     content: {
@@ -9845,10 +10002,17 @@ declare class BrainerceClient {
              * hasn't seeded yet.
              */
             get: (key?: string, locale?: string) => Promise<Content<"FAQ"> | null>;
-            /** List all PUBLISHED entries of this type. */
+            /**
+             * List all PUBLISHED entries of this type (storefront / vibe-coded
+             * mode). In admin mode this throws — use
+             * `client.content.listAdmin({ storeId, type })`.
+             */
             list: (locale?: string) => Promise<Content<"FAQ">[]>;
-            /** Create a new entry in DRAFT (admin mode). */
-            create: (input: Omit<CreateContentInput<"FAQ">, "type">) => Promise<Content<"FAQ">>;
+            /**
+             * Create a new entry in DRAFT (admin mode).
+             * `storeId` is required — see the namespace docs above.
+             */
+            create: (input: Omit<CreateContentInput<"FAQ">, "type">, storeId: string) => Promise<Content<"FAQ">>;
         };
         footer: {
             /**
@@ -9857,10 +10021,17 @@ declare class BrainerceClient {
              * hasn't seeded yet.
              */
             get: (key?: string, locale?: string) => Promise<Content<"FOOTER"> | null>;
-            /** List all PUBLISHED entries of this type. */
+            /**
+             * List all PUBLISHED entries of this type (storefront / vibe-coded
+             * mode). In admin mode this throws — use
+             * `client.content.listAdmin({ storeId, type })`.
+             */
             list: (locale?: string) => Promise<Content<"FOOTER">[]>;
-            /** Create a new entry in DRAFT (admin mode). */
-            create: (input: Omit<CreateContentInput<"FOOTER">, "type">) => Promise<Content<"FOOTER">>;
+            /**
+             * Create a new entry in DRAFT (admin mode).
+             * `storeId` is required — see the namespace docs above.
+             */
+            create: (input: Omit<CreateContentInput<"FOOTER">, "type">, storeId: string) => Promise<Content<"FOOTER">>;
         };
         header: {
             /**
@@ -9869,10 +10040,17 @@ declare class BrainerceClient {
              * hasn't seeded yet.
              */
             get: (key?: string, locale?: string) => Promise<Content<"HEADER"> | null>;
-            /** List all PUBLISHED entries of this type. */
+            /**
+             * List all PUBLISHED entries of this type (storefront / vibe-coded
+             * mode). In admin mode this throws — use
+             * `client.content.listAdmin({ storeId, type })`.
+             */
             list: (locale?: string) => Promise<Content<"HEADER">[]>;
-            /** Create a new entry in DRAFT (admin mode). */
-            create: (input: Omit<CreateContentInput<"HEADER">, "type">) => Promise<Content<"HEADER">>;
+            /**
+             * Create a new entry in DRAFT (admin mode).
+             * `storeId` is required — see the namespace docs above.
+             */
+            create: (input: Omit<CreateContentInput<"HEADER">, "type">, storeId: string) => Promise<Content<"HEADER">>;
         };
         announcement: {
             /**
@@ -9881,10 +10059,17 @@ declare class BrainerceClient {
              * hasn't seeded yet.
              */
             get: (key?: string, locale?: string) => Promise<Content<"ANNOUNCEMENT"> | null>;
-            /** List all PUBLISHED entries of this type. */
+            /**
+             * List all PUBLISHED entries of this type (storefront / vibe-coded
+             * mode). In admin mode this throws — use
+             * `client.content.listAdmin({ storeId, type })`.
+             */
             list: (locale?: string) => Promise<Content<"ANNOUNCEMENT">[]>;
-            /** Create a new entry in DRAFT (admin mode). */
-            create: (input: Omit<CreateContentInput<"ANNOUNCEMENT">, "type">) => Promise<Content<"ANNOUNCEMENT">>;
+            /**
+             * Create a new entry in DRAFT (admin mode).
+             * `storeId` is required — see the namespace docs above.
+             */
+            create: (input: Omit<CreateContentInput<"ANNOUNCEMENT">, "type">, storeId: string) => Promise<Content<"ANNOUNCEMENT">>;
         };
         richText: {
             /**
@@ -9893,10 +10078,17 @@ declare class BrainerceClient {
              * hasn't seeded yet.
              */
             get: (key?: string, locale?: string) => Promise<Content<"RICH_TEXT"> | null>;
-            /** List all PUBLISHED entries of this type. */
+            /**
+             * List all PUBLISHED entries of this type (storefront / vibe-coded
+             * mode). In admin mode this throws — use
+             * `client.content.listAdmin({ storeId, type })`.
+             */
             list: (locale?: string) => Promise<Content<"RICH_TEXT">[]>;
-            /** Create a new entry in DRAFT (admin mode). */
-            create: (input: Omit<CreateContentInput<"RICH_TEXT">, "type">) => Promise<Content<"RICH_TEXT">>;
+            /**
+             * Create a new entry in DRAFT (admin mode).
+             * `storeId` is required — see the namespace docs above.
+             */
+            create: (input: Omit<CreateContentInput<"RICH_TEXT">, "type">, storeId: string) => Promise<Content<"RICH_TEXT">>;
         };
         page: {
             /**
@@ -9911,62 +10103,191 @@ declare class BrainerceClient {
              * hasn't seeded yet.
              */
             get: (key?: string, locale?: string) => Promise<Content<"PAGE"> | null>;
-            /** List all PUBLISHED entries of this type. */
+            /**
+             * List all PUBLISHED entries of this type (storefront / vibe-coded
+             * mode). In admin mode this throws — use
+             * `client.content.listAdmin({ storeId, type })`.
+             */
             list: (locale?: string) => Promise<Content<"PAGE">[]>;
-            /** Create a new entry in DRAFT (admin mode). */
-            create: (input: Omit<CreateContentInput<"PAGE">, "type">) => Promise<Content<"PAGE">>;
+            /**
+             * Create a new entry in DRAFT (admin mode).
+             * `storeId` is required — see the namespace docs above.
+             */
+            create: (input: Omit<CreateContentInput<"PAGE">, "type">, storeId: string) => Promise<Content<"PAGE">>;
         };
-        /** Find a single row by its admin id (admin mode). */
-        findById: <T_1 extends ContentType = ContentType>(id: string) => Promise<Content<T_1>>;
-        /** List rows in admin mode with optional filters. */
-        listAdmin: <T_1 extends ContentType = ContentType>(filters?: {
+        /**
+         * Find a single row by its admin id (admin mode).
+         *
+         * @example
+         * ```typescript
+         * const row = await client.content.findById('cnt_123', 'store_123');
+         * ```
+         */
+        findById: <T_1 extends ContentType = ContentType>(id: string, storeId: string) => Promise<Content<T_1>>;
+        /**
+         * List rows in admin mode. `storeId` is required; `type` and `status`
+         * are optional filters.
+         *
+         * @example
+         * ```typescript
+         * const faqs = await client.content.listAdmin({
+         *   storeId: 'store_123',
+         *   type: 'FAQ',
+         *   status: 'DRAFT',
+         * });
+         * ```
+         */
+        listAdmin: <T_1 extends ContentType = ContentType>(filters: {
+            storeId: string;
             type?: T_1;
             status?: "DRAFT" | "PUBLISHED";
         }) => Promise<Array<Content<T_1>>>;
-        /** Replace `data` (and optional metadata) on an existing row. */
-        update: <T_1 extends ContentType>(id: string, input: UpdateContentInput<T_1>) => Promise<Content<T_1>>;
-        /** Transition status DRAFT → PUBLISHED. */
-        publish: (id: string) => Promise<Content>;
-        /** Transition status PUBLISHED → DRAFT. */
-        unpublish: (id: string) => Promise<Content>;
-        /** Hard delete the row. Admin mode only. */
-        remove: (id: string) => Promise<void>;
+        /**
+         * Replace `data` (and optional metadata) on an existing row.
+         *
+         * @example
+         * ```typescript
+         * await client.content.update('cnt_123', { name: 'Shipping FAQ' }, 'store_123');
+         * ```
+         */
+        update: <T_1 extends ContentType>(id: string, input: UpdateContentInput<T_1>, storeId: string) => Promise<Content<T_1>>;
+        /**
+         * Transition status DRAFT → PUBLISHED.
+         *
+         * @example
+         * ```typescript
+         * await client.content.publish('cnt_123', 'store_123');
+         * ```
+         */
+        publish: (id: string, storeId: string) => Promise<Content>;
+        /**
+         * Transition status PUBLISHED → DRAFT.
+         *
+         * @example
+         * ```typescript
+         * await client.content.unpublish('cnt_123', 'store_123');
+         * ```
+         */
+        unpublish: (id: string, storeId: string) => Promise<Content>;
+        /**
+         * Hard delete the row. Admin mode only.
+         *
+         * @example
+         * ```typescript
+         * await client.content.remove('cnt_123', 'store_123');
+         * ```
+         */
+        remove: (id: string, storeId: string) => Promise<void>;
     };
     /**
      * Read and manage blog posts.
      *
+     * **⚠️ Every admin call takes an explicit `storeId`.** Admin mode has no
+     * ambient store (`storeId` is only set in storefront mode) and the admin
+     * routes are store-scoped: omitting it is rejected fail-closed by the store
+     * scope guard (`403 STORE_SCOPE_REQUIRED`). Pass the id of the store your
+     * API key is bound to — naming any other store is rejected as cross-tenant.
+     *
+     * Admin lookups are **by id**, not by slug (`getPost(slug)` is a public read
+     * and throws in admin mode — use `findById(id, storeId)`).
+     *
      * ```typescript
      * // Storefront / vibe-coded: list published posts
      * const { data: posts } = await brainerce.blog.getPosts({ category: 'news' });
      *
-     * // Fetch one by slug
+     * // Fetch one by slug (storefront / vibe-coded)
      * const post = await brainerce.blog.getPost('my-first-post');
      *
-     * // Admin: create a draft
-     * const draft = await brainerce.blog.create({ title: 'Hello World' });
+     * // Admin: list, read one, and create a draft
+     * const all = await brainerce.blog.getPosts({}, 'store_123');
+     * const one = await brainerce.blog.findById('post_123', 'store_123');
+     * const draft = await brainerce.blog.create({ title: 'Hello World' }, 'store_123');
      * ```
      */
     blog: {
         /**
-         * List published posts. Works in all modes.
-         * Filters: `category`, `tag`, `page`, `limit`.
+         * List posts. Filters: `category`, `tag`, `page`, `limit`.
+         *
+         * Storefront / vibe-coded mode lists PUBLISHED posts and ignores
+         * `storeId` (the store is already in the base URL). Admin mode lists
+         * drafts too and REQUIRES `storeId`.
+         *
+         * @example
+         * ```typescript
+         * const { data } = await client.blog.getPosts({ category: 'news' });      // storefront
+         * const { data } = await client.blog.getPosts({}, 'store_123');           // admin
+         * ```
          */
-        getPosts: (params?: BlogPostListParams) => Promise<BlogPostListResponse>;
+        getPosts: (params?: BlogPostListParams, storeId?: string) => Promise<BlogPostListResponse>;
         /**
-         * Fetch one published post by its slug. Returns `null` on 404.
-         * Works in all modes.
+         * Fetch one PUBLISHED post by its slug. Returns `null` on 404.
+         *
+         * Storefront / vibe-coded mode only — the admin API has no by-slug
+         * lookup (`GET /api/blog/posts/:id` is by id), so this throws in admin
+         * mode rather than issuing a request that can only 404.
+         *
+         * @example
+         * ```typescript
+         * const post = await client.blog.getPost('my-first-post');
+         * ```
          */
         getPost: (slug: string) => Promise<BlogPost | null>;
-        /** Create a blog post in DRAFT status. Admin mode only. */
-        create: (input: CreateBlogPostInput) => Promise<BlogPost>;
-        /** Update a blog post by ID. Admin mode only. */
-        update: (id: string, input: UpdateBlogPostInput) => Promise<BlogPost>;
-        /** Transition status → PUBLISHED (sets publishedAt = now if unset). Admin mode only. */
-        publish: (id: string) => Promise<BlogPost>;
-        /** Transition status PUBLISHED → DRAFT. Admin mode only. */
-        unpublish: (id: string) => Promise<BlogPost>;
-        /** Hard-delete a blog post. Admin mode only. */
-        remove: (id: string) => Promise<void>;
+        /**
+         * Fetch one post by its admin id — drafts included. Admin mode only.
+         * Returns `null` on 404.
+         *
+         * @example
+         * ```typescript
+         * const post = await client.blog.findById('post_123', 'store_123');
+         * ```
+         */
+        findById: (id: string, storeId: string) => Promise<BlogPost | null>;
+        /**
+         * Create a blog post in DRAFT status. Admin mode only.
+         *
+         * @example
+         * ```typescript
+         * const draft = await client.blog.create({ title: 'Hello World' }, 'store_123');
+         * ```
+         */
+        create: (input: CreateBlogPostInput, storeId: string) => Promise<BlogPost>;
+        /**
+         * Update a blog post by ID. Admin mode only.
+         *
+         * @example
+         * ```typescript
+         * await client.blog.update('post_123', { title: 'Renamed' }, 'store_123');
+         * ```
+         */
+        update: (id: string, input: UpdateBlogPostInput, storeId: string) => Promise<BlogPost>;
+        /**
+         * Transition status → PUBLISHED (sets publishedAt = now if unset).
+         * Admin mode only.
+         *
+         * @example
+         * ```typescript
+         * await client.blog.publish('post_123', 'store_123');
+         * ```
+         */
+        publish: (id: string, storeId: string) => Promise<BlogPost>;
+        /**
+         * Transition status PUBLISHED → DRAFT. Admin mode only.
+         *
+         * @example
+         * ```typescript
+         * await client.blog.unpublish('post_123', 'store_123');
+         * ```
+         */
+        unpublish: (id: string, storeId: string) => Promise<BlogPost>;
+        /**
+         * Hard-delete a blog post. Admin mode only.
+         *
+         * @example
+         * ```typescript
+         * await client.blog.remove('post_123', 'store_123');
+         * ```
+         */
+        remove: (id: string, storeId: string) => Promise<void>;
     };
     /**
      * Submit a contact inquiry from a storefront contact form.
@@ -13079,41 +13400,43 @@ declare class BrainerceClient {
      * ```
      */
     uploadReviewPhoto(productId: string, file: File | Blob): Promise<ReviewPhotoUpload>;
+    /** The message every team method throws. One string so they cannot drift. */
+    private teamIsDashboardOnly;
     /**
-     * @deprecated Retiring, but there is no API-key replacement yet: `getStoreTeam`
-     * is dashboard-only (403 for api_key). Keep using this until one ships.
+     * @deprecated Retiring, but this ALWAYS throws: `/v1/team/*` rejects the
+     * api_key principal and `getStoreTeam` is dashboard-only. Use the dashboard.
      */
     getTeamMembers(): Promise<TeamMembersResponse>;
     /**
-     * @deprecated Retiring, but there is no API-key replacement yet: `getStoreTeam`
-     * is dashboard-only (403 for api_key). Keep using this until one ships.
+     * @deprecated Retiring, but this ALWAYS throws: `/v1/team/*` rejects the
+     * api_key principal and `getStoreTeam` is dashboard-only. Use the dashboard.
      */
     getTeamInvitations(): Promise<TeamInvitationsResponse>;
     /**
-     * @deprecated Retiring, but there is no API-key replacement yet: `inviteStoreMember`
-     * is dashboard-only (403 for api_key). Keep using this until one ships.
+     * @deprecated Retiring, but this ALWAYS throws: `/v1/team/*` rejects the
+     * api_key principal and the store-level route is dashboard-only. Use the dashboard.
      */
-    inviteTeamMember(data: InviteMemberDto): Promise<TeamInvitation>;
+    inviteTeamMember(_data: InviteMemberDto): Promise<TeamInvitation>;
     /**
-     * @deprecated Retiring, but there is no API-key replacement yet: `resendStoreInvitation`
-     * is dashboard-only (403 for api_key). Keep using this until one ships.
+     * @deprecated Retiring, but this ALWAYS throws: `/v1/team/*` rejects the
+     * api_key principal and the store-level route is dashboard-only. Use the dashboard.
      */
-    resendTeamInvitation(invitationId: string): Promise<TeamInvitation>;
+    resendTeamInvitation(_invitationId: string): Promise<TeamInvitation>;
     /**
-     * @deprecated Retiring, but there is no API-key replacement yet: `revokeStoreInvitation`
-     * is dashboard-only (403 for api_key). Keep using this until one ships.
+     * @deprecated Retiring, but this ALWAYS throws: `/v1/team/*` rejects the
+     * api_key principal and the store-level route is dashboard-only. Use the dashboard.
      */
-    revokeTeamInvitation(invitationId: string): Promise<void>;
+    revokeTeamInvitation(_invitationId: string): Promise<void>;
     /**
-     * @deprecated Retiring, but there is no API-key replacement yet: `updateStoreMember`
-     * is dashboard-only (403 for api_key). Keep using this until one ships.
+     * @deprecated Retiring, but this ALWAYS throws: `/v1/team/*` rejects the
+     * api_key principal and the store-level route is dashboard-only. Use the dashboard.
      */
-    updateTeamMemberRole(memberId: string, data: UpdateMemberRoleDto): Promise<TeamMember>;
+    updateTeamMemberRole(_memberId: string, _data: UpdateMemberRoleDto): Promise<TeamMember>;
     /**
-     * @deprecated Retiring, but there is no API-key replacement yet: `removeStoreMember`
-     * is dashboard-only (403 for api_key). Keep using this until one ships.
+     * @deprecated Retiring, but this ALWAYS throws: `/v1/team/*` rejects the
+     * api_key principal and the store-level route is dashboard-only. Use the dashboard.
      */
-    removeTeamMember(memberId: string): Promise<void>;
+    removeTeamMember(_memberId: string): Promise<void>;
     /**
      * Every store-level team operation is dashboard-only.
      *
@@ -13534,7 +13857,7 @@ declare class BrainerceError extends Error {
     constructor(message: string, statusCode: number, details?: unknown);
 }
 
-declare const SDK_VERSION = "2.4.0";
+declare const SDK_VERSION = "2.5.0";
 
 /**
  * Verify a webhook signature from Brainerce