@devite/shopware-client 1.8.0 → 1.9.1

package/dist/types/api/store/product/Product.d.ts

@@ -2,14 +2,10 @@ import { GenericRecord } from "#types/api/global/GenericRecord";
 import { CalculatedPrice } from "../price/CalculatedPrice";
 import { ProductDownload } from "./ProductDownload";
 import { DeliveryTime } from "../DeliveryTime";
-import { Tax } from "../Tax";
-import { ProductManufacturer } from "./ProductManufacturer";
-import { Unit } from "../Unit";
 import { ProductMedia } from "../media/ProductMedia";
 import { CmsPage } from "../cms/CmsPage";
 import { ProductCrossSelling } from "./crossSelling/ProductCrossSelling";
-import { ProductConfiguratorSetting } from "./ProductConfiguratorSetting";
-import { ProductReview } from "./review/ProductReview";
+import { ProductReview } from "./ProductReview";
 import { MainCategory } from "../category/MainCategory";
 import { SeoUrlEntity } from "../seo/SeoUrlEntity";
 import { PropertyGroupOption } from "#types/api/store/propertyGroup/PropertyGroupOption";
@@ -20,94 +16,63 @@ export interface Product {
     apiAlias: "product";
     id: string;
     versionId?: string;
+    readonly createdAt: string;
+    readonly updatedAt?: 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;
+    readonly childCount?: number;
+    children?: Array<Product>;
     active?: boolean;
-    readonly available?: boolean;
-    isCloseout?: boolean;
-    readonly availableStock?: number;
-    stock: number;
+    type: "physical" | "digital";
+    productNumber: string;
     readonly displayGroup?: string;
-    manufacturerNumber?: string;
-    ean?: string;
+    markAsTopseller?: boolean;
+    readonly sales?: number;
+    stock: number;
+    readonly availableStock?: number;
+    restockTime: number;
     purchaseSteps?: number;
     maxPurchase?: number;
     minPurchase?: number;
     purchaseUnit?: number;
     referenceUnit?: number;
-    shippingFree?: boolean;
-    markAsTopseller?: boolean;
-    weight?: number;
+    length?: number;
     width?: number;
     height?: number;
-    length?: number;
-    releaseDate?: string;
-    readonly ratingAverage?: number;
-    readonly categoryTree?: Array<string>;
+    weight?: number;
+    deliveryTimeId?: string;
+    deliveryTime?: DeliveryTime;
+    name: string;
+    description?: string;
+    coverId?: string;
+    cover?: ProductMedia;
+    media?: Array<ProductMedia>;
+    readonly tagIds?: Array<string>;
+    tags?: Array<Tag>;
     readonly propertyIds?: Array<string>;
+    properties?: Array<PropertyGroupOption>;
     readonly optionIds?: Array<string>;
+    options?: Array<PropertyGroupOption>;
     readonly streamIds?: Array<string>;
-    readonly tagIds?: Array<string>;
+    streams?: Array<ProductStream>;
+    readonly ratingAverage?: number;
+    productReviews?: Array<ProductReview>;
+    crossSellings?: Array<ProductCrossSelling>;
     readonly categoryIds?: Array<string>;
-    readonly childCount?: number;
-    readonly sales?: number;
-    readonly states?: Array<string>;
+    categories?: Array<Category>;
+    mainCategories?: Array<MainCategory>;
+    metaTitle?: string;
     metaDescription?: string;
-    name: string;
     keywords?: string;
-    description?: string;
-    metaTitle?: string;
-    packUnit?: string;
-    packUnitPlural?: string;
-    customFields?: GenericRecord;
+    seoUrls?: Array<SeoUrlEntity>;
+    seoCategory: Category;
     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;
+    cmsPageId?: string;
+    cmsPageVersionId?: string;
     cmsPage?: CmsPage;
-    canonicalProduct?: Product;
-    media?: Array<ProductMedia>;
-    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;
+    customFields?: GenericRecord;
+    translated?: Record<string, any>;
 }

package/dist/types/api/store/product/ProductDownload.d.ts

@@ -4,13 +4,13 @@ import { Media } from "../media/Media";
 export interface ProductDownload {
     id: string;
     versionId?: string;
+    readonly createdAt: string;
+    readonly updatedAt?: string;
+    position?: number;
     productId: string;
     productVersionId?: string;
-    mediaId: string;
-    position?: number;
-    customFields?: GenericRecord;
-    readonly createdAt?: string;
-    readonly updatedAt?: string;
     product?: Product;
+    mediaId: string;
     media?: Media;
+    customFields?: GenericRecord;
 }

package/dist/types/api/store/product/ProductListingResult.d.ts

@@ -1,9 +1,9 @@
 import { Product } from "./Product";
+import { Aggregation } from "#types/api/global";
 export type ProductListingResult = {
     apiAlias: "product_listing";
-    entity?: "product";
+    aggregations?: Array<Aggregation>;
     total?: number;
-    aggregations?: Array<object>;
     page?: number;
     limit?: number;
     currentFilters: Array<{
@@ -18,15 +18,13 @@ export type ProductListingResult = {
         properties: Array<string>;
         search: string;
     }>;
+    sorting?: string;
     availableSortings: Array<{
         apiAlias: "product_sorting";
         label: string;
-        translated: {
-            label: string;
-        };
         key: string;
         priority: number;
+        translated?: Record<string, string>;
     }>;
-    sorting?: string;
     elements: Array<Product>;
 };

package/dist/types/api/store/product/{review/ProductReview.d.ts → ProductReview.d.ts}

@@ -1,16 +1,14 @@
 import { GenericRecord } from "#types/api/global/GenericRecord";
 export interface ProductReview {
     id: string;
-    productId: string;
-    productIdVersionId?: string;
-    salesChannelId: string;
-    languageId: string;
+    readonly createdAt: string;
+    readonly updatedAt?: string;
+    status?: boolean;
+    points?: number;
     title: string;
     content: string;
-    points?: number;
-    status?: boolean;
     comment?: string;
+    productId: string;
+    productIdVersionId?: string;
     customFields?: GenericRecord;
-    readonly createdAt?: string;
-    readonly updatedAt?: string;
 }

package/dist/types/api/store/product/ProductStream.d.ts

@@ -1,10 +1,10 @@
 import { GenericRecord } from "#types/api/global/GenericRecord";
 export interface ProductStream {
     id: string;
+    readonly createdAt: string;
+    readonly updatedAt?: string;
     name: string;
     description?: string;
     customFields?: GenericRecord;
-    readonly createdAt?: string;
-    readonly updatedAt?: string;
-    translated?: object;
+    translated?: Record<string, any>;
 }

package/dist/types/api/store/product/crossSelling/CrossSellingElement.d.ts

@@ -2,8 +2,8 @@ import { ProductCrossSelling } from "./ProductCrossSelling";
 import { Product } from "../Product";
 export interface CrossSellingElement {
     apiAlias: "cross_selling_element";
-    crossSelling: Array<ProductCrossSelling>;
-    products: Array<Product>;
     total: number;
     streamId: string;
+    products: Array<Product>;
+    crossSelling: Array<ProductCrossSelling>;
 }

package/dist/types/api/store/product/crossSelling/ProductCrossSelling.d.ts

@@ -1,13 +1,13 @@
 export interface ProductCrossSelling {
     id: string;
+    readonly createdAt: string;
+    readonly updatedAt?: string;
+    active?: boolean;
+    type?: string;
+    limit?: number;
     name: string;
     position?: number;
     sortBy?: string;
     sortDirection?: string;
-    type?: string;
-    active?: boolean;
-    limit?: number;
-    readonly createdAt?: string;
-    readonly updatedAt?: string;
-    translated?: object;
+    translated?: Record<string, any>;
 }

package/dist/types/api/store/product/index.d.ts

@@ -1,7 +1,5 @@
 export * from "./crossSelling";
 export { Product } from "./Product";
-export { ProductConfiguratorSetting } from "./ProductConfiguratorSetting";
 export { ProductDownload } from "./ProductDownload";
 export { ProductListingResult } from "./ProductListingResult";
-export { ProductManufacturer } from "./ProductManufacturer";
 export { ProductStream } from "./ProductStream";

package/dist/types/api/store/propertyGroup/PropertyGroup.d.ts

@@ -2,16 +2,14 @@ import { GenericRecord } from "#types/api/global/GenericRecord";
 import { PropertyGroupOption } from "./PropertyGroupOption";
 export interface PropertyGroup {
     id: string;
-    name: string;
-    description?: string;
+    readonly createdAt: string;
+    readonly updatedAt?: string;
     displayType?: "text" | "image" | "dropdown" | "color";
-    sortingType?: "name" | "position";
-    filterable?: boolean;
-    visibleOnProductDetailPage?: boolean;
     position?: number;
+    visibleOnProductDetailPage?: boolean;
+    name: string;
+    description?: string;
     customFields?: GenericRecord;
-    readonly createdAt?: string;
-    readonly updatedAt?: string;
-    translated?: object;
     options?: Array<PropertyGroupOption>;
+    translated?: Record<string, any>;
 }

package/dist/types/api/store/propertyGroup/PropertyGroupOption.d.ts

@@ -4,16 +4,16 @@ import { PropertyGroup } from "./PropertyGroup";
 export interface PropertyGroupOption {
     apiAlias: "property_group_option";
     id: string;
-    groupId: string;
+    readonly createdAt: string;
+    readonly updatedAt?: string;
     name: string;
+    option: string;
     position?: number;
     colorHexCode?: string;
     mediaId?: string;
-    customFields?: GenericRecord;
-    readonly createdAt?: string;
-    readonly updatedAt?: string;
-    translated?: object;
     media?: Media;
+    groupId: string;
     group: PropertyGroup;
-    option: string;
+    customFields?: GenericRecord;
+    translated?: Record<string, any>;
 }

package/dist/types/api/store/salesChannel/SalesChannel.d.ts

@@ -1,24 +1,34 @@
+import { Rounding } from "#types/api/global/Rounding";
+import { PaymentMethod } from "../PaymentMethod";
+import { ShippingMethod } from "../shippingMethod/ShippingMethod";
+import { GenericRecord } from "#types/api/global/GenericRecord";
+import { Country } from "../country/Country";
+import { Currency } from "../Currency";
+import { Language } from "../locale/Language";
 export interface SalesChannel {
     id: string;
-    typeId: string;
+    readonly createdAt: string;
+    readonly updatedAt?: string;
+    active?: boolean;
+    name: string;
+    hreflangActive?: boolean;
+    itemRounding?: Rounding;
+    totalRounding?: Rounding;
     languageId: string;
+    language?: Language;
+    languages?: Array<Language>;
+    countries?: Array<Country>;
     currencyId: string;
+    currencyIds?: Array<string>;
+    currencies?: Array<Currency>;
     paymentMethodId: string;
+    paymentMethod?: PaymentMethod;
+    paymentMethodIds?: Array<string>;
+    paymentMethods?: Array<PaymentMethod>;
     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;
+    shippingMethod?: ShippingMethod;
+    shippingMethodIds?: Array<string>;
+    shippingMethods?: Array<ShippingMethod>;
+    customFields?: GenericRecord;
+    translated?: Record<string, any>;
 }

package/dist/types/api/store/salesChannel/SalesChannelContext.d.ts

@@ -3,41 +3,28 @@ import { CustomerGroup } from "../customer/CustomerGroup";
 import { SalesChannel } from "./SalesChannel";
 import { Customer } from "../customer/Customer";
 import { PaymentMethod } from "../PaymentMethod";
-import { CartDeliveryShippingLocation } from "../cart/delivery/CartDeliveryShippingLocation";
 import { ShippingMethod } from "../shippingMethod/ShippingMethod";
 import { PricingCashRoundingConfig } from "#types/api/global/dal/PricingCashRoundingConfig";
 export interface SalesChannelContext {
     apiAlias: "sales_channel_context";
+    token?: string;
+    imitatingUserId?: string;
+    customer?: Customer;
+    currentCustomerGroup?: CustomerGroup;
+    fallbackCustomerGroup?: CustomerGroup;
     context?: {
         apiAlias: "context";
-        considerInheritance?: boolean;
-        versionId?: string;
-        currencyId?: string;
+        taxState?: "gross" | "net";
         currencyFactor?: number;
         currencyPrecision?: number;
-        languageIdChain?: Array<string>;
-        rounding?: PricingCashRoundingConfig;
-        scope?: string;
-        source?: any;
-        taxState?: "gross" | "net";
     };
     currency?: Currency;
-    currentCustomerGroup?: CustomerGroup;
-    fallbackCustomerGroup?: CustomerGroup;
-    customer?: Customer;
-    imitatingUserId?: string;
-    itemRounding?: PricingCashRoundingConfig;
     languageInfo: {
         localeCode: string;
         name: string;
     };
-    paymentMethod?: PaymentMethod;
     salesChannel?: SalesChannel;
-    shippingLocation?: CartDeliveryShippingLocation;
+    paymentMethod?: PaymentMethod;
     shippingMethod?: ShippingMethod;
-    taxRules?: Array<{
-        taxRate?: number;
-        name?: string;
-    }>;
-    token?: string;
+    itemRounding?: PricingCashRoundingConfig;
 }

package/dist/types/api/store/seo/SeoUrlEntity.d.ts

@@ -1,18 +1,16 @@
 import { GenericRecord } from "#types/api/global/GenericRecord";
 export interface SeoUrlEntity {
     id: string;
-    salesChannelId?: string;
-    languageId: string;
-    foreignKey: string;
-    routeName: "frontend.navigation.page" | "frontend.landing.page" | "frontend.detail.page";
+    readonly createdAt: string;
+    readonly updatedAt?: string;
+    url?: string;
     pathInfo: string;
     seoPathInfo: string;
     isCanonical?: boolean;
     isModified?: boolean;
     isDeleted?: boolean;
+    languageId: string;
+    routeName: "frontend.navigation.page" | "frontend.landing.page" | "frontend.detail.page";
     error?: string;
-    url?: string;
     customFields?: GenericRecord;
-    readonly createdAt?: string;
-    readonly updatedAt?: string;
 }

package/dist/types/api/store/shippingMethod/ShippingMethod.d.ts

@@ -1,29 +1,24 @@
 import { GenericRecord } from "#types/api/global/GenericRecord";
-import { DeliveryTime } from "../DeliveryTime";
 import { Rule } from "../Rule";
 import { ShippingMethodPrice } from "./ShippingMethodPrice";
 import { Media } from "../media/Media";
 import { Tag } from "../Tag";
-import { Tax } from "../Tax";
 export interface ShippingMethod {
     id: string;
-    name: string;
+    readonly createdAt: string;
+    readonly updatedAt?: string;
     active?: boolean;
-    position?: number;
-    customFields?: GenericRecord;
-    mediaId?: string;
-    deliveryTimeId: string;
-    taxType?: "Free" | "Net" | "Gross";
+    technicalName?: string;
+    name: string;
     description?: string;
+    position?: number;
     trackingUrl?: string;
-    technicalName?: string;
-    readonly createdAt?: string;
-    readonly updatedAt?: string;
-    translated?: object;
-    deliveryTime?: DeliveryTime;
-    availabilityRule?: Rule;
-    prices?: Array<ShippingMethodPrice>;
+    mediaId?: string;
     media?: Media;
     tags?: Array<Tag>;
-    tax?: Tax;
+    prices?: Array<ShippingMethodPrice>;
+    availabilityRuleId?: string;
+    availabilityRule?: Rule;
+    customFields?: GenericRecord;
+    translated?: Record<string, any>;
 }

package/dist/types/api/store/shippingMethod/ShippingMethodPrice.d.ts

@@ -1,15 +1,16 @@
 import { Price } from "#types/api/global/price/Price";
 import { GenericRecord } from "#types/api/global/GenericRecord";
+import { Rule } from "../Rule";
 export interface ShippingMethodPrice {
     id: string;
-    shippingMethodId: string;
+    readonly createdAt: string;
+    readonly updatedAt?: string;
     ruleId?: string;
     calculation?: number;
-    calculationRuleId?: string;
     quantityStart?: number;
     quantityEnd?: number;
     currencyPrice: Array<Price>;
     customFields?: GenericRecord;
-    readonly createdAt?: string;
-    readonly updatedAt?: string;
+    calculationRuleId?: string;
+    calculationRule?: Rule;
 }

package/dist/types/clients/admin/MailClient.d.ts

@@ -1,23 +1,22 @@
 /** Operations **/
 export interface MailSendRequest {
-    recipients: Record<string, string>;
     salesChannelId: string;
-    contentHtml: string;
-    contentPlain: string;
-    subject: string;
+    recipients: Record<string, string>;
+    recipientsBcc?: Record<string, string>;
+    recipientsCc?: Record<string, string>;
     senderName: string;
     senderEmail?: string;
+    replyTo?: Record<string, string>;
+    subject: string;
+    contentHtml: string;
+    contentPlain: string;
+    documentIds?: Array<string>;
     mediaIds?: Array<string>;
     binAttachments?: Array<{
         content?: string;
         fileName?: string;
         mimeType?: string;
     }>;
-    recipientsBcc?: Record<string, string>;
-    recipientsCc?: Record<string, string>;
-    replyTo?: Record<string, string>;
-    returnPath?: Record<string, string>;
-    documentIds?: Array<string>;
     mailTemplateData?: Record<string, any>;
 }
 export interface MailSendResponse {

package/dist/types/clients/admin/OrderClient.d.ts

@@ -1,4 +1,4 @@
-import { ShopwareDocumentBaseConfig } from "#types/api/admin/document/baseConfig/ShopwareDocumentBaseConfig";
+import { ShopwareDocumentBaseConfig } from "#types/api/admin/document/ShopwareDocumentBaseConfig";
 import { StateMachineTransition } from "#types/api/admin/stateMachine/StateMachineTransition";
 /** Document Management **/
 export interface DownloadMergedRequest {

package/dist/types/clients/store/AccountClient.d.ts

@@ -1,6 +1,6 @@
 import { Criteria } from "#types/api/global/query/Criteria";
 import { Customer } from "#types/api/store/customer/Customer";
-import { CustomerAddress } from "#types/api/store/customer/address/CustomerAddress";
+import { CustomerAddressBody } from "#types/api/store/customer/address/CustomerAddressBody";
 import { CustomerGroup } from "#types/api/store";
 import { GenericRecord } from "#types/api/global";
 export interface AccountEmailChangeRequest {
@@ -63,8 +63,8 @@ export interface AccountUpdateRequest {
     accountType?: "private" | "business";
     salutationId?: string;
     title?: string;
-    firstName: string;
-    lastName: string;
+    firstName?: string;
+    lastName?: string;
     company?: string;
     birthdayDay?: number;
     birthdayMonth?: number;
@@ -83,8 +83,8 @@ export interface CustomerRegisterRequest {
     lastName: string;
     acceptedDataProtection: boolean;
     storefrontUrl: string;
-    billingAddress: CustomerAddress;
-    shippingAddress?: CustomerAddress;
+    billingAddress: CustomerAddressBody;
+    shippingAddress?: CustomerAddressBody;
     guest?: boolean;
     birthdayDay?: number;
     birthdayMonth?: number;

package/dist/types/clients/store/AddressClient.d.ts

@@ -4,8 +4,8 @@ import { CustomerAddressBody } from "#types/api/store/customer/address/CustomerA
 import { EntitySearchResult } from "#types/api/store/EntitySearchResult";
 export type AddressCreateRequest = CustomerAddressBody;
 export type AddressCreateResponse = CustomerAddress;
-export type AddressUpdateRequest = CustomerAddressBody;
-export type AddressUpdateResponse = CustomerAddressBody;
+export type AddressUpdateRequest = Partial<CustomerAddressBody>;
+export type AddressUpdateResponse = CustomerAddress;
 export type AddressListRequest = Criteria;
 export type AddressListResponse = EntitySearchResult & {
     elements?: Array<CustomerAddress>;

package/dist/types/clients/store/ProductClient.d.ts

@@ -1,9 +1,8 @@
 import { EntitySearchResult } from "#types/api/store/EntitySearchResult";
 import { Criteria } from "#types/api/global/query/Criteria";
 import { Product } from "#types/api/store/product/Product";
-import { ProductReview } from "#types/api/store/product/review/ProductReview";
+import { ProductReview } from "#types/api/store/product/ProductReview";
 import { ProductListingCriteria } from "#types/api/global/query/product/ProductListingCriteria";
-import { ProductListingFlags } from "#types/api/global/query/product/ProductListingFlags";
 import { ProductListingResult } from "#types/api/store/product/ProductListingResult";
 import { PropertyGroup } from "#types/api/store/propertyGroup/PropertyGroup";
 import { CrossSellingElement } from "#types/api/store/product/crossSelling/CrossSellingElement";
@@ -22,11 +21,11 @@ export type ProductReviewSaveRequest = {
     content: string;
     points: number;
 };
-export interface ProductSearchRequest extends ProductListingCriteria, ProductListingFlags {
+export interface ProductSearchRequest extends ProductListingCriteria {
     search: string;
 }
 export type ProductSearchResponse = ProductListingResult;
-export interface ProductSearchSuggestionListRequest extends ProductListingFlags {
+export interface ProductSearchSuggestionListRequest {
     search: string;
 }
 export type ProductSearchSuggestionListResponse = ProductListingResult;
@@ -52,6 +51,6 @@ export interface ProductVariantWithOptionsResponse {
         options: Array<string>;
     };
 }
-export type ProductListingListWithCategoryRequest = ProductListingCriteria & ProductListingFlags;
+export type ProductListingListWithCategoryRequest = ProductListingCriteria;
 export type ProductListingListWithCategoryResponse = ProductListingResult;
 export type ProductCrossSellingGroupListResponse = Array<CrossSellingElement>;