@devite/shopware-client 1.0.0

package/dist/types/storeApi/media/MediaThumbnail.d.ts

@@ -0,0 +1,12 @@
+import { GenericRecord } from "../GenericRecord";
+export type MediaThumbnail = {
+    id: string;
+    mediaId: string;
+    readonly width: number;
+    readonly height: number;
+    url: string;
+    path?: string;
+    customFields?: GenericRecord;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+};

package/dist/types/storeApi/media/ProductMedia.d.ts

@@ -0,0 +1,15 @@
+import { GenericRecord } from "../GenericRecord";
+import { Media, MediaThumbnail } from ".";
+export 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;
+};

package/dist/types/storeApi/media/index.d.ts

@@ -0,0 +1,3 @@
+export { Media } from "./Media";
+export { MediaThumbnail } from "./MediaThumbnail";
+export { ProductMedia } from "./ProductMedia";

package/dist/types/storeApi/order/Order.d.ts

@@ -0,0 +1,58 @@
+import { CalculatedPrice } from "../price";
+import { GenericRecord } from "../GenericRecord";
+import { StateMachineState } from "../StateMachineState";
+import { OrderAddress, OrderCustomer, OrderDelivery, OrderLineItem, OrderTransaction } from ".";
+import { Currency } from "../Currency";
+import { Language } from "../locale";
+import { ShopwareDocument } from "../document";
+import { Tag } from "../Tag";
+export 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;
+};

package/dist/types/storeApi/order/OrderAddress.d.ts

@@ -0,0 +1,8 @@
+import { CustomerAddressBody } from "../customer";
+export type OrderAddress = CustomerAddressBody & {
+    id: string;
+    versionId?: string;
+    vatId?: string;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+};

package/dist/types/storeApi/order/OrderCustomer.d.ts

@@ -0,0 +1,18 @@
+import { GenericRecord } from "../GenericRecord";
+import { Salutation } from "../Salutation";
+export 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;
+};

package/dist/types/storeApi/order/OrderDelivery.d.ts

@@ -0,0 +1,24 @@
+import { CalculatedPrice } from "../price";
+import { StateMachineState } from "../StateMachineState";
+import { OrderAddress, OrderDeliveryPosition } from ".";
+import { ShippingMethod } from "../shippingMethod";
+export 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>;
+};

package/dist/types/storeApi/order/OrderDeliveryPosition.d.ts

@@ -0,0 +1,17 @@
+import { CalculatedPrice } from "../price";
+import { GenericRecord } from "../GenericRecord";
+export 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;
+};

package/dist/types/storeApi/order/OrderLineItem.d.ts

@@ -0,0 +1,43 @@
+import { LineItemPayload } from "../lineItem";
+import { CartPriceQuantity } from "../price";
+import { GenericRecord } from "../GenericRecord";
+import { Media } from "../media";
+import { OrderDeliveryPosition, OrderLineItemDownload } from ".";
+export 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;
+};

package/dist/types/storeApi/order/OrderLineItemDownload.d.ts

@@ -0,0 +1,17 @@
+import { GenericRecord } from "../GenericRecord";
+import { OrderLineItem } from ".";
+import { Media } from "../media";
+export 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;
+};

package/dist/types/storeApi/order/OrderReturn.d.ts

@@ -0,0 +1,14 @@
+import { CalculatedPrice } from "../price";
+export type OrderReturn = {
+    id?: string;
+    versionId?: string;
+    orderId?: string;
+    orderVersionId?: string;
+    price?: CalculatedPrice;
+    shippingCosts?: CalculatedPrice;
+    stateId?: string;
+    returnNumber?: string;
+    requestedAt?: string;
+    amountTotal?: number;
+    amountNet?: number;
+};

package/dist/types/storeApi/order/OrderReturnLineItem.d.ts

@@ -0,0 +1,14 @@
+export type OrderReturnLineItem = {
+    id?: any;
+    versionId?: any;
+    orderReturnId?: any;
+    orderReturnVersionId?: any;
+    orderLineItemId?: any;
+    orderLineItemVersionId?: any;
+    reasonId?: any;
+    quantity?: any;
+    refundAmount?: any;
+    restockQuantity?: any;
+    customFields?: any;
+    stateId?: any;
+};

package/dist/types/storeApi/order/OrderReturnLineItemReason.d.ts

@@ -0,0 +1,6 @@
+export type OrderReturnLineItemReason = {
+    id?: any;
+    reasonKey?: any;
+    content?: any;
+    translated?: any;
+};

package/dist/types/storeApi/order/OrderTransaction.d.ts

@@ -0,0 +1,22 @@
+import { CalculatedPrice } from "../price";
+import { GenericRecord } from "../GenericRecord";
+import { StateMachineState } from "../StateMachineState";
+import { PaymentMethod } from "../PaymentMethod";
+import { OrderTransactionCapture } from ".";
+export 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;
+};

package/dist/types/storeApi/order/OrderTransactionCapture.d.ts

@@ -0,0 +1,20 @@
+import { CalculatedPrice } from "../price";
+import { GenericRecord } from "../GenericRecord";
+import { StateMachineState } from "../StateMachineState";
+import { OrderTransaction, OrderTransactionCaptureRefund } from ".";
+export 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;
+};

package/dist/types/storeApi/order/OrderTransactionCaptureRefund.d.ts

@@ -0,0 +1,21 @@
+import { CalculatedPrice } from "../price";
+import { GenericRecord } from "../GenericRecord";
+import { StateMachineState } from "../StateMachineState";
+import { OrderTransactionCapture, OrderTransactionCaptureRefundPosition } from ".";
+export 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;
+};

package/dist/types/storeApi/order/OrderTransactionCaptureRefundPosition.d.ts

@@ -0,0 +1,21 @@
+import { CalculatedPrice } from "../price";
+import { GenericRecord } from "../GenericRecord";
+import { OrderLineItem, OrderTransactionCaptureRefund } from ".";
+export 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;
+};

package/dist/types/storeApi/order/index.d.ts

@@ -0,0 +1,14 @@
+export { Order } from "./Order";
+export { OrderAddress } from "./OrderAddress";
+export { OrderCustomer } from "./OrderCustomer";
+export { OrderDelivery } from "./OrderDelivery";
+export { OrderDeliveryPosition } from "./OrderDeliveryPosition";
+export { OrderLineItem } from "./OrderLineItem";
+export { OrderLineItemDownload } from "./OrderLineItemDownload";
+export { OrderReturn } from "./OrderReturn";
+export { OrderReturnLineItem } from "./OrderReturnLineItem";
+export { OrderReturnLineItemReason } from "./OrderReturnLineItemReason";
+export { OrderTransaction } from "./OrderTransaction";
+export { OrderTransactionCapture } from "./OrderTransactionCapture";
+export { OrderTransactionCaptureRefund } from "./OrderTransactionCaptureRefund";
+export { OrderTransactionCaptureRefundPosition } from "./OrderTransactionCaptureRefundPosition";

package/dist/types/storeApi/price/CalculatedPrice.d.ts

@@ -0,0 +1,25 @@
+import { CartListPrice, CartPriceReference, CartRegulationPrice } from ".";
+export 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;
+    }>;
+};

package/dist/types/storeApi/price/CartListPrice.d.ts

@@ -0,0 +1,6 @@
+export type CartListPrice = {
+    apiAlias: "cart_list_price";
+    discount?: number;
+    percentage?: number;
+    price?: number;
+};

package/dist/types/storeApi/price/CartPriceQuantity.d.ts

@@ -0,0 +1,16 @@
+import { CartListPrice } from ".";
+export 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;
+};

package/dist/types/storeApi/price/CartPriceReference.d.ts

@@ -0,0 +1,12 @@
+import { CartListPrice, CartRegulationPrice } from ".";
+export type CartPriceReference = {
+    apiAlias: "cart_price_reference";
+    purchaseUnit?: number;
+    referenceUnit?: number;
+    unitName: string;
+    price?: number;
+    listPrice: CartListPrice | null;
+    regulationPrice: CartRegulationPrice | null;
+    hasRange: boolean;
+    variantId?: string;
+};

package/dist/types/storeApi/price/CartRegulationPrice.d.ts

@@ -0,0 +1,4 @@
+export type CartRegulationPrice = {
+    apiAlias?: "cart_regulation_price";
+    price?: number;
+};

package/dist/types/storeApi/price/Price.d.ts

@@ -0,0 +1,18 @@
+export 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;
+    };
+};

package/dist/types/storeApi/price/index.d.ts

@@ -0,0 +1,6 @@
+export { Price } from "./Price";
+export { CartPriceQuantity } from "./CartPriceQuantity";
+export { CartPriceReference } from "./CartPriceReference";
+export { CalculatedPrice } from "./CalculatedPrice";
+export { CartListPrice } from "./CartListPrice";
+export { CartRegulationPrice } from "./CartRegulationPrice";

package/dist/types/storeApi/product/Product.d.ts

@@ -0,0 +1,107 @@
+import { GenericRecord } from "../GenericRecord";
+import { CalculatedPrice } from "../price";
+import { ProductConfiguratorSetting, ProductCrossSelling, ProductDownload, ProductManufacturer, ProductReview, ProductStream } from ".";
+import { DeliveryTime } from "../DeliveryTime";
+import { Tax } from "../Tax";
+import { Unit } from "../Unit";
+import { Media, ProductMedia } from "../media";
+import { CmsPage } from "../cms";
+import { Category, MainCategory } from "../category";
+import { SeoUrlEntity } from "../seo";
+import { PropertyGroupOption } from "../propertyGroup";
+import { Tag } from "../Tag";
+export 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;
+};

package/dist/types/storeApi/product/ProductConfiguratorSetting.d.ts

@@ -0,0 +1,17 @@
+import { GenericRecord } from "../GenericRecord";
+import { Media } from "../media";
+import { PropertyGroupOption } from "../propertyGroup";
+export 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;
+};

package/dist/types/storeApi/product/ProductDownload.d.ts

@@ -0,0 +1,16 @@
+import { GenericRecord } from "../GenericRecord";
+import { Product } from ".";
+import { Media } from "../media";
+export 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;
+};

package/dist/types/storeApi/product/ProductListingResult.d.ts

@@ -0,0 +1,29 @@
+import { EntitySearchResult } from "../EntitySearchResult";
+import { Product } from ".";
+export 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>;
+};

package/dist/types/storeApi/product/ProductManufacturer.d.ts

@@ -0,0 +1,15 @@
+import { GenericRecord } from "../GenericRecord";
+import { Media } from "../media";
+export 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;
+};