@scayle/storefront-core 7.22.1

package/dist/types/bapi/order.d.ts

@@ -0,0 +1,554 @@
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+export type TimestampOfOrderConfirmation = string;
+export type ThisFieldRepresentsTheAdditionalFeesExcludingTheTaxes = number;
+export type ThisFieldRepresentsTheAdditionalFeesIncludingTheTaxes = number;
+export type TheIncludedVATAmount = number;
+export type TheIncludedVATRateInPercentAsIntegerRepresentation = number;
+export type ThisFieldRepresentsTheDiscountAmountIncludingTheTaxes = number;
+export type AbsoluteValueOfTheAppliedTax = number;
+/**
+ * This price excludes taxes, but also includes all applicable reductions.
+ */
+export type ItemPriceExcludingTaxes = number;
+/**
+ * The price is calculated including taxes and all applicable reductions such as discounts for sale and campaigns (should a campaign key be provdided on the request).
+ */
+export type ItemPriceIncludingTaxes = number;
+/**
+ * The three character [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code that identifies the currency. The currency is defined on the configuration of the shop, and can be modified in the cloud panel.
+ */
+export type CharacterCurrencyCode = string;
+export type UniqueIdentifierOfTheState = string;
+export type NameOfTheState = string;
+export type UniqueIdentifierOfTheState1 = string;
+export type NameOfTheState1 = string;
+export type UniqueIdentifierOfTheState2 = string;
+export type NameOfTheState2 = string;
+export type TimestampOfOrderInvoice = string;
+export type UniqueNumericIdentifierOfTheItem = number;
+/**
+ * The number of deliverable items available in the warehouse for immediate shipping.
+ */
+export type AvailableQuantityInTheWarehouse = number;
+/**
+ * The three character [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code that identifies the currency. The currency is defined on the configuration of the shop, and can be modified in the cloud panel.
+ */
+export type CharacterCurrencyCode1 = string;
+/**
+ * Whether the return shipment got triggered manually. Is missing in case there is no return shipment.
+ */
+export type TheReturnShipmentHasBeenTriggeredByCCI = boolean;
+export type UniqueIdentifierOfTheItem = string;
+/**
+ * Items are grouped by package, depending on the item's supplier configuration. The `packageId` references an entry in the packages list with delivery estimates and expected carrier.
+ */
+export type PackageReference = number;
+export type ThisFieldRepresentsTheDiscountAmountIncludingTheTaxes1 = number;
+export type AbsoluteValueOfTheAppliedTax1 = number;
+export type RelativeValueOfTheAppliedTax = number;
+export type UndiscountedItemPriceExcludingTaxes = number;
+export type UndiscountedItemPriceIncludingTaxes = number;
+/**
+ * This price excludes taxes, but also includes all applicable reductions.
+ */
+export type ItemPriceExcludingTaxes1 = number;
+/**
+ * The price is calculated including taxes and all applicable reductions such as discounts for sale and campaigns (should a campaign key be provdided on the request).
+ */
+export type ItemPriceIncludingTaxes1 = number;
+/**
+ * the warehouse id where the item are being picking from.
+ */
+export type PickingWarehouseId = null | number;
+/**
+ * The package identification inside of the warehouse.
+ */
+export type WarehousePackageReference = null | number;
+export type TimestampOfItemCreation = string;
+export type TimestampOfLastItemUpdate = string;
+/**
+ * Basket and order items are matched to a package by cross-referencing the `item[].packageId`.
+ */
+export type ReferenceByWhichThePackageIsIdentified = number;
+export type CarrierShippingTheItem = string;
+export type LatestExpectedDeliveryDate = string;
+export type EarliestExpectedDeliveryDate = string;
+export type ReturnIdentCodeOfTheItem = null | string;
+export type ShipmentKeyOfTheItem = string;
+/**
+ * The distribution of items across packages is calculated based on the supplierId. Once shipments are processed, the packages may be updated to reflect the actual shipments.
+ */
+export type ListOfPackages = {
+    id: ReferenceByWhichThePackageIsIdentified;
+    carrierKey: CarrierShippingTheItem;
+    /**
+     * The delivery dates are calculated based on the hour-to-hour estimates configured per supplier in the cloud panel. Once the order has been confirmed and shipments have been received, the calculation is based on the warehouse cut-off times and transport duration. If the carrier provides a delivery estimate, this is applied.
+     */
+    deliveryDate: {
+        maximum: LatestExpectedDeliveryDate;
+        minimum: EarliestExpectedDeliveryDate;
+    };
+    deliveryStatus: 'open' | 'shipment_pending' | 'delegation_pending' | 'shipment_completed' | 'cancellation_completed';
+    returnIdentCode?: ReturnIdentCodeOfTheItem;
+    shipmentKey?: ShipmentKeyOfTheItem;
+    tracking?: {
+        id?: string;
+        url?: string;
+    };
+}[];
+export type WhetherThePaymentMethodIsAGiftCard = boolean;
+export type NumberOfInstallmentsChosenByTheCustomerForTheOrder = number;
+export type IfTrueTheCustomerElectedToHaveADelayInPaymentCapture = boolean;
+export type TimestampOfOrderCreation = string;
+export type TimestampOfLastOrderUpdate = string;
+export interface Order {
+    /**
+     * This `id` can be applied as a parameter on the url to retrieve an individual order in the [Fetch Order by ID](#fetch-order-by-id) endpoint.
+     */
+    id: number;
+    address?: {
+        billing: {
+            id: number;
+            /**
+             * Additional data pertaining to the address, such as `c/o AboutYou`.
+             */
+            additional?: string;
+            city: string;
+            /**
+             * A collection point is an alternate shipping address, which will hold the customer's packages until pickup. Examples for collection points are DHL Packstations, DHL Post Offices and Hermes Paketshops.
+             */
+            collectionPoint?: {
+                customerKey?: string;
+                description?: string;
+                key: string;
+                type: ('hermes_parcelshop' | 'dhl_packstation' | 'dhl_postoffice' | 'postsk_postoffice' | 'postsk_parcelbox' | 'gls_postoffice' | 'gls_packstation' | 'gls_parcelshop' | 'post_office' | 'postsi_postoffice' | 'postsi_packstation' | 'omniva_parcel_shop' | 'omniva_packstation' | 'offline-store' | 'fastwayie_packstation' | 'fastwayie_parcelshop' | 'generic' | 'packstation' | 'parcel_shop' | 'posteitaliane_packstation' | 'posteitaliane_parcelshop' | 'postifi_packstation' | 'postifi_parcelshop' | 'zasilcz_parcelshop' | 'zasilcz_packstation' | 'reba_packstation' | 'reba_parcel_shop') | string;
+            };
+            countryCode: string;
+            houseNumber?: string;
+            isBillingAddress?: boolean;
+            isDefault: {
+                billing: boolean;
+                shipping: boolean;
+            };
+            isShippingAddress?: boolean;
+            recipient: {
+                firstName?: string;
+                gender?: 'm' | 'f' | 'd';
+                lastName: string;
+                title?: null | string;
+                type: 'personal' | 'retail' | 'organization' | 'family';
+            };
+            /**
+             * External reference set by the client to integrate a 3rd party system
+             */
+            referenceKey?: string;
+            street: string;
+            zipCode: string;
+            createdAt: string;
+            updatedAt: string;
+        };
+        forward?: {
+            /**
+             * Additional data pertaining to the address, such as `c/o AboutYou`.
+             */
+            additional?: string;
+            city?: string;
+            /**
+             * A collection point is an alternate shipping address, which will hold the customer's packages until pickup. Examples for collection points are DHL Packstations, DHL Post Offices and Hermes Paketshops.
+             */
+            collectionPoint?: {
+                customerKey?: string;
+                description?: string;
+                key?: string;
+                type?: ('hermes_parcelshop' | 'dhl_packstation' | 'dhl_postoffice' | 'postsk_postoffice' | 'postsk_parcelbox' | 'gls_postoffice' | 'gls_packstation' | 'gls_parcelshop' | 'post_office' | 'postsi_postoffice' | 'postsi_packstation' | 'omniva_parcel_shop' | 'omniva_packstation' | 'offline-store' | 'fastwayie_packstation' | 'fastwayie_parcelshop' | 'generic' | 'packstation' | 'parcel_shop' | 'posteitaliane_packstation' | 'posteitaliane_parcelshop' | 'postifi_packstation' | 'postifi_parcelshop' | 'zasilcz_parcelshop' | 'zasilcz_packstation' | 'reba_packstation' | 'reba_parcel_shop') | string;
+            };
+            countryCode?: string;
+            houseNumber?: string;
+            recipient?: {
+                firstName?: string;
+                gender?: 'm' | 'f' | 'd';
+                lastName?: string;
+                title?: null | string;
+                type?: 'personal' | 'retail' | 'organization' | 'family';
+            };
+            street?: string;
+            zipCode?: string;
+            createdAt?: string;
+            updatedAt?: string;
+        };
+        shipping: {
+            id: number;
+            /**
+             * Additional data pertaining to the address, such as `c/o AboutYou`.
+             */
+            additional?: string;
+            city: string;
+            /**
+             * A collection point is an alternate shipping address, which will hold the customer's packages until pickup. Examples for collection points are DHL Packstations, DHL Post Offices and Hermes Paketshops.
+             */
+            collectionPoint?: {
+                customerKey?: string;
+                description?: string;
+                key: string;
+                type: ('hermes_parcelshop' | 'dhl_packstation' | 'dhl_postoffice' | 'postsk_postoffice' | 'postsk_parcelbox' | 'gls_postoffice' | 'gls_packstation' | 'gls_parcelshop' | 'post_office' | 'postsi_postoffice' | 'postsi_packstation' | 'omniva_parcel_shop' | 'omniva_packstation' | 'offline-store' | 'fastwayie_packstation' | 'fastwayie_parcelshop' | 'generic' | 'packstation' | 'parcel_shop' | 'posteitaliane_packstation' | 'posteitaliane_parcelshop' | 'postifi_packstation' | 'postifi_parcelshop' | 'zasilcz_parcelshop' | 'zasilcz_packstation' | 'reba_packstation' | 'reba_parcel_shop') | string;
+            };
+            countryCode: string;
+            houseNumber?: string;
+            isBillingAddress?: boolean;
+            isDefault: {
+                billing: boolean;
+                shipping: boolean;
+            };
+            isShippingAddress?: boolean;
+            recipient: {
+                firstName?: string;
+                gender?: 'm' | 'f' | 'd';
+                lastName: string;
+                title?: null | string;
+                type: 'personal' | 'retail' | 'organization' | 'family';
+            };
+            /**
+             * External reference set by the client to integrate a 3rd party system
+             */
+            referenceKey?: string;
+            street: string;
+            zipCode: string;
+            createdAt: string;
+            updatedAt: string;
+        };
+    };
+    /**
+     * Reference to the basket attached to this order
+     */
+    basketKey: string;
+    /**
+     * Reference to the campaign applied to this order
+     */
+    campaignKey?: string;
+    confirmedAt?: TimestampOfOrderConfirmation;
+    contacts?: {
+        type?: string;
+        value?: string;
+    }[];
+    /**
+     * The price is provided in a currency's lowest denomination (e.g. cent for EUR). In a multi-supplier environment, the price displayed on an item is dictated by the supplier order of preference, which is configured in the cloud panel.
+     */
+    cost: {
+        /**
+         * The `appliedFees` detail the additional payment and delivery costs included in the final `price.withTax` and `price.withoutTax` calculation.
+         */
+        appliedFees?: {
+            amount: {
+                withoutTax: ThisFieldRepresentsTheAdditionalFeesExcludingTheTaxes;
+                withTax: ThisFieldRepresentsTheAdditionalFeesIncludingTheTaxes;
+            };
+            category: 'payment' | 'delivery' | 'percentage_payment' | 'return';
+            key: string;
+            option?: string;
+            tax?: {
+                vat: ThisFieldHoldsDetailsAboutTheIncludedVATTax;
+            };
+        }[];
+        /**
+         * The discounts detail the reductions included in the final `price.withTax` and `price.withoutTax` calculation.
+         */
+        appliedReductions?: {
+            amount: {
+                absoluteWithTax: ThisFieldRepresentsTheDiscountAmountIncludingTheTaxes;
+                /**
+                 * The `rate` is calculated on the basis of the reduction in relation to the `preDiscountPrice` price.
+                 */
+                relative: number;
+            };
+            category: 'voucher';
+            code?: string;
+            type: 'absolute';
+        }[];
+        itemGroups?: {
+            /**
+             * This interface was referenced by `undefined`'s JSON-Schema definition
+             * via the `patternProperty` "^[a-zA-Z0-9]+$".
+             */
+            [k: string]: {
+                brutto: number;
+                bruttoDiscount: number;
+                bruttoDiscountWithoutMainProduct: number;
+                bruttoWithoutMainProduct: number;
+                netto: number;
+                nettoWithoutMainProduct: number;
+                tax: number;
+                taxWithoutMainProduct: number;
+            };
+        } | null;
+        tax: {
+            /**
+             * List of all taxes applied in calculating the `price.withTax`
+             */
+            vat?: {
+                amount: AbsoluteValueOfTheAppliedTax;
+            };
+        };
+        withoutTax: ItemPriceExcludingTaxes;
+        withTax: ItemPriceIncludingTaxes;
+    };
+    currencyCode: CharacterCurrencyCode;
+    customData?: {
+        score?: {
+            [k: string]: unknown;
+        } | string | number | unknown[] | boolean;
+        [k: string]: unknown;
+    };
+    customer?: {
+        id: number;
+        authentication?: {
+            data?: {
+                accessToken?: string;
+                userId?: string;
+            };
+            type: 'facebook' | 'password' | 'apple' | 'keycloak';
+        };
+        birthDate?: string;
+        /**
+         * Additional data attached by the client to enhance the customer
+         */
+        customData?: {
+            score?: {
+                [k: string]: unknown;
+            } | string | number | unknown[] | boolean;
+            [k: string]: unknown;
+        };
+        email?: string;
+        firstName?: string;
+        gender?: 'm' | 'f' | 'd';
+        groups?: string[];
+        ipAddress?: string;
+        lastName: string;
+        phone?: string;
+        /**
+         * Public reference set by the client to display to customers in account areas and transactional emails
+         */
+        publicKey?: string;
+        /**
+         * External reference set by the client to integrate a 3rd party system
+         */
+        referenceKey?: string;
+        status: {
+            isActive: boolean;
+            isGuestCustomer: boolean;
+            isTestCustomer: boolean;
+        };
+        title?: null | string;
+        type: 'personal' | 'retail' | 'organization' | 'family';
+        userAgent?: string;
+        createdAt: string;
+        updatedAt: string;
+    };
+    detailedStatus: {
+        billing: {
+            code: UniqueIdentifierOfTheState;
+            name: NameOfTheState;
+            [k: string]: unknown;
+        };
+        order: {
+            code: UniqueIdentifierOfTheState1;
+            name: NameOfTheState1;
+            [k: string]: unknown;
+        };
+        shipping: {
+            code: UniqueIdentifierOfTheState2;
+            name: NameOfTheState2;
+            [k: string]: unknown;
+        };
+        [k: string]: unknown;
+    };
+    invoicedAt?: TimestampOfOrderInvoice;
+    items?: {
+        id?: UniqueNumericIdentifierOfTheItem;
+        availableQuantity?: AvailableQuantityInTheWarehouse;
+        currency?: CharacterCurrencyCode1;
+        /**
+         * customData allows the tenant to attach data to an item. The data will remain attached to the item from the basket through the process of order creation and delegation and may be displayed to the customer during the order lifecycle.
+         */
+        customData?: {
+            [k: string]: unknown;
+        };
+        deliveryForecast?: DeliveryForecastFromWarehouse;
+        isManuallyReturnedByCci?: TheReturnShipmentHasBeenTriggeredByCCI;
+        itemGroup?: null | {
+            /**
+             * Item group ID
+             */
+            id: string;
+            /**
+             * Specifies the main item in the group (true for only one item in a group)
+             */
+            isMainItem: boolean;
+            /**
+             * Specifies if the item is mandatory or optional
+             */
+            isRequired: boolean;
+        };
+        key: UniqueIdentifierOfTheItem;
+        lowestPriorPrice?: null | {
+            /**
+             * Difference to the current price
+             */
+            relativeDifferenceToPrice: number;
+            /**
+             * Lowest price including taxes
+             */
+            withTax: number;
+        };
+        /**
+         * the merchant id to which the item belongs.
+         */
+        merchant?: {
+            id: number;
+            [k: string]: unknown;
+        };
+        packageId: PackageReference;
+        /**
+         * The price is provided in a currency's lowest denomination (e.g. cent for EUR). In a multi-supplier environment, the price displayed on an item is dictated by the supplier order of preference, which is configured in the cloud panel.
+         */
+        price: {
+            /**
+             * The discounts detail the reductions included in the final `price.withTax` and `price.withoutTax` calculation.
+             */
+            appliedReductions?: {
+                amount: {
+                    absoluteWithTax: ThisFieldRepresentsTheDiscountAmountIncludingTheTaxes1;
+                    /**
+                     * The `rate` is calculated on the basis of the reduction in relation to the `preDiscountPrice` price.
+                     */
+                    relative: number;
+                };
+                category: 'sale' | 'campaign' | 'voucher';
+                code?: string;
+                type: 'relative' | 'absolute';
+            }[];
+            overrideWithoutTax?: number;
+            overrideWithTax?: number;
+            reference?: {
+                size?: string;
+                unit?: string;
+                withTax?: number;
+            };
+            /**
+             * List of all taxes applied in calculating the `price.withTax`
+             */
+            tax: {
+                [k: string]: {
+                    amount: AbsoluteValueOfTheAppliedTax1;
+                    rate: RelativeValueOfTheAppliedTax;
+                };
+            };
+            undiscountedWithOutTax?: UndiscountedItemPriceExcludingTaxes;
+            undiscountedWithTax?: UndiscountedItemPriceIncludingTaxes;
+            withoutTax: ItemPriceExcludingTaxes1;
+            withTax: ItemPriceIncludingTaxes1;
+        };
+        product: {
+            [k: string]: unknown;
+        };
+        /**
+         * Reference set in the checkout when an item was reserved successfully.
+         */
+        reservationKey?: string;
+        status: 'available' | 'cancelled' | 'delivered' | 'returned' | 'unavailable';
+        variant: {
+            [k: string]: unknown;
+        };
+        warehouseId?: PickingWarehouseId;
+        warehousePackageGroupId?: WarehousePackageReference;
+        createdAt: TimestampOfItemCreation;
+        updatedAt: TimestampOfLastItemUpdate;
+    }[];
+    loyaltyCard?: {
+        cardNumber?: string;
+        points: number;
+        provider: string;
+    };
+    packages?: ListOfPackages;
+    payment?: {
+        amount?: number;
+        /**
+         * The `data` attribute will contain the data pushed to the Checkout by the Payment Provider in use (or internally generated, should the payment not be provided by an external PSP). This object's structure depends on the PSP itself, however, it will contain the minimum dataset necessary for further processing of the Order.
+         */
+        data?: {
+            [k: string]: unknown;
+        };
+        /**
+         * Details about installments, included as a listing of the values involved in the Installments transaction.
+         */
+        installment?: {
+            amount?: number;
+            type?: 'annualInterest' | 'firstInstallment' | 'subsequentInstallments';
+        }[];
+        isGiftCard?: WhetherThePaymentMethodIsAGiftCard;
+        key?: string;
+        options?: {
+            countOfInstallments?: NumberOfInstallmentsChosenByTheCustomerForTheOrder;
+            hasPaybreak?: IfTrueTheCustomerElectedToHaveADelayInPaymentCapture;
+        };
+        transactionKey?: string;
+    }[];
+    /**
+     * Public reference set by the client to display to customers in account areas and transactional emails
+     */
+    publicKey?: string;
+    /**
+     * External reference set by the client to integrate a 3rd party system
+     */
+    referenceKey?: string;
+    shipping?: {
+        deliveredOn?: string;
+        deliveryCosts?: number;
+        expressDeliveryCosts?: number;
+        policy: string;
+    };
+    shop?: {
+        id: number;
+        /**
+         * Three letter country code of the shop
+         */
+        country: string;
+        /**
+         * Two letter language code of the shop
+         */
+        language: string;
+    };
+    status: 'order_open' | 'payment_pending' | 'payment_reserved' | 'invoice_completed' | 'cancellation_pending' | 'cancellation_completed' | 'invoice_partially_completed';
+    vouchers?: {
+        id: number;
+        applicableItems?: {
+            isApplied?: boolean;
+            key?: string;
+        }[];
+        code: string;
+        type: 'absolute' | 'relative';
+        value: number;
+    }[];
+    createdAt: TimestampOfOrderCreation;
+    updatedAt: TimestampOfLastOrderUpdate;
+}
+export interface ThisFieldHoldsDetailsAboutTheIncludedVATTax {
+    amount: TheIncludedVATAmount;
+    rate: TheIncludedVATRateInPercentAsIntegerRepresentation;
+}
+/**
+ * When an item cannot be shipped within the regular delivery timeframe, and the warehouse is already aware of this, prior to the customer placing the order (ie it is not an unintentionally delayed delivery). This is generally the case when the item is out of stock and: the warehouse is waiting for incoming returns to restock the item, the warehouse has ordered fresh stocks from the supplier/manufacturer and is waiting for these to be shipped to the warehouse.
+ */
+export interface DeliveryForecastFromWarehouse {
+    deliverable?: {
+        key?: string;
+        [k: string]: unknown;
+    };
+    subsequentDelivery?: {
+        key?: 'endOfJanuary' | 'endOfFebruary' | 'endOfMarch' | 'endOfApril' | 'endOfMay' | 'endOfJune' | 'endOfJuly' | 'endOfAugust' | 'endOfSeptember' | 'endOfOctober' | 'endOfNovember' | 'endOfDecember' | 'midOfJanuary' | 'midOfFebruary' | 'midOfMarch' | 'midOfApril' | 'midOfMay' | 'midOfJune' | 'midOfJuly' | 'midOfAugust' | 'midOfSeptember' | 'midOfOctober' | 'midOfNovember' | 'midOfDecember' | 'easter' | 'christmas' | 'available' | 'directShipping' | 'outsold';
+        [k: string]: unknown;
+    };
+}

package/dist/types/bapi/pagination.cjs

@@ -0,0 +1 @@
+"use strict";

package/dist/types/bapi/pagination.d.ts

@@ -0,0 +1,13 @@
+export interface Pagination {
+    current: number;
+    total: number;
+    perPage: number;
+    page: number;
+    first: number;
+    prev: number;
+    next: number;
+    last: number;
+}
+export type PaginatedResponse<Response = any> = {
+    pagination: Pagination;
+} & Response;

package/dist/types/bapi/product.cjs

@@ -0,0 +1 @@
+"use strict";

package/dist/types/bapi/product.d.ts

@@ -0,0 +1,84 @@
+import type { ProductSearchQuery } from '@aboutyou/backbone/types/ProductSearchQuery';
+import type { ProductWith, VariantWith } from '@aboutyou/backbone/types/ProductWith';
+import type { BapiProduct as Product, ProductImage, ProductsSearchEndpointParameters, Value } from '@aboutyou/backbone';
+import type { CacheOptions } from '../../cache';
+import type { FilterParams } from './filter';
+import type { PaginatedResponse } from './pagination';
+export type { AttributeGroup, AttributeGroupSingle, AttributeGroupMulti, RFC33339Date, } from '@aboutyou/backbone/types/BapiProduct';
+export type { ProductImage, Value } from '@aboutyou/backbone';
+export type { BasketItem, BasketTotalPrice, } from '@aboutyou/backbone/endpoints/basket/getBasket';
+export type { WishlistItem } from '@aboutyou/backbone/endpoints/wishlist/getWishlist';
+export type { AdvancedAttribute, AdvancedAttributes, Attributes, BapiProduct as Product, BapiPrice as Price, CentAmount, Stock, Variant, LowestPriorPrice, AppliedReduction, } from '@aboutyou/backbone/types/BapiProduct';
+export type { ProductSortConfig, ProductsSearchEndpointParameters, ProductsSearchEndpointResponseData, } from '@aboutyou/backbone/endpoints/products/products';
+export type { ProductWith, VariantWith, ProductSearchQuery };
+export type VariantId = number;
+export type FieldSet = Array<Array<{
+    [key: string]: string | number | null | undefined;
+}>>;
+export declare type GroupSet = Array<{
+    fieldSet: FieldSet;
+    groupSet: GroupSet;
+}>;
+export interface ProductColor {
+    id: number;
+    label: string;
+    value: string;
+}
+export interface FetchProductParams {
+    id: number;
+    with?: ProductWith;
+    pricePromotionKey?: string;
+    includeSellableForFree?: boolean;
+}
+export interface FetchProductsParams {
+    ids: number[];
+    with?: ProductWith;
+    pricePromotionKey?: string;
+    includeSellableForFree?: boolean;
+}
+export interface FetchProductsByCategoryParams {
+    category: string;
+    with?: ProductWith;
+    cache?: CacheOptions;
+    includedFilters?: Array<string>;
+    perPage?: number;
+    page?: number;
+    where?: {
+        term?: ProductSearchQuery['term'];
+        minPrice?: ProductSearchQuery['minPrice'];
+        maxPrice?: ProductSearchQuery['maxPrice'];
+        attributes?: ProductSearchQuery['attributes'];
+        disableFuzziness?: ProductSearchQuery['disableFuzziness'];
+        whitelistAttributes?: ProductSearchQuery['attributes'];
+    };
+    sort: FilterParams['sort'];
+    pricePromotionKey?: string;
+    includeSellableForFree?: boolean;
+    includeSoldOut?: boolean;
+    orFiltersOperator?: ProductsSearchEndpointParameters['orFiltersOperator'];
+}
+export type ProductsResponse = PaginatedResponse<{
+    products: Product[];
+}>;
+export type FetchProductsByCategoryResponse = ProductsResponse;
+export interface FetchProductsCountParams {
+    category?: string;
+    categoryId?: number;
+    where?: {
+        term?: ProductSearchQuery['term'];
+        minPrice?: ProductSearchQuery['minPrice'];
+        maxPrice?: ProductSearchQuery['maxPrice'];
+        attributes?: ProductSearchQuery['attributes'];
+    };
+    includeSoldOut?: boolean;
+    includeSellableForFree?: boolean;
+    orFiltersOperator?: ProductsSearchEndpointParameters['orFiltersOperator'];
+}
+export interface FetchProductsCountResponse {
+    count: number;
+}
+export type ProductSibling = {
+    id: number;
+    image: ProductImage | null;
+    colors: Value[];
+};

package/dist/types/bapi/productFilter.cjs

@@ -0,0 +1 @@
+"use strict";

package/dist/types/bapi/productFilter.d.ts

@@ -0,0 +1,7 @@
+import type { AttributesFilterValue, FilterItemWithValues, IdentifierFilterValue } from '@aboutyou/backbone/endpoints/filters/filters';
+export type ProductFilter = FilterItemWithValues;
+export type ProductFilterValues = ProductFilter['values'];
+export type ProductFilterValue = AttributesFilterValue | {
+    name: true | false;
+    productCount: number;
+} | IdentifierFilterValue;

package/dist/types/bapi/promotion.cjs

@@ -0,0 +1 @@
+"use strict";