@lightspeed/ecom-headless 1.1.3 → 1.1.4-rc.1

package/dist/shared/{ecom-headless.BTRqua6N.d.ts → ecom-headless.BTXuBMcG.d.ts}

@@ -471,5 +471,5 @@ interface VisitorLocation {
     source: VisitorLocationSourceType;
 }
 
-export { CustomerCookieConsentValues as C, JsApiPageValues as J, LegalPageTypeValues as L, VisitorLocationSourceValues as V };
-export type { AddProductRecurringChargeSettings as A, BillingPerson as B, EcwidApiPromise as E, Order as O, RecurringChargeSettings as R, ShippingAddress as S, TrackingConsent as T, AddProductData as a, AddProductParameter as b, CartGetCallback as c, CartAddProductCallback as d, CartRemoveProductCallback as e, CartClearCallback as f, CartCalculateTotalCallback as g, CartGoToCheckoutCallback as h, CartApi as i, CartProduct as j, CartMediaItem as k, CartVideoInfo as l, CartImageBorderInfo as m, CartDominatingColor as n, CartItem as o, CartData as p, CustomerGetCallback as q, CustomerSignOutCallback as r, CustomerApi as s, CustomerData as t, JsApiPage as u, BaseJsApiPage as v, JsApiFilterParams as w, VisitorLocation as x, CustomerCookieConsentType as y };
+export { LegalPageTypeValues as L, CustomerCookieConsentValues as r, JsApiPageValues as w, VisitorLocationSourceValues as x };
+export type { AddProductData as A, BaseJsApiPage as B, CartAddProductCallback as C, EcwidApiPromise as E, JsApiFilterParams as J, Order as O, RecurringChargeSettings as R, ShippingAddress as S, TrackingConsent as T, VisitorLocation as V, AddProductParameter as a, AddProductRecurringChargeSettings as b, BillingPerson as c, CartApi as d, CartCalculateTotalCallback as e, CartClearCallback as f, CartData as g, CartDominatingColor as h, CartGetCallback as i, CartGoToCheckoutCallback as j, CartImageBorderInfo as k, CartItem as l, CartMediaItem as m, CartProduct as n, CartRemoveProductCallback as o, CartVideoInfo as p, CustomerApi as q, CustomerData as s, CustomerGetCallback as t, CustomerSignOutCallback as u, JsApiPage as v, CustomerCookieConsentType as y };

package/dist/shared/{ecom-headless.Bkwk1yoz.d.mts → ecom-headless.Bm1MKC5K.d.cts}

@@ -108,6 +108,12 @@ type SearchCategoriesResponse = PaginatedResponse<Category>;
  * @see {@link https://docs.ecwid.com/api-reference/rest-api/categories/search-categories#query-params | Ecwid API Documentation}
  */
 type SearchCategoriesParams = AsQueryParams<{
+    /**
+     * A keyword to search for in category names.
+     *
+     * @remarks
+     * If this field is specified, search result will contain only categories with names containing the specified keyword.
+     */
     keyword?: string;
     /**
      * Parent category ID.
@@ -124,29 +130,74 @@ type SearchCategoriesParams = AsQueryParams<{
      */
     parentIds?: string;
     /**
-     * Set `true` to receive full categories structure (subcategories of subcategories, etc.)
+     * Flag indicating whether only direct or all descendants should be included in response.
      *
      * @remarks
-     * If `false` or not specified, only direct descendants of specified category IDs from `parent` and `parentIds` parameters are returned.
+     * - `false` (default): only direct descendants of categories in `parent` and `parentIds` parameters are returned.
+     * - `true`: all descendants of categories in `parent` and `parentIds` parameters are returned (full categories structure).
      */
     withSubcategories?: boolean;
-    /** Set `true` to include disabled categories. */
+    /**
+     * Set `true` to include disabled categories in the response.
+     *
+     * @remarks
+     * If `false` or not specified, only enabled categories are returned.
+     */
     hidden_categories?: boolean;
     /**
-     * Offset from the beginning of the returned items list.
-     * Used when the response contains more items than `limit` allows to receive in one request.
+     * List of category identifiers.
+     *
+     * @remarks
+     * If this field is specified, search result will contain only categories with identifiers from the specified list.
+     *
+     * @example "123,456,789"
      */
-    offset?: number;
+    categoryIds?: string;
+    /**
+     * Set `true` to include product IDs list for each category.
+     *
+     * @remarks
+     * If `true`, each category in the response will contain a list of product identifiers that belong to it.
+     *
+     * @default false
+     */
+    productIds?: boolean;
+    /**
+     * Set `true` to fetch enabled products count for each category.
+     *
+     * @remarks
+     * If `true`, each category in the response will include the count of enabled products.
+     *
+     * @default false
+     */
+    fetchEnabledProductsCount?: boolean;
+    /**
+     * Country code for serving statics from the correct CDN.
+     *
+     * @example "US", "GB", "FR"
+     */
+    countryCode?: string;
     /**
      * Limit to the number of returned items.
-     * Maximum and default value (if not specified) is 100.
+     *
+     * @remarks
+     * Maximum and default value (if not specified) is `100`.
      */
     limit?: number;
     /**
-     * Language ISO code for translations in JSON response, e.g. `en`, `fr`.
+     * Offset from the beginning of the returned items list.
      *
      * @remarks
-     * If not specified, the default store language is used.
+     * Used when the response contains more items than `limit` allows to receive in one request.
+     */
+    offset?: number;
+    /**
+     * The language in which to get the translation of the entity.
+     *
+     * @remarks
+     * Language ISO code for translations in JSON response. If not specified, the default store language is used.
+     *
+     * @example "en", "nl", "fr"
      */
     lang?: string;
     /**
@@ -170,9 +221,23 @@ type SearchCategoriesByPathResponse = PaginatedResponse<Category>;
  * @see {@link https://docs.ecwid.com/api-reference/rest-api/categories/search-categories-by-path#query-params | Ecwid API Documentation}
  */
 type SearchCategoriesByPathParams = AsQueryParams<{
-    /** Full path separated by a delimiter. Spaces around the delimiter and empty path elements are ignored. */
+    /**
+     * Full path to the category being searched.
+     *
+     * @remarks
+     * Spaces around the delimiter and empty path elements are ignored.
+     *
+     * @example "Electronics/Computers/Laptops"
+     */
     path: string;
-    /** A string of 1 or more characters used as a path delimiter. */
+    /**
+     * Delimiter used to separate path elements.
+     *
+     * @remarks
+     * A string of 1 or more characters used as a path delimiter.
+     *
+     * @example "/", ">", " > "
+     */
     delimiter: string;
     /** Search term for category name and description. */
     keyword?: string;
@@ -204,20 +269,32 @@ type SearchCategoriesByPathParams = AsQueryParams<{
      * If not specified, Ecwid checks URL settings automatically and responds with matching URLs. */
     slugsWithoutIds?: boolean;
     /**
-     * Offset from the beginning of the returned items list.
-     * Used when the response contains more items than `limit` allows to receive in one request.
+     * Country code for serving statics from the correct CDN.
+     *
+     * @example "US", "GB", "FR"
      */
-    offset?: number;
+    countryCode?: string;
     /**
      * Limit to the number of returned items.
-     * Maximum and default value (if not specified) is 100.
+     *
+     * @remarks
+     * Maximum and default value (if not specified) is `100`.
      */
     limit?: number;
     /**
-     * Language ISO code for translations in JSON response, e.g. `en`, `fr`.
+     * Offset from the beginning of the returned items list.
      *
      * @remarks
-     * If not specified, the default store language is used.
+     * Used when the response contains more items than `limit` allows to receive in one request.
+     */
+    offset?: number;
+    /**
+     * The language in which to get the translation of the entity.
+     *
+     * @remarks
+     * Language ISO code for translations in JSON response. If not specified, the default store language is used.
+     *
+     * @example "en", "nl", "fr"
      */
     lang?: string;
     /**
@@ -1299,6 +1376,18 @@ type SearchProductsParams = AsQueryParams<{
      * Set `outofstock` to get only out-of-stock products.
      */
     inventory?: 'instock' | 'outofstock';
+    /**
+     * Country code to be used for tax calculation.
+     *
+     * @example "US"
+     */
+    countryCode?: string;
+    /**
+     * State or province code to be used for tax calculation.
+     *
+     * @example "NY"
+     */
+    stateOrProvinceCode?: string;
     /**
      * Set base URL for URLs in response.
      * If not specified, Ecwid will use the main URL from store settings.
@@ -1332,6 +1421,13 @@ type SearchProductsParams = AsQueryParams<{
      * Find tax classes and their codes in the {@link https://docs.ecwid.com/api-reference/rest-api/dictionaries/tax-classes-by-country | Tax classes by country}.
      */
     taxClassCodes?: string;
+    /**
+     * Set `true` to search for products that belong only to the basic category and not to any other.
+     *
+     * @remarks
+     * When set to `true`, returns products that are not assigned to any category except the root category.
+     */
+    uncategorized?: boolean;
     /**
      * Limit to the number of returned items.
      *
@@ -1352,6 +1448,15 @@ type SearchProductsParams = AsQueryParams<{
      * @example "total,items(id,name,price,quantity)"
      */
     responseFields?: string;
+    /**
+     * The language in which to get the translation of the entity.
+     *
+     * @remarks
+     * Supports any language enabled in the store. If not specified, the default store language is used.
+     *
+     * @example "en", "nl", "fr"
+     */
+    lang?: string;
     /**
      * Filter by product option name and one or several comma-separated values for that option.
      * A product will appear in the response if it has an option with a specified name that has any of the specified values.
@@ -1383,19 +1488,37 @@ type GetProductResponse = Product;
  * @see {@link https://docs.ecwid.com/api-reference/rest-api/products/get-product#query-params | Ecwid API Documentation}
  */
 type GetProductParams = AsQueryParams<{
-    /** Internal product ID. */
+    /**
+     * Internal product ID.
+     *
+     * @remarks
+     * The identifier of the requested product.
+     */
     productId: number;
     /**
-     * Set base URL for links in response.
+     * Country code to be used for tax calculation.
+     *
+     * @example "US", "GB", "FR"
+     */
+    countryCode?: string;
+    /**
+     * State or province code to be used for tax calculation.
+     *
+     * @example "NY", "CA"
+     */
+    stateOrProvinceCode?: string;
+    /**
+     * Set base URL for product links in response.
      *
      * @remarks
      * If not specified, Ecwid will use the main URL from store settings.
      */
     baseUrl?: string;
     /**
-     * Set to `true` to force receiving clean URLs – catalog links without hashbang (`/#!/`).
+     * Set to `true` to generate SEO-friendly URLs.
      *
      * @remarks
+     * If `true`, forces receiving clean URLs – catalog links without hashbang (`/#!/`).
      * By default Ecwid checks if this setting is enabled for the store and responds with matching URLs.
      */
     cleanUrls?: boolean;
@@ -1406,10 +1529,12 @@ type GetProductParams = AsQueryParams<{
      */
     slugsWithoutIds?: boolean;
     /**
-     * Language ISO code for translations in JSON response, e.g. `en`, `fr`.
+     * The language in which to get the translation of the entity.
      *
      * @remarks
-     * If not specified, the default store language is used.
+     * Language ISO code for translations in JSON response. If not specified, the default store language is used.
+     *
+     * @example "en", "nl", "fr"
      */
     lang?: string;
     /**
@@ -1547,34 +1672,52 @@ type SearchProductBrandsParams = AsQueryParams<{
      * Used when the response contains more items than {@link limit} allows to receive in one request.
      */
     offset?: number;
-    /** Sorting order for the results. */
-    sortBy?: 'PRODUCT_COUNT_DESC' | 'PRODUCT_COUNT_ASC' | 'NAME_DESC' | 'NAME_ASC';
     /**
-     * Defines if the response should contain brands of disabled products.
-     * Set `true` to get such brands.
+     * Sort order for the results.
+     *
+     * @remarks
+     * Supported values:
+     * - `NAME_ASC` - sort by name (ascending)
+     * - `NAME_DESC` - sort by name (descending)
+     * - `PRODUCT_COUNT_ASC` - sort by product count (ascending)
+     * - `PRODUCT_COUNT_DESC` - sort by product count (descending)
      *
-     * Default value: `false`
+     * @default "PRODUCT_COUNT_DESC"
      */
-    hidden_brands?: boolean;
+    sortBy?: 'PRODUCT_COUNT_DESC' | 'PRODUCT_COUNT_ASC' | 'NAME_DESC' | 'NAME_ASC';
     /**
-     * Language ISO code for translations in JSON response, e.g. `en`, `fr`.
+     * Set `true` to include brands that have no products.
      *
      * @remarks
-     * If not specified, the default store language is used.
+     * Flag indicating whether to return brands without products in the response.
+     *
+     * @default false
      */
-    lang?: string;
+    hidden_brands?: boolean;
     /**
-     * Set base URL for URLs in response.
+     * Set base URL for storefront URLs in the returned brands.
      *
      * @remarks
-     * If not specified, Ecwid will use the main URL from store settings. */
+     * If not specified, Ecwid will use the main URL from store settings.
+     */
     baseUrl?: string;
     /**
-     * Set `true` to force receiving clean URLs – catalog links without hashbang (/#!/).
+     * Set `true` to return SEO-friendly URLs.
      *
+     * @remarks
+     * If `true`, forces receiving clean URLs – catalog links without hashbang (/#!/).
      * By default Ecwid checks if this setting is enabled for the store and responds with matching URLs.
      */
     cleanURLs?: boolean;
+    /**
+     * The language in which to get the translation of the entity.
+     *
+     * @remarks
+     * Language ISO code for translations in JSON response. If not specified, the default store language is used.
+     *
+     * @example "en", "nl", "fr"
+     */
+    lang?: string;
 }>;
 
 /**
@@ -2841,10 +2984,42 @@ type GetStoreProfileParams = AsQueryParams<{
      */
     showExtendedInfo?: boolean;
     /**
-     * Language ISO code for translations in JSON response, e.g. `en`, `fr`.
+     * Set `true` to include `externalStoreIp` in the response.
      *
      * @remarks
-     * If not specified, the default store language is used.
+     * If `true`, the response will contain the external store IP address.
+     */
+    withExternalStoreIp?: boolean;
+    /**
+     * Set `true` to include `lastLoginIp` in the response.
+     *
+     * @remarks
+     * If `true`, the response will contain the last login IP address.
+     */
+    withLastLoginIp?: boolean;
+    /**
+     * Set `true` to include `channelId` in the response.
+     *
+     * @remarks
+     * If `true`, the response will contain the channel ID.
+     */
+    withChannelId?: boolean;
+    /**
+     * Set `true` to include `reportAvailabilityDetails` in `accountInfo` in the response.
+     *
+     * @remarks
+     * If `true`, returns report availability status details in the account information.
+     *
+     * @default false
+     */
+    getReportAvailabilityStatus?: boolean;
+    /**
+     * The language in which to get the translation of the entity.
+     *
+     * @remarks
+     * Language ISO code for translations in JSON response. If not specified, the default store language is used.
+     *
+     * @example "en", "nl", "fr"
      */
     lang?: string;
     /**
@@ -2871,5 +3046,5 @@ interface ApiConfig {
     baseURL?: string;
 }
 
-export { SortByValues as S };
-export type { SearchProductBrandsParams as $, ProductRelatedCategory as A, ProductRelatedProducts as B, Category as C, ProductShipping as D, ProductRecurringChargeSettings as E, ProductSubscriptionSettings as F, ProductTax as G, ProductType as H, Product as I, SearchProductsResponse as J, SearchProductsParams as K, LowestPriceSettings as L, GetProductResponse as M, GetProductParams as N, DownloadProductFileResponse as O, ProductAttributeVisibility as P, DownloadProductFileParams as Q, SearchProductVariationsResponse as R, SearchProductVariationsParams as T, GetProductVariationResponse as U, GetProductVariationParams as V, WholesalePrice as W, SearchProductTypesResponse as X, GetProductTypeResponse as Y, GetProductTypeParams as Z, SearchProductBrandsResponse as _, CategoryImage as a, SupportedPaymentMethodsStatuses as a$, GetReviewsResponse as a0, GetReviewsParams as a1, PaginatedResponse as a2, QueryParams as a3, AsQueryParams as a4, Translations as a5, Account as a6, LimitsAndRestrictions as a7, AccountBilling as a8, BusinessRegistrationID as a9, PhoneNotifications as aA, FilterSection as aB, ProductFiltersSettings as aC, FlatRate as aD, RatesTable as aE, Rates as aF, RateCondition as aG, Rate as aH, RegistrationAnswers as aI, SalePrice as aJ, HandlingFee as aK, CarrierMethod as aL, PostageDimensions as aM, CarrierSettings as aN, BusinessHours as aO, BlackoutDates as aP, ShippingOption as aQ, Shipping as aR, GeoPolygon as aS, StoreZone as aT, SocialLink as aU, SocialLinksSettings as aV, StarterSite as aW, StoreProfile as aX, AbandonedSales as aY, StoreSettings as aZ, RecurringSubscriptionsSettings as a_, Company as aa, DesignSettings as ab, FbMessengerSettings as ac, FeatureToggle as ad, AddressFormat as ae, FormatsAndUnits as af, GeneralInfo as ag, GiftCardProduct as ah, GiftCardSettings as ai, Languages as aj, LegalPage as ak, LegalPagesSettings as al, MailNotificationsSettings as am, CustomerMarketingMessages as an, AdminMessages as ao, CustomerOrderMessages as ap, MailNotifications as aq, MailchimpSettings as ar, OrderInvoiceSettings as as, PaymentShippingSettings as at, InstructionsForCustomer as au, PaymentSurcharge as av, PaymentOption as aw, ApplePay as ax, ApplePayOptions as ay, Payment as az, CategoryImageAlt as b, TaxRule as b0, Tax as b1, TaxSettings as b2, CustomTipSettings as b3, TipsSettings as b4, GetStoreProfileResponse as b5, GetStoreProfileParams as b6, ApiConfig as b7, SearchCategoriesResponse as c, SearchCategoriesParams as d, SearchCategoriesByPathResponse as e, SearchCategoriesByPathParams as f, ProductAttributeType as g, ProductAttribute as h, ProductBrand as i, ProductCategory as j, ProductCombinationOption as k, ProductCombination as l, ProductCompositeComponent as m, ProductDimensions as n, ProductFavorites as o, ProductFile as p, ProductDominatingColor as q, ProductBorderInfo as r, ProductGalleryImage as s, ProductImage as t, ProductImageAlt as u, ProductMediaImage as v, ProductMediaVideo as w, ProductMedia as x, ProductOptionChoice as y, ProductOption as z };
+export { SortByValues as aY };
+export type { OrderInvoiceSettings as $, AbandonedSales as A, BlackoutDates as B, CarrierMethod as C, DesignSettings as D, GetProductResponse as E, FbMessengerSettings as F, GeneralInfo as G, GetProductTypeParams as H, GetProductTypeResponse as I, GetProductVariationParams as J, GetProductVariationResponse as K, GetReviewsParams as L, GetReviewsResponse as M, GetStoreProfileParams as N, GetStoreProfileResponse as O, GiftCardProduct as P, GiftCardSettings as Q, HandlingFee as R, InstructionsForCustomer as S, Languages as T, LegalPage as U, LegalPagesSettings as V, LimitsAndRestrictions as W, LowestPriceSettings as X, MailNotifications as Y, MailNotificationsSettings as Z, MailchimpSettings as _, Account as a, StoreSettings as a$, PaginatedResponse as a0, Payment as a1, PaymentOption as a2, PaymentShippingSettings as a3, PaymentSurcharge as a4, PhoneNotifications as a5, PostageDimensions as a6, Product as a7, ProductAttribute as a8, ProductAttributeType as a9, ProductType as aA, QueryParams as aB, Rate as aC, RateCondition as aD, Rates as aE, RatesTable as aF, RecurringSubscriptionsSettings as aG, RegistrationAnswers as aH, SalePrice as aI, SearchCategoriesByPathParams as aJ, SearchCategoriesByPathResponse as aK, SearchCategoriesParams as aL, SearchCategoriesResponse as aM, SearchProductBrandsParams as aN, SearchProductBrandsResponse as aO, SearchProductTypesResponse as aP, SearchProductVariationsParams as aQ, SearchProductVariationsResponse as aR, SearchProductsParams as aS, SearchProductsResponse as aT, Shipping as aU, ShippingOption as aV, SocialLink as aW, SocialLinksSettings as aX, StarterSite as aZ, StoreProfile as a_, ProductAttributeVisibility as aa, ProductBorderInfo as ab, ProductBrand as ac, ProductCategory as ad, ProductCombination as ae, ProductCombinationOption as af, ProductCompositeComponent as ag, ProductDimensions as ah, ProductDominatingColor as ai, ProductFavorites as aj, ProductFile as ak, ProductFiltersSettings as al, ProductGalleryImage as am, ProductImage as an, ProductImageAlt as ao, ProductMedia as ap, ProductMediaImage as aq, ProductMediaVideo as ar, ProductOption as as, ProductOptionChoice as at, ProductRecurringChargeSettings as au, ProductRelatedCategory as av, ProductRelatedProducts as aw, ProductShipping as ax, ProductSubscriptionSettings as ay, ProductTax as az, AccountBilling as b, StoreZone as b0, SupportedPaymentMethodsStatuses as b1, Tax as b2, TaxRule as b3, TaxSettings as b4, TipsSettings as b5, Translations as b6, WholesalePrice as b7, AddressFormat as c, AdminMessages as d, ApiConfig as e, ApplePay as f, ApplePayOptions as g, AsQueryParams as h, BusinessHours as i, BusinessRegistrationID as j, CarrierSettings as k, Category as l, CategoryImage as m, CategoryImageAlt as n, Company as o, CustomTipSettings as p, CustomerMarketingMessages as q, CustomerOrderMessages as r, DownloadProductFileParams as s, DownloadProductFileResponse as t, FeatureToggle as u, FilterSection as v, FlatRate as w, FormatsAndUnits as x, GeoPolygon as y, GetProductParams as z };