@devite/shopware-client 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,2186 @@
+type AggregationEntity = {
+    name: string;
+    type: "entity";
+    field: string;
+    definition: string;
+};
+
+type EqualsFilter = {
+    type: "equals";
+    field: string;
+    value: "string" | "number" | "boolean" | "null";
+};
+
+type RangeFilter = {
+    type: "range";
+    field: string;
+    parameters: Array<{
+        gte?: number;
+        gt?: number;
+        lte?: number;
+        lt?: number;
+    }>;
+};
+
+type SimpleFilter = {
+    type: "contains" | "equalsAny" | "prefix" | "suffix";
+    field: string;
+    value: string;
+};
+
+type Filters = Array<SimpleFilter | EqualsFilter | MultiNotFilter | RangeFilter>;
+
+type MultiNotFilter = {
+    type: "multi" | "not";
+    operator: "AND" | "and" | "OR" | "or";
+    queries: Filters;
+};
+
+type AggregationFilter = {
+    name: string;
+    type: "filter";
+    filter: Array<Filters>;
+};
+
+type AggregationHistogram = {
+    name: string;
+    type: "histogram";
+    field: string;
+    interval?: number;
+    format?: string;
+    timeZone?: string;
+};
+
+type AggregationMetrics = {
+    name: string;
+    type: "avg" | "count" | "max" | "min" | "stats" | "sum";
+    field: string;
+};
+
+type AggregationRange = {
+    name: string;
+    type: "range";
+    field: string;
+    ranges: Array<{
+        from: number;
+        to: number;
+    } | {
+        from: number;
+    } | {
+        to: number;
+    }>;
+};
+
+type TotalCountMode = "none" | "exact" | "next-pages";
+
+type Criteria = {
+    page?: number;
+    term?: string;
+    limit?: number;
+    filter?: Filters;
+    ids?: Array<string>;
+    query?: Array<Query>;
+    associations?: Array<Criteria>;
+    "post-filter"?: Filters;
+    sort?: Array<Sort>;
+    aggregations?: Aggregations;
+    fields?: Array<string>;
+    grouping?: Array<string>;
+    "total-count-mode"?: TotalCountMode;
+    includes?: Include;
+};
+
+type Sort = {
+    field: string;
+    order: "ASC" | "DESC";
+    naturalSorting?: boolean;
+    type?: string;
+};
+
+type ProductListingCriteria = Criteria & {
+    order?: string;
+    limit?: number;
+    p?: number;
+    manufacturer?: string;
+    "min-price"?: number;
+    "max-price"?: number;
+    rating?: number;
+    "shipping-free"?: boolean;
+    properties?: string;
+    "manufacturer-filter"?: boolean;
+    "price-filter"?: boolean;
+    "rating-filter"?: boolean;
+    "shipping-free-filter"?: boolean;
+    "property-filter"?: boolean;
+    "property-whitelist"?: string;
+    "reduce-aggregations"?: string | null;
+} & {
+    filter?: Filters | SimpleFilter;
+    sort?: Array<Sort> | Sort;
+    "post-filter"?: Filters | SimpleFilter;
+};
+
+type ProductListingFlags = {
+    "no-aggregations"?: string | null;
+    "only-aggregations"?: string | null;
+};
+
+type Include = Record<string, Array<string>>;
+
+type Query = {
+    score: number;
+    query: SimpleFilter | EqualsFilter | MultiNotFilter | RangeFilter;
+};
+
+type AggregationTerms = {
+    name: string;
+    type: "terms";
+    field: string;
+    limit?: number;
+    sort?: Array<Sort>;
+};
+
+type Aggregations = Array<AggregationEntity | AggregationFilter | AggregationHistogram | AggregationMetrics | AggregationRange | AggregationTerms>;
+
+type Price = {
+    currencyId: string;
+    gross: number;
+    net: number;
+    linked?: boolean;
+    listPrice?: {
+        currencyId?: string;
+        gross: number;
+        net: number;
+        linked?: boolean;
+    };
+    regulationPrice: {
+        currencyId?: string;
+        gross: number;
+        net: number;
+        linked?: boolean;
+    };
+};
+
+type CartPriceQuantity = {
+    apiAlias: "cart_price_quantity";
+    isCalculated?: boolean;
+    listPrice?: CartListPrice;
+    price?: number;
+    quantity?: number;
+    regulationPrice?: {
+        price?: number;
+    };
+    taxRules?: Array<{
+        taxRate?: number;
+        name?: string;
+    }>;
+    type?: string;
+};
+
+type CartPriceReference = {
+    apiAlias: "cart_price_reference";
+    purchaseUnit?: number;
+    referenceUnit?: number;
+    unitName: string;
+    price?: number;
+    listPrice: CartListPrice | null;
+    regulationPrice: CartRegulationPrice | null;
+    hasRange: boolean;
+    variantId?: string;
+};
+
+type CalculatedPrice = {
+    unitPrice: number;
+    quantity: number;
+    rawTotal?: number;
+    totalPrice: number;
+    calculatedTaxes: Array<{
+        apiAlias: "cart_tax_calculated";
+        tax: number;
+        taxRate: number;
+        price: number;
+    }>;
+    referencePrice: CartPriceReference | null;
+    listPrice: CartListPrice | null;
+    positionPrice: number;
+    netPrice: number;
+    regulationPrice: CartRegulationPrice | null;
+    hasRange: boolean;
+    variantId?: string | null;
+    apiAlias: "calculated_price";
+    taxRules: Array<{
+        taxRate?: number;
+        name?: string;
+    }>;
+};
+
+type CartListPrice = {
+    apiAlias: "cart_list_price";
+    discount?: number;
+    percentage?: number;
+    price?: number;
+};
+
+type CartRegulationPrice = {
+    apiAlias?: "cart_regulation_price";
+    price?: number;
+};
+
+type Cart = {
+    name?: string;
+    token?: string;
+    price?: CalculatedPrice;
+    lineItems?: CartItems;
+    errors?: Array<CartError>;
+    deliveries?: Array<CartDelivery>;
+    transactions?: Array<{
+        paymentMethodId?: string;
+        amount?: CalculatedPrice;
+    }>;
+    modified?: boolean;
+    customerComment?: string | null;
+    affiliateCode?: string | null;
+    campaignCode?: string | null;
+    id?: any;
+};
+
+type GenericRecord = never | null | string | Array<String> | number | {
+    [key: string]: GenericRecord;
+};
+
+type Country = {
+    id: string;
+    name: string;
+    iso?: string;
+    position?: number;
+    active?: boolean;
+    shippingAvailable?: boolean;
+    iso3?: string;
+    displayStateInRegistration?: boolean;
+    forceStateInRegistration?: boolean;
+    checkVatIdPattern?: boolean;
+    vatIdRequired?: boolean;
+    vatIdPattern?: string;
+    customFields?: GenericRecord;
+    customerTax?: {
+        enabled: boolean;
+        currencyId: string;
+        amount: number;
+    };
+    companyTax?: {
+        enabled: boolean;
+        currencyId: string;
+        amount: number;
+    };
+    postalCodeRequired?: boolean;
+    checkPostalCodePattern?: boolean;
+    checkAdvancedPostalCodePattern?: boolean;
+    advancedPostalCodePattern?: string;
+    addressFormat: string;
+    defaultPostalCodePattern?: string;
+    isEu?: boolean;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+    translated?: object;
+    states?: Array<CountryState>;
+    taxFree?: boolean;
+    companyTaxFree?: boolean;
+};
+
+type CountryState = {
+    id: string;
+    countryId: string;
+    shortCode: string;
+    name: string;
+    position?: number;
+    active?: boolean;
+    customFields?: GenericRecord;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+    translated?: object;
+};
+
+type DeliveryTime = {
+    id: string;
+    name: string;
+    min: number;
+    max: number;
+    unit: string;
+    customFields?: GenericRecord;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+    translated?: object;
+};
+
+type Rule = {
+    id?: string;
+    name: string;
+    description?: string;
+    customFields?: GenericRecord;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+    extensions?: any;
+};
+
+type Media = {
+    apiAlias: "media";
+    id: string;
+    readonly mimeType?: string;
+    readonly fileExtension: string;
+    readonly uploadedAt?: string;
+    readonly fileName: string;
+    readonly fileSize?: number;
+    readonly metaData?: object;
+    config?: object;
+    alt?: string;
+    title?: string;
+    url: string;
+    path: string;
+    hasFile: boolean;
+    private: boolean;
+    customFields?: GenericRecord;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+    translated: object;
+    thumbnails?: Array<MediaThumbnail>;
+    extensions?: any;
+};
+
+type MediaThumbnail = {
+    id: string;
+    mediaId: string;
+    readonly width: number;
+    readonly height: number;
+    url: string;
+    path?: string;
+    customFields?: GenericRecord;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+};
+
+type ProductMedia = {
+    id: string;
+    versionId?: string;
+    productId: string;
+    productVersionId?: string;
+    mediaId: string;
+    position?: number;
+    customFields?: GenericRecord;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+    media?: Media;
+    thumbnails?: MediaThumbnail;
+};
+
+type Tag = {
+    id: string;
+    name: string;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+};
+
+type Tax = {
+    id: string;
+    taxRate: number;
+    name: string;
+    position?: number;
+    customFields?: GenericRecord;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+};
+
+type ShippingMethod = {
+    id: string;
+    name: string;
+    active?: boolean;
+    position?: number;
+    customFields?: GenericRecord;
+    mediaId?: string;
+    deliveryTimeId: string;
+    taxType?: "Free" | "Net" | "Gross";
+    description?: string;
+    trackingUrl?: string;
+    technicalName?: string;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+    translated?: object;
+    deliveryTime?: DeliveryTime;
+    availabilityRule?: Rule;
+    prices?: Array<ShippingMethodPrice>;
+    media?: Media;
+    tags?: Array<Tag>;
+    tax?: Tax;
+};
+
+type ShippingMethodPrice = {
+    id: string;
+    shippingMethodId: string;
+    ruleId?: string;
+    calculation?: number;
+    calculationRuleId?: string;
+    quantityStart?: number;
+    quantityEnd?: number;
+    currencyPrice: Array<Price>;
+    customFields?: GenericRecord;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+};
+
+type CartDelivery = {
+    deliveryDate?: CartDeliveryDate;
+    location?: CartDeliveryShippingLocation & {
+        state?: CountryState;
+    };
+    positions?: Array<CartDeliveryPosition>;
+    shippingCosts?: CalculatedPrice;
+    shippingMethod?: ShippingMethod;
+};
+
+type CartDeliveryDate = {
+    earliest?: string;
+    latest?: string;
+};
+
+type CartDeliveryInformation = {
+    apiAlias: "cart_delivery_information";
+    freeDelivery?: boolean;
+    deliveryTime?: CartDeliveryTime;
+    height?: number;
+    length?: number;
+    restockTime?: number;
+    stock?: number;
+    weight?: number;
+    width?: number;
+};
+
+type LineItem = {
+    children?: Array<LineItem>;
+    cover?: ProductMedia;
+    dataContextHash?: string;
+    dataTimestamp?: string;
+    deliveryInformation?: CartDeliveryInformation;
+    description?: string;
+    good?: boolean;
+    id: string;
+    label?: string;
+    modified?: string;
+    modifiedByApp?: boolean;
+    payload?: LineItemPayload;
+    price?: CalculatedPrice;
+    priceDefinition?: CartPriceQuantity;
+    quantity?: number;
+    quantityInformation?: {
+        maxPurchase?: number;
+        minPurchase?: number;
+        purchaseSteps?: number;
+    };
+    referencedId?: string;
+    removable?: boolean;
+    stackable?: boolean;
+    states?: Array<"is-physical" | "is-download">;
+    type: LineItemType;
+    uniqueIdentifier?: string;
+};
+
+type Link = string | {
+    href: string;
+    meta?: object;
+};
+
+type Links = Record<string, Link>;
+
+type LineItemPayload = {
+    type: string;
+    id: string;
+    attributes?: object;
+    relationships?: object;
+    links?: Links;
+    meta?: object;
+    versionId?: string;
+    parentId?: string;
+    parentVersionId?: string;
+    manufacturerId?: string;
+    productManufacturerVersionId?: string;
+    unitId?: string;
+    taxId?: string;
+    coverId?: string;
+    productMediaVersionId?: string;
+    deliveryTimeId?: string;
+    canonicalProductId?: string;
+    canonicalProductVersionId?: string;
+    cmsPageId?: string;
+    cmsPageVersionId?: string;
+    productNumber: string;
+    restockTime?: number;
+    active?: boolean;
+    available?: boolean;
+    isCloseout?: boolean;
+    availableStock?: number;
+    stock: number;
+    displayGroup?: string;
+    manufacturerNumber?: string;
+    ean?: string;
+    purchaseSteps?: number;
+    maxPurchase?: number;
+    minPurchase?: number;
+    purchaseUnit?: number;
+    referenceUnit?: number;
+    shippingFree?: boolean;
+    markAsTopseller?: boolean;
+    weight?: number;
+    width?: number;
+    height?: number;
+    length?: number;
+    releaseDate?: string;
+    ratingAverage?: number;
+    categoryTree?: Array<string>;
+    propertyIds?: Array<string>;
+    optionIds?: Array<string>;
+    streamIds?: Array<string>;
+    tagIds?: Array<string>;
+    categoryIds?: Array<string>;
+    childCount?: number;
+    sales?: number;
+    states?: Array<string>;
+    metaDescription?: string;
+    name: string;
+    keywords?: string;
+    description?: string;
+    metaTitle?: string;
+    packUnit?: string;
+    packUnitPlural?: string;
+    customFields?: GenericRecord;
+    calculatedPrice?: CalculatedPrice;
+    calculatedPrices?: Array<CalculatedPrice>;
+    calculatedMaxPurchase?: number;
+    calculatedCheapestPrice?: CalculatedPrice;
+    isNew?: boolean;
+    sortedProperties?: object;
+    createdAt?: string;
+    updatedAt?: string;
+    translated?: object;
+};
+
+type LineItemType = "product" | "credit" | "custom" | "promotion" | "discount" | "container" | "quantity";
+
+type CartDeliveryPosition = {
+    deliveryDate?: CartDeliveryDate;
+    identifier?: string;
+    lineItem?: LineItem;
+    price?: CalculatedPrice;
+};
+
+type Language = {
+    id: string;
+    parentId?: string;
+    localeId: string;
+    translationCodeId?: string;
+    name: string;
+    customFields?: GenericRecord;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+    parent?: Language;
+    locale?: Locale;
+    translationCode?: Locale;
+    children?: Array<Language>;
+};
+
+type Locale = {
+    id: string;
+    code: string;
+    name: string;
+    territory: string;
+    customFields?: GenericRecord;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+    translated?: object;
+};
+
+type PaymentMethod = {
+    id: string;
+    name: string;
+    readonly distinguishableName?: string;
+    description?: string;
+    position?: number;
+    active?: boolean;
+    afterOrderEnabled?: boolean;
+    customFields?: GenericRecord;
+    mediaId?: string;
+    readonly synchronous?: boolean;
+    readonly asynchronous?: boolean;
+    readonly prepared?: boolean;
+    readonly refundable?: boolean;
+    readonly recurring?: boolean;
+    shortName?: string;
+    technicalName?: string;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+    translated?: object;
+    media?: Media;
+};
+
+type Salutation = {
+    id: string;
+    salutationKey: string;
+    displayName: string;
+    letterName: string;
+    customFields?: GenericRecord;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+    translated?: object;
+};
+
+type Customer = {
+    apiAlias: "customer";
+    id: string;
+    groupId: string;
+    salesChannelId: string;
+    languageId: string;
+    lastPaymentMethodId?: string;
+    defaultBillingAddressId: string;
+    defaultShippingAddressId: string;
+    customerNumber: string;
+    salutationId?: string;
+    firstName: string;
+    lastName: string;
+    company?: string;
+    email: string;
+    title?: string;
+    vatIds?: Array<string>;
+    affiliateCode?: string;
+    campaignCode?: string;
+    active?: boolean;
+    doubleOptInRegistration?: boolean;
+    doubleOptInEmailSentDate?: string;
+    doubleOptInConfirmDate?: string;
+    hash?: string;
+    guest?: boolean;
+    firstLogin?: string;
+    lastLogin?: string;
+    birthday?: string;
+    readonly lastOrderDate?: string;
+    readonly orderCount?: number;
+    readonly orderTotalAmount?: number;
+    readonly reviewCount?: number;
+    customFields?: GenericRecord;
+    readonly tagIds?: Array<string>;
+    accountType?: string;
+    createdById?: string;
+    updatedById?: string;
+    defaultPaymentMethodId: string;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+    group?: CustomerGroup;
+    language?: Language;
+    lastPaymentMethod?: PaymentMethod;
+    defaultBillingAddress?: CustomerAddress;
+    activeBillingAddress: CustomerAddress;
+    defaultShippingAddress?: CustomerAddress;
+    activeShippingAddress: CustomerAddress;
+    salutation?: Salutation;
+    addresses?: Array<CustomerAddress>;
+    tags?: Array<Tag>;
+    defaultPaymentMethod?: PaymentMethod;
+    extensions?: {
+        specificFeatures?: any;
+    };
+};
+
+type CustomerAddress = CustomerAddressBody & {
+    id: string;
+    customerId: string;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+};
+
+type CustomerAddressBody = {
+    countryId: string;
+    countryStateId?: string;
+    salutationId?: string;
+    firstName: string;
+    lastName: string;
+    zipcode?: string;
+    city: string;
+    company?: string;
+    street: string;
+    department?: string;
+    title?: string;
+    phoneNumber?: string;
+    additionalAddressLine1?: string;
+    additionalAddressLine2?: string;
+    customFields?: GenericRecord;
+    country?: Country;
+    countryState?: CountryState;
+    salutation?: Salutation;
+};
+
+type CustomerGroup = {
+    id: string;
+    name: string;
+    displayGross?: boolean;
+    customFields?: GenericRecord;
+    registrationActive?: boolean;
+    registrationTitle?: string;
+    registrationIntroduction?: string;
+    registrationOnlyCompanyRegistration?: boolean;
+    registrationSeoMetaDescription?: string;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+    translated: {
+        name?: string;
+        registrationIntroduction?: string;
+        registrationSeoMetaDescription?: string;
+        registrationTitle?: string;
+    };
+};
+
+type CartDeliveryShippingLocation = {
+    apiAlias?: "cart_delivery_shipping_location";
+    country?: Country;
+    address?: CustomerAddress;
+};
+
+type CartDeliveryTime = {
+    apiAlias?: "cart_delivery_time";
+    name?: string;
+    min?: number;
+    max?: number;
+    unit?: string;
+};
+
+type CartError = {
+    items?: {
+        key?: string;
+        level?: 0 | 10 | 20;
+        message?: string;
+        messageKey?: string;
+    };
+};
+
+type CartItems = Array<LineItem>;
+
+type BackgroundMediaMode = "cover" | "auto" | "contain";
+
+type CmsBlock = {
+    apiAlias: "cms_block";
+    id?: string;
+    position: number;
+    type: "image" | "text" | "product-listing" | "image-two-column";
+    name?: string;
+    sectionPosition?: "main" | "sidebar";
+    marginTop?: string;
+    marginBottom?: string;
+    marginLeft?: string;
+    marginRight?: string;
+    backgroundColor?: string;
+    backgroundMediaId?: string;
+    backgroundMediaMode?: BackgroundMediaMode;
+    cssClass?: string;
+    visibility?: Visibility;
+    sectionId: string;
+    customFields?: GenericRecord;
+    versionId?: string;
+    cmsSectionVersionId?: string;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+    backgroundMedia?: Media;
+    slots?: Array<CmsSlot>;
+};
+
+type CmsPage = {
+    apiAlias: "cms_page";
+    id: string;
+    versionId?: string;
+    name?: string;
+    type: "landingpage" | "page" | "product_list" | "product_detail";
+    entity?: string;
+    cssClass?: string;
+    config?: {
+        backgroundColor?: string;
+    };
+    previewMediaId?: string;
+    customFields?: GenericRecord;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+    translated?: object;
+    sections?: Array<CmsSection>;
+    previewMedia?: Media;
+    landingPages?: Array<LandingPage>;
+};
+
+type CmsSection = {
+    apiAlias: "cms_section";
+    id?: string;
+    position: number;
+    type: "sidebar" | "fullwidth";
+    name?: string;
+    sizingMode?: "boxed" | "full_width";
+    mobileBehavior?: string;
+    backgroundColor?: string;
+    backgroundMediaId?: string;
+    backgroundMediaMode?: BackgroundMediaMode;
+    cssClass?: string;
+    pageId: string;
+    visibility?: Visibility;
+    customFields?: GenericRecord;
+    cmsPageVersionId?: string;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+    page?: CmsPage;
+    backgroundMedia?: Media;
+    blocks?: Array<CmsBlock>;
+};
+
+type CmsSlot = {
+    id: string;
+    versionId?: string;
+    type: "image" | "text" | "form" | "product-listing" | "category-navigation" | "product-box" | "buy-box" | "sidebar-filter";
+    slot: string;
+    locked?: boolean;
+    config?: object;
+    customFields?: GenericRecord;
+    readonly data?: object;
+    blockId: string;
+    fieldConfig?: object;
+    cmsBlockVersionId?: string;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+    translated?: object;
+    block?: CmsBlock;
+    VersionId?: string;
+};
+
+type SeoUrlEntity = {
+    id: string;
+    salesChannelId?: string;
+    languageId: string;
+    foreignKey: string;
+    routeName: "frontend.navigation.page" | "frontend.landing.page" | "frontend.detail.page";
+    pathInfo: string;
+    seoPathInfo: string;
+    isCanonical?: boolean;
+    isModified?: boolean;
+    isDeleted?: boolean;
+    error?: string;
+    url?: string;
+    customFields?: GenericRecord;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+};
+
+type Sitemap = {
+    filename: string;
+    created: string;
+};
+
+type LandingPage = {
+    apiAlias: "landing_page";
+    id: string;
+    versionId?: string;
+    active?: boolean;
+    name: string;
+    customFields?: GenericRecord;
+    slotConfig?: object;
+    metaTitle?: string;
+    metaDescription?: string;
+    keywords?: string;
+    url: string;
+    cmsPageId?: string;
+    cmsPageVersionId?: string;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+    translated?: object;
+    cmsPage?: CmsPage;
+    seoUrls?: Array<SeoUrlEntity>;
+};
+
+type Visibility = {
+    mobile?: boolean;
+    desktop?: boolean;
+    tablet?: boolean;
+};
+
+type Category = {
+    apiAlias: "category";
+    id: string;
+    versionId?: string;
+    parentId?: string;
+    parentVersionId?: string;
+    afterCategoryId?: string;
+    afterCategoryVersionId?: string;
+    mediaId?: string;
+    displayNestedProducts?: boolean;
+    readonly breadcrumb: Array<string>;
+    readonly level?: number;
+    readonly path?: string;
+    readonly childCount: number;
+    type: "page" | "folder" | "link";
+    productAssignmentType?: "product_stream" | "product";
+    visible?: boolean;
+    active?: boolean;
+    cmsPageIdSwitched?: boolean;
+    visibleChildCount?: number;
+    name: string;
+    customFields?: GenericRecord;
+    linkType?: "external" | "category" | "product" | "landing_page";
+    internalLink?: string;
+    externalLink?: string;
+    linkNewTab?: boolean;
+    description?: string;
+    metaTitle?: string;
+    metaDescription?: string;
+    keywords?: string;
+    cmsPageId?: string;
+    cmsPageVersionId?: string;
+    customEntityTypeId?: string;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+    translated: {
+        breadcrumb: Array<String>;
+    };
+    parent?: Category;
+    children: Array<Category>;
+    media?: Media;
+    tags?: Array<Tag>;
+    cmsPage?: CmsPage;
+    seoUrls?: Array<SeoUrlEntity>;
+};
+
+type MainCategory = {
+    id: string;
+    productId: string;
+    productVersionId?: string;
+    categoryId: string;
+    categoryVersionId?: string;
+    salesChannelId: string;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+};
+
+type StateMachineState = {
+    id?: string;
+    technicalName: string;
+    name: string;
+    customFields?: GenericRecord;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+    translated?: object;
+};
+
+type Currency = {
+    id: string;
+    factor: number;
+    symbol: string;
+    isoCode: string;
+    shortName: string;
+    name: string;
+    position?: number;
+    isSystemDefault?: boolean;
+    taxFreeFrom?: number;
+    customFields?: GenericRecord;
+    itemRounding: {
+        decimals: number;
+        interval: number;
+        roundForNet: boolean;
+    };
+    totalRounding: {
+        decimals: number;
+        interval: number;
+        roundForNet: boolean;
+    };
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+    translated?: object;
+};
+
+type Order = {
+    id: string;
+    versionId?: string;
+    orderNumber?: string;
+    billingAddressId: string;
+    billingAddressVersionId?: string;
+    currencyId: string;
+    languageId: string;
+    salesChannelId: string;
+    orderDateTime: string;
+    readonly orderDate: string;
+    price: {
+        netPrice: number;
+        totalPrice: number;
+        calculatedTaxes?: object;
+        taxRules?: object;
+        positionPrice: number;
+        rawTotal: number;
+        taxStatus: "Free" | "Net" | "Gross";
+    };
+    readonly amountTotal?: number;
+    readonly amountNet?: number;
+    readonly positionPrice?: number;
+    readonly taxStatus?: "Free" | "Net" | "Gross";
+    shippingCosts?: CalculatedPrice;
+    readonly shippingTotal?: number;
+    currencyFactor: number;
+    deepLinkCode?: string;
+    affiliateCode?: string;
+    campaignCode?: string;
+    customerComment?: string;
+    source?: string;
+    customFields?: GenericRecord;
+    createdById?: string;
+    updatedById?: string;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+    stateMachineState: StateMachineState;
+    orderCustomer: OrderCustomer;
+    currency?: Currency;
+    language?: Language;
+    addresses?: Array<OrderAddress>;
+    billingAddress?: OrderAddress;
+    deliveries?: Array<OrderDelivery>;
+    lineItems?: Array<OrderLineItem>;
+    transactions?: Array<OrderTransaction>;
+    documents: Array<ShopwareDocument>;
+    tags?: Array<Tag>;
+    extensions?: object;
+};
+
+type OrderAddress = CustomerAddressBody & {
+    id: string;
+    versionId?: string;
+    vatId?: string;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+};
+
+type OrderCustomer = {
+    id: string;
+    versionId?: string;
+    email: string;
+    salutationId?: string;
+    firstName: string;
+    lastName: string;
+    company?: string;
+    title?: string;
+    vatIds?: Array<string>;
+    customerNumber?: string;
+    customFields?: GenericRecord;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+    salutation?: Salutation;
+};
+
+type OrderDelivery = {
+    id: string;
+    versionId?: string;
+    orderId: string;
+    orderVersionId?: string;
+    shippingOrderAddressId: string;
+    shippingOrderAddressVersionId?: string;
+    shippingMethodId: string;
+    stateId: string;
+    trackingCodes?: Array<string>;
+    shippingDateEarliest: string;
+    shippingDateLatest: string;
+    shippingCosts?: CalculatedPrice;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+    stateMachineState?: StateMachineState;
+    shippingOrderAddress?: OrderAddress;
+    shippingMethod?: ShippingMethod;
+    positions?: Array<OrderDeliveryPosition>;
+};
+
+type OrderDeliveryPosition = {
+    id: string;
+    versionId?: string;
+    orderDeliveryId: string;
+    orderDeliveryVersionId?: string;
+    orderLineItemId: string;
+    orderLineItemVersionId?: string;
+    price: CalculatedPrice;
+    unitPrice?: number;
+    totalPrice?: number;
+    quantity?: number;
+    customFields?: GenericRecord;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+};
+
+type OrderLineItem = {
+    apiAlias: "order_line_item";
+    id: string;
+    versionId?: string;
+    orderId: string;
+    orderVersionId?: string;
+    productId?: string;
+    productVersionId?: string;
+    promotionId?: string;
+    parentId?: string;
+    parentVersionId?: string;
+    coverId?: string;
+    identifier: string;
+    referencedId: string;
+    quantity: number;
+    label: string;
+    payload?: LineItemPayload;
+    good?: boolean;
+    removable?: boolean;
+    stackable?: boolean;
+    position?: number;
+    states: Array<string>;
+    priceDefinition?: CartPriceQuantity;
+    unitPrice?: number;
+    totalPrice?: number;
+    description?: string;
+    type?: string;
+    customFields?: GenericRecord;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+    cover?: Media;
+    orderDeliveryPositions?: Array<OrderDeliveryPosition>;
+    downloads?: Array<OrderLineItemDownload>;
+    parent?: OrderLineItem;
+    children: Array<OrderLineItem>;
+    extensions?: object;
+    translated?: object;
+};
+
+type OrderLineItemDownload = {
+    id: string;
+    versionId?: string;
+    orderLineItemId: string;
+    orderLineItemVersionId?: string;
+    mediaId: string;
+    position: number;
+    accessGranted: boolean;
+    customFields?: GenericRecord;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+    orderLineItem?: OrderLineItem;
+    media?: Media;
+};
+
+type OrderTransaction = {
+    id: string;
+    versionId?: string;
+    orderId: string;
+    orderVersionId?: string;
+    paymentMethodId: string;
+    amount: CalculatedPrice;
+    validationData?: object;
+    stateId: string;
+    customFields?: GenericRecord;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+    stateMachineState?: StateMachineState;
+    paymentMethod?: PaymentMethod;
+    captures?: Array<OrderTransactionCapture>;
+    shippingCosts?: CalculatedPrice;
+};
+
+type OrderTransactionCapture = {
+    id: string;
+    versionId?: string;
+    orderTransactionId: string;
+    orderTransactionVersionId?: string;
+    stateId: string;
+    externalReference?: string;
+    amount: CalculatedPrice;
+    customFields?: GenericRecord;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+    stateMachineState?: StateMachineState;
+    transaction?: OrderTransaction;
+    refunds?: Array<OrderTransactionCaptureRefund>;
+    shippingCosts?: CalculatedPrice;
+};
+
+type OrderTransactionCaptureRefund = {
+    id: string;
+    versionId?: string;
+    captureId: string;
+    captureVersionId?: string;
+    stateId: string;
+    externalReference?: string;
+    reason?: string;
+    amount: CalculatedPrice;
+    customFields?: GenericRecord;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+    stateMachineState?: StateMachineState;
+    transactionCapture?: OrderTransactionCapture;
+    positions?: Array<OrderTransactionCaptureRefundPosition>;
+    shippingCosts?: CalculatedPrice;
+};
+
+type OrderTransactionCaptureRefundPosition = {
+    id: string;
+    versionId?: string;
+    refundId: string;
+    refundVersionId?: string;
+    orderLineItemId: string;
+    orderLineItemVersionId?: string;
+    externalReference?: string;
+    reason?: string;
+    quantity?: number;
+    amount: CalculatedPrice;
+    customFields?: GenericRecord;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+    orderLineItem?: OrderLineItem;
+    orderTransactionCaptureRefund?: OrderTransactionCaptureRefund;
+    shippingCosts?: CalculatedPrice;
+};
+
+type ShopwareDocument = {
+    id: string;
+    documentTypeId: string;
+    fileType: string;
+    referenceDocumentId?: string;
+    orderId: string;
+    documentMediaFileId?: string;
+    orderVersionId?: string;
+    config: {
+        name: string;
+        title: string;
+    };
+    sent?: boolean;
+    static?: boolean;
+    deepLinkCode: string;
+    documentNumber?: string;
+    customFields?: GenericRecord;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+    documentType?: ShopwareDocumentType;
+    order?: Order;
+    referencedDocument?: ShopwareDocument;
+    dependantDocuments?: Array<ShopwareDocument>;
+    documentMediaFile?: Media;
+};
+
+type ShopwareDocumentType = {
+    id: string;
+    name: string;
+    technicalName: string;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+    customFields?: GenericRecord;
+    translated?: object;
+};
+
+type Unit = {
+    id: string;
+    shortCode: string;
+    name: string;
+    customFields?: GenericRecord;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+    translated?: object;
+};
+
+type PropertyGroup = {
+    id: string;
+    name: string;
+    description?: string;
+    displayType?: "text" | "image" | "dropdown" | "color";
+    sortingType?: "name" | "position";
+    filterable?: boolean;
+    visibleOnProductDetailPage?: boolean;
+    position?: number;
+    customFields?: GenericRecord;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+    translated?: object;
+    options?: Array<PropertyGroupOption>;
+};
+
+type PropertyGroupOption = {
+    id: string;
+    groupId: string;
+    name: string;
+    position?: number;
+    colorHexCode?: string;
+    mediaId?: string;
+    customFields?: GenericRecord;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+    translated?: object;
+    media?: Media;
+    group: PropertyGroup;
+    option: string;
+};
+
+type Product = {
+    apiAlias: "product";
+    id: string;
+    versionId?: string;
+    parentId?: string;
+    parentVersionId?: string;
+    manufacturerId?: string;
+    productManufacturerVersionId?: string;
+    unitId?: string;
+    taxId: string;
+    coverId?: string;
+    productMediaVersionId?: string;
+    deliveryTimeId?: string;
+    canonicalProductId?: string;
+    canonicalProductVersionId?: string;
+    cmsPageId?: string;
+    cmsPageVersionId?: string;
+    productNumber: string;
+    restockTime: number;
+    active?: boolean;
+    readonly available?: boolean;
+    isCloseout?: boolean;
+    readonly availableStock?: number;
+    stock: number;
+    readonly displayGroup?: string;
+    manufacturerNumber?: string;
+    ean?: string;
+    purchaseSteps?: number;
+    maxPurchase?: number;
+    minPurchase?: number;
+    purchaseUnit?: number;
+    referenceUnit?: number;
+    shippingFree?: boolean;
+    markAsTopseller?: boolean;
+    weight?: number;
+    width?: number;
+    height?: number;
+    length?: number;
+    releaseDate?: string;
+    readonly ratingAverage?: number;
+    readonly categoryTree?: Array<string>;
+    readonly propertyIds?: Array<string>;
+    readonly optionIds?: Array<string>;
+    readonly streamIds?: Array<string>;
+    readonly tagIds?: Array<string>;
+    readonly categoryIds?: Array<string>;
+    readonly childCount?: number;
+    readonly sales?: number;
+    readonly states?: Array<string>;
+    metaDescription?: string;
+    name: string;
+    keywords?: string;
+    description?: string;
+    metaTitle?: string;
+    packUnit?: string;
+    packUnitPlural?: string;
+    customFields?: GenericRecord;
+    calculatedPrice: CalculatedPrice;
+    calculatedPrices: Array<CalculatedPrice>;
+    calculatedMaxPurchase?: number;
+    calculatedCheapestPrice?: CalculatedPrice;
+    isNew?: boolean;
+    sortedProperties: object;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+    translated?: object;
+    downloads?: Array<ProductDownload>;
+    parent?: Product;
+    children?: Array<Product>;
+    deliveryTime?: DeliveryTime;
+    tax?: Tax;
+    manufacturer?: ProductManufacturer;
+    unit?: Unit;
+    cover?: ProductMedia;
+    cmsPage?: CmsPage;
+    canonicalProduct?: Product;
+    media?: Array<Media>;
+    crossSellings?: Array<ProductCrossSelling>;
+    configuratorSettings?: Array<ProductConfiguratorSetting>;
+    productReviews?: Array<ProductReview>;
+    mainCategories?: Array<MainCategory>;
+    seoUrls?: Array<SeoUrlEntity>;
+    options?: Array<PropertyGroupOption>;
+    properties?: Array<PropertyGroupOption>;
+    categories?: Array<MainCategory>;
+    streams?: Array<ProductStream>;
+    categoriesRo?: Array<Category>;
+    tags?: Array<Tag>;
+    seoCategory: Category;
+    variantListingConfig?: {
+        displayParent?: boolean;
+    } | null;
+    mainVariantId?: any;
+    externalReference?: any;
+};
+
+type CrossSellingElement = {
+    apiAlias: "cross_selling_element";
+    crossSelling: Array<ProductCrossSelling>;
+    products: Array<Product>;
+    total: number;
+    streamId: string;
+};
+
+type ProductCrossSelling = {
+    id: string;
+    name: string;
+    position?: number;
+    sortBy?: string;
+    sortDirection?: string;
+    type?: string;
+    active?: boolean;
+    limit?: number;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+    translated?: object;
+};
+
+type ProductConfiguratorSetting = {
+    id: string;
+    versionId?: string;
+    productId: string;
+    productVersionId?: string;
+    mediaId?: string;
+    optionId: string;
+    position?: number;
+    customFields?: GenericRecord;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+    media?: Media;
+    option?: PropertyGroupOption;
+};
+
+type ProductDownload = {
+    id: string;
+    versionId?: string;
+    productId: string;
+    productVersionId?: string;
+    mediaId: string;
+    position?: number;
+    customFields?: GenericRecord;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+    product?: Product;
+    media?: Media;
+};
+
+type EntitySearchResult = {
+    entity?: string;
+    total?: number;
+    aggregations?: Array<object>;
+    page?: number;
+    limit?: number;
+};
+
+type ProductListingResult = EntitySearchResult & {
+    apiAlias: "product_listing";
+    entity?: "product";
+    currentFilters: Array<{
+        navigationId: string;
+        manufacturer: Array<string>;
+        price: {
+            min: number;
+            max: number;
+        };
+        rating: number | null;
+        "shipping-free": boolean;
+        properties: Array<string>;
+        search: string;
+    }>;
+    availableSortings: Array<{
+        apiAlias: "product_sorting";
+        label: string;
+        translated: {
+            label: string;
+        };
+        key: string;
+        priority: number;
+    }>;
+    sorting?: string;
+    elements: Array<Product>;
+};
+
+type ProductManufacturer = {
+    id: string;
+    versionId?: string;
+    mediaId?: string;
+    link?: string;
+    name: string;
+    description?: string;
+    customFields?: GenericRecord;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+    translated?: object;
+    media?: Media;
+};
+
+type ProductReview = {
+    id: string;
+    productId: string;
+    productIdVersionId?: string;
+    salesChannelId: string;
+    languageId: string;
+    title: string;
+    content: string;
+    points: number;
+    status?: boolean;
+    comment?: string;
+    customFields?: GenericRecord;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+};
+
+type ProductStream = {
+    id: string;
+    name: string;
+    description?: string;
+    customFields?: GenericRecord;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+    translated?: object;
+};
+
+type SalesChannel = {
+    typeId?: string;
+    languageId?: string;
+    currencyId?: string;
+    paymentMethodId?: string;
+    shippingMethodId?: string;
+    countryId?: string;
+    navigationCategoryId?: string;
+    navigationCategoryDepth?: number;
+    footerCategoryId?: string;
+    serviceCategoryId?: string;
+    name?: string;
+    shortName?: string;
+    accessKey?: string;
+    active?: boolean;
+    maintenance?: boolean;
+    maintenanceIpWhitelist?: string;
+    mailHeaderFooterId?: string;
+    customerGroupId?: string;
+    hreflangActive?: boolean;
+    hreflangDefaultDomainId?: string;
+    analyticsId?: string;
+};
+
+type SalesChannelContext = {
+    token?: string;
+    currentCustomerGroup?: {
+        name?: string;
+        displayGross?: boolean;
+    };
+    fallbackCustomerGroup?: {
+        name?: string;
+        displayGross?: boolean;
+    };
+    currency?: Currency;
+    salesChannel?: SalesChannel;
+    taxRules?: Array<{
+        taxRate?: number;
+        name?: string;
+    }>;
+    customer?: Customer;
+    paymentMethod?: PaymentMethod;
+    shippingLocation?: CartDeliveryShippingLocation;
+    shippingMethod?: ShippingMethod;
+    context?: {
+        versionId?: string;
+        currencyId?: string;
+        currencyFactor?: number;
+        currencyPrecision?: number;
+        languageIdChain?: string;
+        scope?: string;
+        source?: string;
+        taxState?: "gross" | "net";
+        useCache?: boolean;
+    };
+};
+
+type AccountEmailChangeRequest = {
+    email: string;
+    emailConfirmation: string;
+    password: string;
+};
+type AccountEmailChangeResponse = {
+    success?: boolean;
+};
+type AccountGetRequest = Criteria;
+type AccountGetResponse = Customer;
+type AccountLanguageChangeRequest = {
+    language?: string;
+};
+type AccountLanguageChangeResponse = {
+    success?: boolean;
+};
+type AccountNewsletterRecipientListRequest = Criteria;
+type AccountNewsletterRecipientListResponse = {
+    apiAlias: "account_newsletter_recipient";
+    status: "undefined" | "notSet" | "direct" | "optIn" | "optOut";
+};
+type AccountPasswordChangeRequest = {
+    password: string;
+    newPassword: string;
+    newPasswordConfirm: string;
+};
+type AccountPasswordChangeResponse = {
+    success?: boolean;
+};
+type AccountPasswordRecoveryMailRequest = {
+    email: string;
+    storefrontUrl: string;
+};
+type AccountPasswordRecoveryMailResponse = {
+    success?: boolean;
+};
+type AccountPasswordRecoveryRequest = {
+    hash: string;
+    newPassword: string;
+    newPasswordConfirm: string;
+};
+type AccountPasswordRecoveryResponse = {
+    success?: boolean;
+};
+type AccountPaymentMethodChangeResponse = {
+    success?: boolean;
+};
+type AccountRecoveryExpiryCheckRequest = {
+    hash: string;
+};
+type AccountRecoveryExpiryCheckResponse = {
+    apiAlias?: "array_struct";
+    data?: {
+        isExpired: boolean;
+    };
+};
+type AccountUpdateRequest = {
+    salutationId?: string;
+    title?: string;
+    firstName: string;
+    lastName: string;
+    company?: string;
+    birthdayDay?: number;
+    birthdayMonth?: number;
+    birthdayYear?: number;
+};
+type AccountUpdateResponse = {
+    success?: boolean;
+};
+
+type AddressListRequest = Criteria;
+type AddressListResponse = Array<CustomerAddress>;
+type AddressCreateRequest = CustomerAddressBody;
+type AddressCreateResponse = CustomerAddress;
+type AddressUpdateRequest = CustomerAddressBody;
+type AddressUpdateResponse = CustomerAddressBody;
+
+type CartAddItemsRequest = {
+    items?: Array<LineItem>;
+};
+type CartAddItemsResponse = Cart;
+type CartRemoveItemsRequest = {
+    ids: Array<string>;
+};
+type CartRemoveItemsResponse = Cart;
+type CartUpdateItemsRequest = {
+    items?: Array<LineItem>;
+};
+type CartUpdateItemsResponse = Cart;
+type CartDeleteResponse = {
+    success?: boolean;
+};
+type CartGetOrCreateResponse = Cart;
+
+type CategoryListRequest = Criteria;
+type CategoryListResponse = EntitySearchResult & {
+    elements?: Array<Category>;
+};
+type CategorySingleRequest = Criteria;
+type CategorySingleResponse = Category;
+type NavigationMenuRequest = Criteria & {
+    depth?: number;
+    buildTree?: Array<object>;
+};
+type NavigationMenuResponse = Array<Category>;
+
+type CMSPageResolveResponse = CmsPage;
+type ContactFormSubmitRequest = {
+    salutationId: string;
+    firstName?: string;
+    lastName?: string;
+    email: string;
+    phone?: string;
+    subject: string;
+    comment: string;
+    navigationId?: string;
+    slotId?: string;
+    cmsPageType?: string;
+    entityName?: string;
+};
+type ContactFormSubmitResponse = {
+    success?: boolean;
+};
+type LandingPageResolveRequest = {
+    slots?: string;
+} & ProductListingCriteria;
+type LandingPageResolveResponse = LandingPage;
+type MediaEntityResolveRequest = {
+    ids: Array<string>;
+};
+type MediaEntityResolveResponse = Array<Media>;
+
+type ContextGetResponse = SalesChannelContext;
+type ContextUpdateRequest = {
+    currencyId?: string;
+    languageId?: string;
+    billingAddressId?: string;
+    shippingAddressId?: string;
+    paymentMethodId?: string;
+    shippingMethodId?: string;
+    countryId?: string;
+    countryStateId?: string;
+};
+type ContextUpdateResponse = {
+    redirectUrl?: string;
+};
+
+type CustomerLoginRequest = {
+    username: string;
+    password: string;
+};
+type CustomerLoginResponse = {
+    redirectUrl?: string;
+};
+type CustomerLogoutResponse = {
+    redirectUrl?: string;
+};
+type CustomerRegisterRequest = {
+    email: string;
+    password: string;
+    salutationId: string;
+    firstName: string;
+    lastName: string;
+    acceptedDataProtection: boolean;
+    storefrontUrl: string;
+    billingAddress: CustomerAddress;
+    shippingAddress?: CustomerAddress;
+    accountType?: "private" | "business";
+    guest?: boolean;
+    birthdayDay?: number;
+    birthdayMonth?: number;
+    birthdayYear?: number;
+    title?: string;
+    affiliateCode?: string;
+    campaignCode?: string;
+};
+type CustomerRegisterResponse = Customer;
+type CustomerRegisterGroupConfigResponse = CustomerGroup;
+type CustomerRegistrationConfirmRequest = {
+    hash: string;
+    em: string;
+};
+type CustomerLoginImitateRequest = {
+    token: string;
+    customerId: string;
+    userId: string;
+};
+type CustomerLoginImitateResponse = {
+    redirectUrl?: string;
+};
+
+type DocumentDownloadRequest = Criteria;
+type DocumentDownloadResponse = ShopwareDocument;
+
+type GatewayCheckoutResponse = {
+    paymentMethods?: {
+        total?: number;
+        aggregations?: object;
+        elements?: Array<PaymentMethod>;
+    };
+    shippingMethods?: {
+        total?: number;
+        aggregations?: object;
+        elements?: Array<ShippingMethod>;
+    };
+    errors?: Array<{
+        code?: string;
+        detail?: string;
+        blocking?: boolean;
+    }>;
+};
+
+type NewsletterConfirmRequest = {
+    hash: string;
+    em: string;
+};
+type NewsletterUpdateRequest = {
+    email: string;
+    option: "direct" | "subscribe" | "unsubscribe" | "confirmSubscribe";
+    storefrontUrl: string;
+    salutationId?: string;
+    firstName?: string;
+    lastName?: string;
+    street?: string;
+    city?: string;
+    zipCode?: string;
+    tags?: string;
+    languageId?: string;
+    customFields?: string;
+};
+type NewsletterUnsubscribeRequest = {
+    email: string;
+};
+
+type OrderCancelRequest = {
+    orderId: string;
+};
+type OrderCancelResponse = StateMachineState;
+type OrderDownloadFileResponse = Blob;
+type OrderFromCartRequest = {
+    customerComment?: string;
+    affiliateCode?: string;
+    campaignCode?: string;
+};
+type OrderFromCartResponse = Order;
+type OrderListRequest = Criteria & {
+    checkPromotion?: boolean;
+};
+type OrderListResponse = {
+    orders: Array<Order> & EntitySearchResult;
+    paymentChangeable: Record<string, boolean>;
+};
+type OrderUpdatePaymentMethodRequest = {
+    paymentMethodId: string;
+    orderId: string;
+};
+type OrderUpdatePaymentMethodResponse = {
+    success?: boolean;
+};
+
+type OrderPaymentInitiateRequest = {
+    orderId: string;
+    finishUrl?: string;
+    errorUrl?: string;
+};
+type OrderPaymentInitiateResponse = {
+    redirectUrl: string;
+};
+
+type ProductListRequest = Criteria;
+type ProductListResponse = EntitySearchResult & {
+    elements?: Array<Product>;
+};
+type ProductReviewListRequest = Criteria;
+type ProductReviewListResponse = EntitySearchResult & {
+    elements?: Array<ProductReview>;
+};
+type ProductReviewSaveRequest = {
+    name?: string;
+    email?: string;
+    title: string;
+    content: string;
+    points: number;
+};
+type ProductSearchRequest = {
+    search: string;
+} & ProductListingCriteria & ProductListingFlags;
+type ProductSearchResponse = ProductListingResult;
+type ProductSearchSuggestionListRequest = ProductListingFlags & {
+    search: string;
+};
+type ProductSearchSuggestionListResponse = ProductListingResult;
+type ProductSingleRequest = Criteria;
+type ProductSingleResponse = {
+    product: Product;
+    configurator?: Array<PropertyGroup>;
+    id?: any;
+    available?: any;
+    isCloseout?: any;
+    displayGroup?: any;
+    manufacturerNumber?: any;
+    stock?: any;
+    sortedProperties?: any;
+};
+type ProductVariantWithOptionsRequest = {
+    options: Array<string>;
+    switchedGroup?: string;
+};
+type ProductVariantWithOptionsResponse = {
+    foundCombination?: {
+        variantId?: string;
+        options: Array<string>;
+    };
+};
+type ProductListingListWithCategoryRequest = ProductListingCriteria & ProductListingFlags;
+type ProductListingListWithCategoryResponse = ProductListingResult;
+type ProductCrossSellingGroupListResponse = Array<CrossSellingElement>;
+
+type SeoRouteListRequest = Criteria;
+type SeoRouteListResponse = EntitySearchResult & {
+    elements?: Array<SeoUrlEntity>;
+};
+type SitemapDownloadResponse = Blob;
+type SitemapListResponse = Array<Sitemap>;
+
+type CountryListRequest = Criteria;
+type CountryListResponse = EntitySearchResult & {
+    elements?: Array<Country>;
+};
+type CountryStateListRequest = Criteria;
+type CountryStateListResponse = EntitySearchResult & {
+    elements?: Array<CountryState>;
+};
+type CurrencyListRequest = Criteria;
+type CurrencyListResponse = EntitySearchResult & {
+    elements?: Array<Currency>;
+};
+type LanguageListRequest = Criteria;
+type LanguageListResponse = EntitySearchResult & {
+    elements?: Array<Language>;
+};
+type SalutationListRequest = Criteria;
+type SalutationListResponse = EntitySearchResult & {
+    elements?: Array<Salutation>;
+};
+type ShippingMethodListRequest = Criteria;
+type ShippingMethodListResponse = EntitySearchResult & {
+    elements?: Array<ShippingMethod>;
+};
+type PaymentMethodListRequest = Criteria & {
+    onlyAvailable?: boolean;
+};
+type PaymentMethodListResponse = {
+    total?: number;
+    aggregations?: object;
+    elements?: Array<PaymentMethod>;
+};
+
+type WishlistGetRequest = Criteria;
+type WishlistGetResponse = {
+    wishlist?: {
+        customerId?: string;
+        salesChannelId?: string;
+    };
+    products?: ProductListingResult;
+};
+type WishlistMergeOrCreateRequest = {
+    productIds?: Array<string>;
+};
+type WishlistMergeOrCreateResponse = {
+    success?: boolean;
+};
+type WishlistProductAddResponse = {
+    success?: boolean;
+};
+type WishlistProductRemoveResponse = {
+    success?: boolean;
+};
+
+declare enum HTTPRequestMethod {
+    GET = "GET",
+    POST = "POST",
+    DELETE = "DELETE",
+    PATCH = "PATCH",
+    PUT = "PUT",
+    OPTIONS = "OPTIONS"
+}
+
+declare abstract class Payload<T> {
+    abstract contentType(): string;
+    abstract deserialize(data: Blob): Promise<void>;
+    abstract serialize(): T | undefined;
+}
+
+type ClientRequestOptions = {
+    method?: HTTPRequestMethod;
+    headers?: Record<string, string>;
+    body?: Payload<any>;
+    maxAge?: number;
+};
+
+type ClientResponse = {
+    statusCode: number;
+    statusMessage: string;
+    headers?: Headers;
+    body?: Payload<any>;
+};
+
+type RequestCacheEntry = {
+    cachedAt: number;
+    response: ClientResponse;
+};
+
+declare class Client {
+    protected readonly client: ShopwareClient;
+    constructor(client: ShopwareClient);
+    protected doRequest(method: HTTPRequestMethod, path: string, options?: ClientRequestOptions): Promise<ClientResponse>;
+    protected get(path: string, options?: ClientRequestOptions): Promise<ClientResponse>;
+    protected post(path: string, options?: ClientRequestOptions): Promise<ClientResponse>;
+    protected delete(path: string, options?: ClientRequestOptions): Promise<ClientResponse>;
+    protected patch(path: string, options?: ClientRequestOptions): Promise<ClientResponse>;
+    protected put(path: string, options?: ClientRequestOptions): Promise<ClientResponse>;
+    protected options(path: string, options?: ClientRequestOptions): Promise<ClientResponse>;
+    protected withContextToken(options?: ClientRequestOptions): ClientRequestOptions;
+    protected withOAuth(options?: ClientRequestOptions): Promise<ClientRequestOptions>;
+}
+
+declare class AccountClient extends Client {
+    getNewsletterRecipientList(request?: AccountNewsletterRecipientListRequest): Promise<AccountNewsletterRecipientListResponse>;
+    changeProfile(request: AccountUpdateRequest): Promise<AccountUpdateResponse>;
+    changeEmail(request: AccountEmailChangeRequest): Promise<AccountEmailChangeResponse>;
+    changeLanguage(request: AccountLanguageChangeRequest): Promise<AccountLanguageChangeResponse>;
+    changePassword(request: AccountPasswordChangeRequest): Promise<AccountPasswordChangeResponse>;
+    changePaymentMethod(paymentMethodId: string): Promise<AccountPaymentMethodChangeResponse>;
+    isCustomerRecoveryExpired(request: AccountRecoveryExpiryCheckRequest): Promise<AccountRecoveryExpiryCheckResponse>;
+    getCustomer(request?: AccountGetRequest): Promise<AccountGetResponse>;
+    deleteCustomer(): Promise<undefined>;
+    confirmRecoveryPassword(request: AccountPasswordRecoveryRequest): Promise<AccountPasswordRecoveryResponse>;
+    requestPasswordRecoveryMail(request: AccountPasswordRecoveryMailRequest): Promise<AccountPasswordRecoveryMailResponse>;
+}
+
+declare class AddressClient extends Client {
+    deleteAddress(addressId: string): Promise<undefined>;
+    updateAddress(addressId: string, request: AddressUpdateRequest): Promise<AddressUpdateResponse>;
+    getAddressList(request?: AddressListRequest): Promise<AddressListResponse>;
+    changeDefaultShippingAddress(addressId: string): Promise<undefined>;
+    changeDefaultBillingAddress(addressId: string): Promise<undefined>;
+    createAddress(request: AddressCreateRequest): Promise<AddressCreateResponse>;
+}
+
+declare class CartClient extends Client {
+    getOrCreateCart(): Promise<CartGetOrCreateResponse>;
+    deleteCart(): Promise<CartDeleteResponse>;
+    addLineItemsToCart(request: CartAddItemsRequest): Promise<CartAddItemsResponse>;
+    removeLineItemsFromCart(request: CartRemoveItemsRequest): Promise<CartRemoveItemsResponse>;
+    updateLineItemsInCart(request: CartUpdateItemsRequest): Promise<CartUpdateItemsResponse>;
+}
+
+declare class CategoryClient extends Client {
+    getCategoryList(request?: CategoryListRequest): Promise<CategoryListResponse>;
+    getCategory(categoryId: string, includeSeoUrls: boolean, request: CategorySingleRequest): Promise<CategorySingleResponse>;
+    getNavigationMenu(activeId: string, rootId: string, includeSeoUrls: boolean, request?: NavigationMenuRequest): Promise<NavigationMenuResponse>;
+}
+
+declare class ContentClient extends Client {
+    submitContactForm(request: ContactFormSubmitRequest): Promise<ContactFormSubmitResponse>;
+    resolveCMSPage(id: string): Promise<CMSPageResolveResponse>;
+    resolveMedia(request: MediaEntityResolveRequest): Promise<MediaEntityResolveResponse>;
+    resolveLandingPage(landingPageId: string, request: LandingPageResolveRequest): Promise<LandingPageResolveResponse>;
+}
+
+declare class ContextClient extends Client {
+    getContext(): Promise<ContextGetResponse>;
+    updateContext(context: ContextUpdateRequest): Promise<ContextUpdateResponse>;
+}
+
+declare class CustomerAuthenticationClient extends Client {
+    login(request: CustomerLoginRequest): Promise<CustomerLoginResponse>;
+    imitateLogin(request: CustomerLoginImitateRequest): Promise<CustomerLoginImitateResponse>;
+    logout(): Promise<CustomerLogoutResponse>;
+    confirmRegistration(request: CustomerRegistrationConfirmRequest): Promise<undefined>;
+    register(request: CustomerRegisterRequest): Promise<CustomerRegisterResponse>;
+    getRegistrationSettingsForGroup(customerGroupId: string): Promise<CustomerRegisterGroupConfigResponse>;
+}
+
+declare class DocumentClient extends Client {
+    downloadDocument(deepLinkCode: string, documentId: string, request: DocumentDownloadRequest): Promise<DocumentDownloadResponse>;
+}
+
+declare class GatewayClient extends Client {
+    checkout(): Promise<GatewayCheckoutResponse>;
+}
+
+declare class NewsletterClient extends Client {
+    confirmSubscription(request: NewsletterConfirmRequest): Promise<undefined>;
+    updateSubscription(request: NewsletterUpdateRequest): Promise<undefined>;
+    unsubscribe(request: NewsletterUnsubscribeRequest): Promise<undefined>;
+}
+
+declare class OrderClient extends Client {
+    cancelOrder(request: OrderCancelRequest): Promise<OrderCancelResponse>;
+    getOrderList(request?: OrderListRequest): Promise<OrderListResponse>;
+    updateOrderPaymentMethod(request: OrderUpdatePaymentMethodRequest): Promise<OrderUpdatePaymentMethodResponse>;
+    downloadPurchasedFile(downloadId: string, orderId: string): Promise<OrderDownloadFileResponse>;
+    createOrderFromCart(request?: OrderFromCartRequest): Promise<OrderFromCartResponse>;
+}
+
+declare class PaymentClient extends Client {
+    initiateOrderPayment(request: OrderPaymentInitiateRequest): Promise<OrderPaymentInitiateResponse>;
+}
+
+declare class ProductClient extends Client {
+    getProductListingByCategory(categoryId: string, request?: ProductListingListWithCategoryRequest): Promise<ProductListingListWithCategoryResponse>;
+    getCrossSellingGroupsForProduct(productId: string): Promise<ProductCrossSellingGroupListResponse>;
+    getProduct(productId: string, includeSeoUrls: boolean, request?: ProductSingleRequest): Promise<ProductSingleResponse>;
+    getProductList(request?: ProductListRequest): Promise<ProductListResponse>;
+    getReviewsForProduct(productId: string, request?: ProductReviewListRequest): Promise<ProductReviewListResponse>;
+    saveReviewForProduct(productId: string, request: ProductReviewSaveRequest): Promise<undefined>;
+    findProductVariantWithOptions(productId: string, request: ProductVariantWithOptionsRequest): Promise<ProductVariantWithOptionsResponse>;
+    searchProducts(request: ProductSearchRequest): Promise<ProductSearchResponse>;
+    getSearchSuggestions(request: ProductSearchSuggestionListRequest): Promise<ProductSearchSuggestionListResponse>;
+}
+
+declare class SeoClient extends Client {
+    getSeoRouteList(request?: SeoRouteListRequest): Promise<SeoRouteListResponse>;
+    fetchSitemapList(): Promise<SitemapListResponse>;
+    downloadSitemap(filePath: string): Promise<SitemapDownloadResponse>;
+}
+
+declare class SystemClient extends Client {
+    getLanguageList(request?: LanguageListRequest): Promise<LanguageListResponse>;
+    getSalutationList(request?: SalutationListRequest): Promise<SalutationListResponse>;
+    getCurrencyList(request?: CurrencyListRequest): Promise<CurrencyListResponse>;
+    getCountryStateList(countryId: string, request?: CountryStateListRequest): Promise<CountryStateListResponse>;
+    getCountryList(request?: CountryListRequest): Promise<CountryListResponse>;
+    getShippingMethodList(request?: ShippingMethodListRequest): Promise<ShippingMethodListResponse>;
+    getPaymentMethodList(request?: PaymentMethodListRequest): Promise<PaymentMethodListResponse>;
+}
+
+declare class WishlistClient extends Client {
+    addProductToWishlist(productId: string): Promise<WishlistProductAddResponse>;
+    getWishlist(request?: WishlistGetRequest): Promise<WishlistGetResponse>;
+    mergeOrCreateWishlist(request: WishlistMergeOrCreateRequest): Promise<WishlistMergeOrCreateResponse>;
+    removeProductFromWishlist(productId: string): Promise<WishlistProductRemoveResponse>;
+}
+
+interface AuthenticationEntry {
+    getType(): AuthenticationType;
+    isSaved(): boolean;
+    save(response: ClientResponse): void;
+    clear(): void;
+    load(): ClientRequestOptions;
+}
+
+declare enum AuthenticationType {
+    CONTEXT_TOKEN = "context_token",
+    OAUTH = "oauth"
+}
+
+declare class AuthenticationStore {
+    entries: Map<AuthenticationType, AuthenticationEntry>;
+    getOrCreateEntry(entry: AuthenticationEntry): AuthenticationEntry;
+    getEntry(type: AuthenticationType): AuthenticationEntry | undefined;
+}
+
+declare class ShopwareClient {
+    private readonly baseUrl;
+    private readonly apiKey;
+    readonly authStore: AuthenticationStore;
+    readonly cache: Map<string, RequestCacheEntry>;
+    constructor(baseUrl: string, apiKey: string);
+    doRequest(path: string, options?: ClientRequestOptions): Promise<ClientResponse>;
+    private parseBody;
+    withContextToken(options: ClientRequestOptions): ClientRequestOptions;
+    withOAuth(options: ClientRequestOptions): Promise<ClientRequestOptions>;
+    forAccount(): AccountClient;
+    forAddress(): AddressClient;
+    forCart(): CartClient;
+    forCategory(): CategoryClient;
+    forContent(): ContentClient;
+    forContext(): ContextClient;
+    forCustomerAuthentication(): CustomerAuthenticationClient;
+    forDocument(): DocumentClient;
+    forGateway(): GatewayClient;
+    forNewsletter(): NewsletterClient;
+    forOrder(): OrderClient;
+    forPayment(): PaymentClient;
+    forProduct(): ProductClient;
+    forSeo(): SeoClient;
+    forSystem(): SystemClient;
+    forWishlist(): WishlistClient;
+}
+
+export { ShopwareClient };