brainerce 2.1.0 → 2.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -2010,6 +2010,31 @@ interface Order {
2010
2010
  * order reads `"paid"` with no provider behind it.
2011
2011
  */
2012
2012
  financialStatus?: string | null;
2013
+ /**
2014
+ * Gift cards that settled part of this order.
2015
+ *
2016
+ * `total` is what the order was WORTH; these are what actually paid for it.
2017
+ * A receipt showing only the total tells a customer they handed over money
2018
+ * they did not — so render each tender as its own line and, when there is at
2019
+ * least one, an "amount charged" figure of `total` minus their sum.
2020
+ *
2021
+ * Empty or absent on an order paid entirely by card or cash. Snapshotted at
2022
+ * order creation, so this is a historical record: it does not change if the
2023
+ * gift card is later adjusted, disabled or re-issued.
2024
+ */
2025
+ tenders?: Array<{
2026
+ id: string;
2027
+ /** `GIFT_CARD` today. The field exists so a second internal tender type does not break callers. */
2028
+ type: string;
2029
+ /** What this tender paid, in `currencyBase`. Decimal string. */
2030
+ amountBase: string;
2031
+ currencyBase: string;
2032
+ /** Last four of the code. The full code is stored as an HMAC and cannot be returned. */
2033
+ giftCard?: {
2034
+ id: string;
2035
+ codeLast4: string;
2036
+ } | null;
2037
+ }>;
2013
2038
  /** Fulfillment status: "unfulfilled", "partial", "fulfilled". */
2014
2039
  fulfillmentStatus?: string | null;
2015
2040
  /** Tracking number, e.g., "1Z999AA10123456784". */
@@ -2180,7 +2205,10 @@ interface OrderQueryParams {
2180
2205
  * not model. Cast if you need to filter by a label id.
2181
2206
  */
2182
2207
  status?: OrderStatus;
2183
- sortBy?: 'createdAt' | 'totalAmount';
2208
+ /** Mirrors `VALID_ORDER_SORT` (orders.service.ts:674), the allowlist that
2209
+ * actually gates this — the v1 route takes `sortBy` as a bare string with no
2210
+ * `@IsEnum`, so the service set is the contract. */
2211
+ sortBy?: 'createdAt' | 'totalAmount' | 'status';
2184
2212
  sortOrder?: 'asc' | 'desc';
2185
2213
  }
2186
2214
  interface CreateOrderDto {
@@ -2299,7 +2327,12 @@ interface CouponQueryParams {
2299
2327
  status?: CouponStatus;
2300
2328
  type?: CouponType;
2301
2329
  platform?: ConnectorPlatform;
2302
- sortBy?: 'code' | 'createdAt' | 'updatedAt' | 'value';
2330
+ /**
2331
+ * Mirrors the `@IsIn` on `coupon-query.dto.ts:44` exactly. It previously
2332
+ * offered `'value'`, which the API rejects with a 400, and omitted three
2333
+ * members it accepts.
2334
+ */
2335
+ sortBy?: 'code' | 'createdAt' | 'updatedAt' | 'startsAt' | 'endsAt' | 'usageCount';
2303
2336
  sortOrder?: 'asc' | 'desc';
2304
2337
  }
2305
2338
  interface CreateCouponDto {
@@ -3664,6 +3697,108 @@ interface SelectPickupLocationDto {
3664
3697
  * anything about who owns it. A storefront needs the tender id (to remove it),
3665
3698
  * how much went on, and what the provider will now be charged.
3666
3699
  */
3700
+ /**
3701
+ * A gift card as the admin API returns it.
3702
+ *
3703
+ * The full code is NOT here and never will be: only an HMAC of it is stored, so
3704
+ * there is nothing to return. `maskedCode` and `codeLast4` are the whole of what
3705
+ * can be shown after issuance.
3706
+ */
3707
+ interface GiftCardAdmin {
3708
+ id: string;
3709
+ /** `••••-••••-••••-••••-V2D3`. */
3710
+ maskedCode: string;
3711
+ codeLast4: string;
3712
+ /** Decimal strings, all of them. These are balances; never parse them to float for arithmetic. */
3713
+ initialAmount: string;
3714
+ /** Settled value on the card. */
3715
+ balance: string;
3716
+ /** Reserved by a checkout in progress and not available to spend. */
3717
+ heldAmount: string;
3718
+ /** `balance - heldAmount` — what a shopper could actually use right now. */
3719
+ spendable: string;
3720
+ currency: string;
3721
+ status: 'ACTIVE' | 'DISABLED' | 'REVOKED';
3722
+ customerId: string | null;
3723
+ recipientEmail: string | null;
3724
+ expiresAt: string | null;
3725
+ /** Stamped if an expiry was ever processed. The balance is deliberately NOT zeroed. */
3726
+ expiredAt: string | null;
3727
+ /** Derived at read time, so it is true the moment validity lapses. */
3728
+ expired: boolean;
3729
+ createdAt: string;
3730
+ }
3731
+ /** One movement of value. The ledger is append-only — nothing here is ever rewritten. */
3732
+ interface GiftCardTransaction {
3733
+ id: string;
3734
+ type: 'ISSUE' | 'REDEEM' | 'REFUND' | 'ADJUST' | 'EXPIRE';
3735
+ /** Signed decimal string. Negative debits the card. */
3736
+ amount: string;
3737
+ balanceAfter: string;
3738
+ orderId: string | null;
3739
+ actorUserId: string | null;
3740
+ note: string | null;
3741
+ createdAt: string;
3742
+ }
3743
+ /** A card with its full history. */
3744
+ interface GiftCardAdminDetail extends GiftCardAdmin {
3745
+ recipientName: string | null;
3746
+ orderId: string | null;
3747
+ transactions: GiftCardTransaction[];
3748
+ }
3749
+ /**
3750
+ * Outstanding liability for a store — the figure reconciled at month-end close.
3751
+ *
3752
+ * Reported PER CURRENCY. Balances in different currencies do not add up, so the
3753
+ * top-level figures cover one currency and `byCurrency` carries the rest.
3754
+ * Expired value is separate and is NOT written off: whether expiry extinguishes
3755
+ * the obligation is an open legal question, so it is never folded into either
3756
+ * side.
3757
+ */
3758
+ interface GiftCardLiability {
3759
+ active: string;
3760
+ held: string;
3761
+ expiredNotWrittenOff: string;
3762
+ currency: string | null;
3763
+ byCurrency: Array<{
3764
+ currency: string;
3765
+ active: string;
3766
+ held: string;
3767
+ expiredNotWrittenOff: string;
3768
+ }>;
3769
+ /** Whether the store may issue at all. Redemption is NOT gated on this. */
3770
+ enabled: boolean;
3771
+ }
3772
+ /**
3773
+ * The response to issuing or re-issuing.
3774
+ *
3775
+ * ⚠️ `plaintextCode` is returned EXACTLY ONCE. Persist it from this response or
3776
+ * deliver it now — it is stored only as an HMAC and no API, dashboard or
3777
+ * database query can produce it again.
3778
+ */
3779
+ interface IssuedGiftCardAdmin {
3780
+ giftCardId: string;
3781
+ plaintextCode: string;
3782
+ last4: string;
3783
+ }
3784
+ /** Re-issue also reports what moved across from the card it revoked. */
3785
+ interface ReissuedGiftCardAdmin extends IssuedGiftCardAdmin {
3786
+ movedAmount: string;
3787
+ /** Where the replacement was emailed, or null if the merchant must hand it over. */
3788
+ deliveredTo: string | null;
3789
+ }
3790
+ interface IssueGiftCardAdminDto {
3791
+ /** Decimal string, e.g. "200.00". Must be greater than zero. */
3792
+ amount: string;
3793
+ /** REQUIRED. Written to the ledger — issuing value with no stated reason is not auditable. */
3794
+ note: string;
3795
+ customerId?: string;
3796
+ /** ISO 8601. Must be in the future. Omit for a card that never expires. */
3797
+ expiresAt?: string;
3798
+ recipientEmail?: string;
3799
+ recipientName?: string;
3800
+ personalMessage?: string;
3801
+ }
3667
3802
  interface CheckoutTender {
3668
3803
  /** Pass this to `removeGiftCard` — a checkout can carry more than one card. */
3669
3804
  tenderId: string;
@@ -9582,7 +9717,7 @@ declare class BrainerceClient {
9582
9717
  * Works in all three SDK modes (vibe-coded, storefront, admin):
9583
9718
  * - **Public reads** (`get`, `list`, `getBySlug`): work in any mode.
9584
9719
  * - **Write operations** (`create`, `update`, `publish`, `unpublish`,
9585
- * `remove`): admin mode only — they call `/api/v1/content/...` with
9720
+ * `remove`): admin mode only — they call `/api/content/...` with
9586
9721
  * the API key. Calling from storefront / vibe-coded mode throws.
9587
9722
  *
9588
9723
  * **Default key:** every type has `'main'` as its universal default key.
@@ -10577,6 +10712,121 @@ declare class BrainerceClient {
10577
10712
  * Show "we cannot use this code" and let the shopper re-enter it.
10578
10713
  */
10579
10714
  checkGiftCardBalance(code: string): Promise<GiftCardBalance>;
10715
+ /**
10716
+ * List gift cards.
10717
+ *
10718
+ * `search` matches the LAST FOUR of a code or part of a recipient email. It
10719
+ * cannot match a full code: only an HMAC is stored, so there is nothing to
10720
+ * search against.
10721
+ *
10722
+ * Requires `gift_cards:read`.
10723
+ */
10724
+ listGiftCards(params?: {
10725
+ page?: number;
10726
+ limit?: number;
10727
+ /** `all` | `active` | `withBalance` | `expired` | `disabled` */
10728
+ filter?: string;
10729
+ search?: string;
10730
+ }): Promise<PaginatedResponse<GiftCardAdmin>>;
10731
+ /**
10732
+ * Outstanding gift card liability, per currency.
10733
+ *
10734
+ * This is the month-end number. Read `byCurrency` if the store sells in more
10735
+ * than one — currencies are never summed together.
10736
+ *
10737
+ * Requires `gift_cards:read`.
10738
+ */
10739
+ getGiftCardLiability(): Promise<GiftCardLiability>;
10740
+ /**
10741
+ * One gift card with its full ledger.
10742
+ *
10743
+ * Requires `gift_cards:read`.
10744
+ */
10745
+ getGiftCard(giftCardId: string): Promise<GiftCardAdminDetail>;
10746
+ /**
10747
+ * Issue a gift card.
10748
+ *
10749
+ * ⚠️ **The code comes back exactly once.** It is stored only as an HMAC, so
10750
+ * this response is the only time it exists in readable form anywhere. Persist
10751
+ * it or deliver it before you discard the response — no later call, dashboard
10752
+ * screen or database query can recover it.
10753
+ *
10754
+ * A `note` is required. Refused when gift cards are switched off for the
10755
+ * store. Pass an `Idempotency-Key` header to make a retry safe.
10756
+ *
10757
+ * Requires `gift_cards:issue`.
10758
+ *
10759
+ * @example
10760
+ * ```typescript
10761
+ * const card = await client.issueGiftCard({
10762
+ * amount: '200.00',
10763
+ * note: 'Compensation for order #1042',
10764
+ * recipientEmail: 'dana@example.com',
10765
+ * });
10766
+ * await sendToCustomer(card.plaintextCode); // your only chance
10767
+ * ```
10768
+ */
10769
+ issueGiftCard(data: IssueGiftCardAdminDto): Promise<IssuedGiftCardAdmin>;
10770
+ /**
10771
+ * Re-issue a gift card onto a new code.
10772
+ *
10773
+ * The answer to a customer losing their code. Mints a new code, moves the
10774
+ * WHOLE balance to it, and REVOKES the old card.
10775
+ *
10776
+ * **This is not a resend.** The old code stops working the moment this
10777
+ * returns — if the customer still holds a printed card, it dies. Refused
10778
+ * while a checkout holds value on the card. The original expiry carries
10779
+ * forward, so this cannot be used to restart an expiry clock.
10780
+ *
10781
+ * The new code is returned exactly once, under the same rules as issuance.
10782
+ *
10783
+ * Requires `gift_cards:issue`.
10784
+ */
10785
+ reissueGiftCard(giftCardId: string, note: string): Promise<ReissuedGiftCardAdmin>;
10786
+ /**
10787
+ * Adjust a gift card balance.
10788
+ *
10789
+ * `delta` is a SIGNED decimal string: `"25.00"` adds, `"-25.00"` takes away.
10790
+ * The `note` is required and is written to the ledger permanently — it is the
10791
+ * row a finance review reads a year from now.
10792
+ *
10793
+ * A debit cannot take the balance below what live checkout holds have already
10794
+ * reserved; that refusal names the held amount so you can act on it.
10795
+ *
10796
+ * Requires `gift_cards:adjust`.
10797
+ */
10798
+ adjustGiftCardBalance(giftCardId: string, delta: string, note: string): Promise<{
10799
+ balanceAfter: string;
10800
+ }>;
10801
+ /**
10802
+ * Enable, disable or revoke one gift card.
10803
+ *
10804
+ * Deliberately does NOT touch live holds: a checkout that already reserved
10805
+ * value settles normally, because pulling it out from under a shopper
10806
+ * mid-payment would strand a provider charge already in flight. Disabling
10807
+ * stops NEW holds, which is what "off" actually means.
10808
+ *
10809
+ * Requires `gift_cards:write`.
10810
+ */
10811
+ setGiftCardStatus(giftCardId: string, status: 'ACTIVE' | 'DISABLED' | 'REVOKED'): Promise<{
10812
+ success: true;
10813
+ }>;
10814
+ /**
10815
+ * Disable or reactivate many gift cards at once.
10816
+ *
10817
+ * `REVOKED` is not accepted here — it belongs to re-issue, which moves the
10818
+ * balance to a replacement first. Revoking in bulk would strand balances with
10819
+ * nowhere to go. Cards already revoked are skipped, so the returned count is
10820
+ * the honest one and may be lower than the ids you sent.
10821
+ *
10822
+ * There is no bulk delete, here or anywhere: the ledger is append-only and a
10823
+ * card may carry a statutory retention life.
10824
+ *
10825
+ * Requires `gift_cards:write`.
10826
+ */
10827
+ bulkSetGiftCardStatus(giftCardIds: string[], status: 'ACTIVE' | 'DISABLED'): Promise<{
10828
+ updated: number;
10829
+ }>;
10580
10830
  /**
10581
10831
  * Start a donation.
10582
10832
  *
@@ -12685,6 +12935,22 @@ declare class BrainerceClient {
12685
12935
  * is dashboard-only (403 for api_key). Keep using this until one ships.
12686
12936
  */
12687
12937
  removeTeamMember(memberId: string): Promise<void>;
12938
+ /**
12939
+ * Every store-level team operation is dashboard-only.
12940
+ *
12941
+ * `store-team.controller.ts:53` carries `DashboardOnlyGuard`, which rejects
12942
+ * `api_key` and `app_installation` principals outright, so no SDK caller can
12943
+ * reach these however the URL is spelled. They additionally pointed at
12944
+ * `/api/v1/stores/:storeId/team*`, and `@Controller('v1')`
12945
+ * (external-api.controller.ts:181) has no `stores` root — so what they
12946
+ * actually returned was a 404, not the 403 you would expect from the guard.
12947
+ *
12948
+ * Throwing beats either status code: a 404 reads as "wrong id" and a 403 as
12949
+ * "missing permission", and both send the caller looking for a fix that does
12950
+ * not exist. Use the account-level `getTeamMembers()` family, or the
12951
+ * dashboard.
12952
+ */
12953
+ private dashboardOnlyTeamOperation;
12688
12954
  /**
12689
12955
  * Get the team for a specific store (members + pending invitations)
12690
12956
  * Requires Admin mode (apiKey) and MANAGE_TEAM permission
@@ -12694,7 +12960,7 @@ declare class BrainerceClient {
12694
12960
  * const { members, invitations } = await client.getStoreTeam('store_id');
12695
12961
  * ```
12696
12962
  */
12697
- getStoreTeam(storeId: string): Promise<StoreTeamResponse>;
12963
+ getStoreTeam(_storeId: string): Promise<StoreTeamResponse>;
12698
12964
  /**
12699
12965
  * Invite a new member to a store
12700
12966
  * Requires Admin mode (apiKey) and MANAGE_TEAM permission
@@ -12710,7 +12976,7 @@ declare class BrainerceClient {
12710
12976
  * });
12711
12977
  * ```
12712
12978
  */
12713
- inviteStoreMember(storeId: string, data: InviteStoreMemberDto): Promise<StoreInvitation>;
12979
+ inviteStoreMember(_storeId: string, _data: InviteStoreMemberDto): Promise<StoreInvitation>;
12714
12980
  /**
12715
12981
  * Update a store team member's role and/or permissions
12716
12982
  * Requires Admin mode (apiKey) and MANAGE_TEAM permission
@@ -12726,7 +12992,7 @@ declare class BrainerceClient {
12726
12992
  * });
12727
12993
  * ```
12728
12994
  */
12729
- updateStoreMember(storeId: string, memberId: string, data: UpdateStoreMemberDto): Promise<StoreMember>;
12995
+ updateStoreMember(_storeId: string, _memberId: string, _data: UpdateStoreMemberDto): Promise<StoreMember>;
12730
12996
  /**
12731
12997
  * Replace the set of vibe-coded sales channels a store member is restricted to.
12732
12998
  * Channels are identified by their public `connectionId` (`vc_*` format). Pass
@@ -12746,22 +13012,22 @@ declare class BrainerceClient {
12746
13012
  * });
12747
13013
  * ```
12748
13014
  */
12749
- updateStoreMemberSalesChannels(storeId: string, memberId: string, data: UpdateStoreMemberSalesChannelsDto): Promise<StoreMember>;
13015
+ updateStoreMemberSalesChannels(_storeId: string, _memberId: string, _data: UpdateStoreMemberSalesChannelsDto): Promise<StoreMember>;
12750
13016
  /**
12751
13017
  * Remove a member from a store team
12752
13018
  * Requires Admin mode (apiKey) and MANAGE_TEAM permission
12753
13019
  */
12754
- removeStoreMember(storeId: string, memberId: string): Promise<void>;
13020
+ removeStoreMember(_storeId: string, _memberId: string): Promise<void>;
12755
13021
  /**
12756
13022
  * Resend a store invitation email
12757
13023
  * Requires Admin mode (apiKey) and MANAGE_TEAM permission
12758
13024
  */
12759
- resendStoreInvitation(storeId: string, invitationId: string): Promise<StoreInvitation>;
13025
+ resendStoreInvitation(_storeId: string, _invitationId: string): Promise<StoreInvitation>;
12760
13026
  /**
12761
13027
  * Revoke a store invitation
12762
13028
  * Requires Admin mode (apiKey) and MANAGE_TEAM permission
12763
13029
  */
12764
- revokeStoreInvitation(storeId: string, invitationId: string): Promise<void>;
13030
+ revokeStoreInvitation(_storeId: string, _invitationId: string): Promise<void>;
12765
13031
  /**
12766
13032
  * Get public invitation details by token (no auth required)
12767
13033
  * Used on the invitation acceptance page
@@ -12798,7 +13064,18 @@ declare class BrainerceClient {
12798
13064
  * }
12799
13065
  * ```
12800
13066
  */
12801
- getMyStorePermissions(storeId: string): Promise<UserStorePermissions>;
13067
+ getMyStorePermissions(_storeId: string): Promise<UserStorePermissions>;
13068
+ /**
13069
+ * `/me/*` answers "who am I and what can I reach", which only a real user can
13070
+ * ask. `UserContextController` (store-team.controller.ts:246) is guarded by
13071
+ * `DashboardOnlyGuard` for a load-bearing reason its own G16 comment spells
13072
+ * out: both routes resolve access purely from `@CurrentUserId()`, which is
13073
+ * `undefined` for an api_key principal, so the store filter would be stripped
13074
+ * and every store on the platform returned. The guard is the control. These
13075
+ * also pointed at `/api/v1/me/*`, which no controller serves, so the observed
13076
+ * failure was a 404 rather than the guard's 403.
13077
+ */
13078
+ private dashboardOnlyUserContext;
12802
13079
  /**
12803
13080
  * Get email settings for the store
12804
13081
  * Requires Admin mode (apiKey)
@@ -12896,6 +13173,21 @@ declare class BrainerceClient {
12896
13173
  * @param resolution - 'MERGE' to link to existing product, 'CREATE_NEW' to create new product
12897
13174
  */
12898
13175
  resolveSyncConflict(conflictId: string, resolution: SyncConflictResolution): Promise<SyncConflict>;
13176
+ /**
13177
+ * Sync conflicts were never implemented on the server.
13178
+ *
13179
+ * There is no `sync-conflict` route anywhere in the backend — not under
13180
+ * `@Controller('v1')`, not on any other controller. These two methods have
13181
+ * called a URL that has never existed, and `SyncConflict` /
13182
+ * `SyncConflictResolution` / `ResolveSyncConflictDto` are exported types with
13183
+ * no producer. The METAFIELD conflict siblings below are real
13184
+ * (external-api.controller.ts:4788, :4802) and are easy to mistake for these.
13185
+ *
13186
+ * Kept as throwing stubs rather than deleted: removing exported methods from a
13187
+ * published package is a breaking change, and a caller who has been swallowing
13188
+ * a 404 deserves to be told why.
13189
+ */
13190
+ private syncConflictsNotImplemented;
12899
13191
  /**
12900
13192
  * Get pending metafield conflicts for the store
12901
13193
  * Requires Admin mode (apiKey)
@@ -13063,7 +13355,7 @@ declare class BrainerceError extends Error {
13063
13355
  constructor(message: string, statusCode: number, details?: unknown);
13064
13356
  }
13065
13357
 
13066
- declare const SDK_VERSION = "2.0.3";
13358
+ declare const SDK_VERSION = "2.2.0";
13067
13359
 
13068
13360
  /**
13069
13361
  * Verify a webhook signature from Brainerce
@@ -13564,4 +13856,4 @@ interface CategorySitemapOptions {
13564
13856
  */
13565
13857
  declare function getCategorySitemapEntries(client: BrainerceClient, opts: CategorySitemapOptions): Promise<SitemapEntry[]>;
13566
13858
 
13567
- export { type AddToCartDto, type AddressDetailsResult, type AddressSuggestion, type AiTranslateBulkInput, type AiTranslateBulkResult, type AiTranslateSingleInput, type AnnouncementContent, type AnnouncementSeverity, type AppliedDiscount, type ApplyCouponDto, type AssignTaxClassDto, type AttachModifierGroupInput, type Attribute, type AttributeDisplayType, type AttributeOption, type AttributeSource, type AutoRegionResponse, 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 CartBundleOfferOfferedProduct, type CartBundlesResponse, type CartIncludeOption, type CartIncludeOptions, type CartItem, type CartItemModifierLine, type CartItemUnavailableReason, 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 CheckoutTender, 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 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 CreateRegionDto, type CreateReturnLabelDto as CreateReturnLabelInput, type CreateReturnLabelResponse, type CreateShippingRateDto as CreateShippingRateInput, type CreateShippingZoneDto as CreateShippingZoneInput, type CreateStockAlertInput, type CreateTagDto as CreateTagInput, type CreateTaxClassDto, type CreateTaxRateDto as CreateTaxRateInput, type CreateVariantDto, type Customer, type CustomerAddress, type CustomerAuthResponse, type CustomerOAuthProvider, type CustomerProfile, type CustomerQueryParams, type CustomizationFieldOption, 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 GiftCardBalance, type GuestCheckoutStartResponse, type GuestOrderResponse, type HeaderContent, type HeaderCta, type HeaderLogo, type HeaderNavItem, type I18nSettings, 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 LocaleTranslation, type LockedVariant, type LoyaltyBadge, type LoyaltyMembershipPlan, type LoyaltyNextTierSummary, type LoyaltyReward, type LoyaltyRewardRecommendation, 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 NestedModifierSelection, type OAuthAuthorizeResponse, type OAuthCallbackResponse, type OAuthConnection, type OAuthConnectionsResponse, type OAuthErrorCode, 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 PaidMembershipInfo, 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 ProductReviewImage, type ProductReviewImageAdmin, type ProductSitemapOptions, type ProductStatus, type ProductSuggestion, type ProductUnavailableError, type ProductVariant, type PublicMetafieldDefinition, type PublicRegion, type PublicRegionDetail, type PublicRegionPaymentProvider, type PublicTaxClass, type PublishProductResponse, RTL_LOCALES, type RecommendationVariant, type ReconcileInventoryResponse, type RedeemRewardResult, type ReferralInfo, type Refund, type RefundLineItem, type RefundLineItemResponse, type RefundType, type Region, type RegionPaymentProvider, type RegisterCustomerDto, type RelativeDateBounds, type ReservationInfo, type ResolveMetafieldConflictDto as ResolveMetafieldConflictInput, type ResolveSyncConflictDto as ResolveSyncConflictInput, type ReturnLabelParcel, type ReviewPhotoUpload, type ReviewStatus, type RichTextContent, SDK_VERSION, type SavedPaymentMethodSummary, 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 SetTranslationFields, type ShippingDestinations, type ShippingLine, type ShippingRate, type ShippingRateConfig, type ShippingRateType, type ShippingSummaryEntry, type ShippingZone, type ShippingZoneQueryParams, type SitemapEntry, type StockAlertResponse, type StockAvailabilityRequest, type StockAvailabilityResponse, type StockAvailabilityResult, type StoreCapabilities, type StoreInfo, type StoreInvitation, type StoreInvitationDetails, type StoreMember, type StorePermission, type StoreRole, type StoreTeamResponse, type StoreTracking, type StorefrontSavedPaymentMethod, type SubmitProductReviewInput, type SubscribeMarketingInput, type SubscribeMarketingResponse, type SupportedLocaleObject, type SyncConflict, type SyncConflictResolution, type SyncJob, type Tag, type TaxBreakdown, type TaxBreakdownItem, type TaxClass, type TaxEstimateResponse, type TaxRate, type TaxonomyQueryParams, type TeamInvitation, type TeamInvitationsResponse, type TeamMember, type TeamMembersResponse, type TeamRole, type TrackingEventItem, type TrackingEventName, type TrackingEventPayload, type TranslatableEntityType, type TranslationStatusEntry, type TranslationsMap, 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 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 UpdateRegionDto, type UpdateShippingRateDto as UpdateShippingRateInput, type UpdateShippingZoneDto as UpdateShippingZoneInput, type UpdateStoreMemberDto as UpdateStoreMemberInput, type UpdateTagDto as UpdateTagInput, type UpdateTaxClassDto, type UpdateTaxRateDto as UpdateTaxRateInput, type UpdateVariantDto, type UpdateVariantInventoryDto, type UpsellSettings, 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 };
13859
+ export { type AddToCartDto, type AddressDetailsResult, type AddressSuggestion, type AiTranslateBulkInput, type AiTranslateBulkResult, type AiTranslateSingleInput, type AnnouncementContent, type AnnouncementSeverity, type AppliedDiscount, type ApplyCouponDto, type AssignTaxClassDto, type AttachModifierGroupInput, type Attribute, type AttributeDisplayType, type AttributeOption, type AttributeSource, type AutoRegionResponse, 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 CartBundleOfferOfferedProduct, type CartBundlesResponse, type CartIncludeOption, type CartIncludeOptions, type CartItem, type CartItemModifierLine, type CartItemUnavailableReason, 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 CheckoutTender, 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 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 CreateRegionDto, type CreateReturnLabelDto as CreateReturnLabelInput, type CreateReturnLabelResponse, type CreateShippingRateDto as CreateShippingRateInput, type CreateShippingZoneDto as CreateShippingZoneInput, type CreateStockAlertInput, type CreateTagDto as CreateTagInput, type CreateTaxClassDto, type CreateTaxRateDto as CreateTaxRateInput, type CreateVariantDto, type Customer, type CustomerAddress, type CustomerAuthResponse, type CustomerOAuthProvider, type CustomerProfile, type CustomerQueryParams, type CustomizationFieldOption, 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 GiftCardAdmin, type GiftCardAdminDetail, type GiftCardBalance, type GiftCardLiability, type GiftCardTransaction, type GuestCheckoutStartResponse, type GuestOrderResponse, type HeaderContent, type HeaderCta, type HeaderLogo, type HeaderNavItem, type I18nSettings, type InsufficientStockError, type InventoryInfo, type InventoryReservationStrategy, type InventorySyncStatus, type InventoryTrackingMode, type InvitationStatus, type InviteMemberDto as InviteMemberInput, type InviteStoreMemberDto as InviteStoreMemberInput, type IssueGiftCardAdminDto, type IssuedGiftCardAdmin, type JsonLdOptions, type ListModifierGroupsParams, type LocalCart, type LocalCartItem, type LocaleTranslation, type LockedVariant, type LoyaltyBadge, type LoyaltyMembershipPlan, type LoyaltyNextTierSummary, type LoyaltyReward, type LoyaltyRewardRecommendation, 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 NestedModifierSelection, type OAuthAuthorizeResponse, type OAuthCallbackResponse, type OAuthConnection, type OAuthConnectionsResponse, type OAuthErrorCode, 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 PaidMembershipInfo, 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 ProductReviewImage, type ProductReviewImageAdmin, type ProductSitemapOptions, type ProductStatus, type ProductSuggestion, type ProductUnavailableError, type ProductVariant, type PublicMetafieldDefinition, type PublicRegion, type PublicRegionDetail, type PublicRegionPaymentProvider, type PublicTaxClass, type PublishProductResponse, RTL_LOCALES, type RecommendationVariant, type ReconcileInventoryResponse, type RedeemRewardResult, type ReferralInfo, type Refund, type RefundLineItem, type RefundLineItemResponse, type RefundType, type Region, type RegionPaymentProvider, type RegisterCustomerDto, type ReissuedGiftCardAdmin, type RelativeDateBounds, type ReservationInfo, type ResolveMetafieldConflictDto as ResolveMetafieldConflictInput, type ResolveSyncConflictDto as ResolveSyncConflictInput, type ReturnLabelParcel, type ReviewPhotoUpload, type ReviewStatus, type RichTextContent, SDK_VERSION, type SavedPaymentMethodSummary, 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 SetTranslationFields, type ShippingDestinations, type ShippingLine, type ShippingRate, type ShippingRateConfig, type ShippingRateType, type ShippingSummaryEntry, type ShippingZone, type ShippingZoneQueryParams, type SitemapEntry, type StockAlertResponse, type StockAvailabilityRequest, type StockAvailabilityResponse, type StockAvailabilityResult, type StoreCapabilities, type StoreInfo, type StoreInvitation, type StoreInvitationDetails, type StoreMember, type StorePermission, type StoreRole, type StoreTeamResponse, type StoreTracking, type StorefrontSavedPaymentMethod, type SubmitProductReviewInput, type SubscribeMarketingInput, type SubscribeMarketingResponse, type SupportedLocaleObject, type SyncConflict, type SyncConflictResolution, type SyncJob, type Tag, type TaxBreakdown, type TaxBreakdownItem, type TaxClass, type TaxEstimateResponse, type TaxRate, type TaxonomyQueryParams, type TeamInvitation, type TeamInvitationsResponse, type TeamMember, type TeamMembersResponse, type TeamRole, type TrackingEventItem, type TrackingEventName, type TrackingEventPayload, type TranslatableEntityType, type TranslationStatusEntry, type TranslationsMap, 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 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 UpdateRegionDto, type UpdateShippingRateDto as UpdateShippingRateInput, type UpdateShippingZoneDto as UpdateShippingZoneInput, type UpdateStoreMemberDto as UpdateStoreMemberInput, type UpdateTagDto as UpdateTagInput, type UpdateTaxClassDto, type UpdateTaxRateDto as UpdateTaxRateInput, type UpdateVariantDto, type UpdateVariantInventoryDto, type UpsellSettings, 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 };