@devite/shopware-client 1.0.0

package/dist/types/clients/CustomerAuthenticationClient.d.ts

@@ -0,0 +1,44 @@
+import { Customer, CustomerAddress, CustomerGroup } from "../storeApi";
+export type CustomerLoginRequest = {
+    username: string;
+    password: string;
+};
+export type CustomerLoginResponse = {
+    redirectUrl?: string;
+};
+export type CustomerLogoutResponse = {
+    redirectUrl?: string;
+};
+export 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;
+};
+export type CustomerRegisterResponse = Customer;
+export type CustomerRegisterGroupConfigResponse = CustomerGroup;
+export type CustomerRegistrationConfirmRequest = {
+    hash: string;
+    em: string;
+};
+export type CustomerLoginImitateRequest = {
+    token: string;
+    customerId: string;
+    userId: string;
+};
+export type CustomerLoginImitateResponse = {
+    redirectUrl?: string;
+};

package/dist/types/clients/DocumentClient.d.ts

@@ -0,0 +1,3 @@
+import { Criteria, ShopwareDocument } from "../storeApi";
+export type DocumentDownloadRequest = Criteria;
+export type DocumentDownloadResponse = ShopwareDocument;

package/dist/types/clients/GatewayClient.d.ts

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

package/dist/types/clients/NewsletterClient.d.ts

@@ -0,0 +1,21 @@
+export type NewsletterConfirmRequest = {
+    hash: string;
+    em: string;
+};
+export 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;
+};
+export type NewsletterUnsubscribeRequest = {
+    email: string;
+};

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

@@ -0,0 +1,26 @@
+import { Criteria, EntitySearchResult, Order, StateMachineState } from "../storeApi";
+export type OrderCancelRequest = {
+    orderId: string;
+};
+export type OrderCancelResponse = StateMachineState;
+export type OrderDownloadFileResponse = Blob;
+export type OrderFromCartRequest = {
+    customerComment?: string;
+    affiliateCode?: string;
+    campaignCode?: string;
+};
+export type OrderFromCartResponse = Order;
+export type OrderListRequest = Criteria & {
+    checkPromotion?: boolean;
+};
+export type OrderListResponse = {
+    orders: Array<Order> & EntitySearchResult;
+    paymentChangeable: Record<string, boolean>;
+};
+export type OrderUpdatePaymentMethodRequest = {
+    paymentMethodId: string;
+    orderId: string;
+};
+export type OrderUpdatePaymentMethodResponse = {
+    success?: boolean;
+};

package/dist/types/clients/PaymentClient.d.ts

@@ -0,0 +1,8 @@
+export type OrderPaymentInitiateRequest = {
+    orderId: string;
+    finishUrl?: string;
+    errorUrl?: string;
+};
+export type OrderPaymentInitiateResponse = {
+    redirectUrl: string;
+};

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

@@ -0,0 +1,49 @@
+import { Criteria, CrossSellingElement, EntitySearchResult, Product, ProductListingCriteria, ProductListingFlags, ProductListingResult, ProductReview, PropertyGroup } from "../storeApi";
+export type ProductListRequest = Criteria;
+export type ProductListResponse = EntitySearchResult & {
+    elements?: Array<Product>;
+};
+export type ProductReviewListRequest = Criteria;
+export type ProductReviewListResponse = EntitySearchResult & {
+    elements?: Array<ProductReview>;
+};
+export type ProductReviewSaveRequest = {
+    name?: string;
+    email?: string;
+    title: string;
+    content: string;
+    points: number;
+};
+export type ProductSearchRequest = {
+    search: string;
+} & ProductListingCriteria & ProductListingFlags;
+export type ProductSearchResponse = ProductListingResult;
+export type ProductSearchSuggestionListRequest = ProductListingFlags & {
+    search: string;
+};
+export type ProductSearchSuggestionListResponse = ProductListingResult;
+export type ProductSingleRequest = Criteria;
+export type ProductSingleResponse = {
+    product: Product;
+    configurator?: Array<PropertyGroup>;
+    id?: any;
+    available?: any;
+    isCloseout?: any;
+    displayGroup?: any;
+    manufacturerNumber?: any;
+    stock?: any;
+    sortedProperties?: any;
+};
+export type ProductVariantWithOptionsRequest = {
+    options: Array<string>;
+    switchedGroup?: string;
+};
+export type ProductVariantWithOptionsResponse = {
+    foundCombination?: {
+        variantId?: string;
+        options: Array<string>;
+    };
+};
+export type ProductListingListWithCategoryRequest = ProductListingCriteria & ProductListingFlags;
+export type ProductListingListWithCategoryResponse = ProductListingResult;
+export type ProductCrossSellingGroupListResponse = Array<CrossSellingElement>;

package/dist/types/clients/SeoClient.d.ts

@@ -0,0 +1,7 @@
+import { Criteria, EntitySearchResult, SeoUrlEntity, Sitemap } from "../storeApi";
+export type SeoRouteListRequest = Criteria;
+export type SeoRouteListResponse = EntitySearchResult & {
+    elements?: Array<SeoUrlEntity>;
+};
+export type SitemapDownloadResponse = Blob;
+export type SitemapListResponse = Array<Sitemap>;

package/dist/types/clients/SystemClient.d.ts

@@ -0,0 +1,33 @@
+import { Country, CountryState, Criteria, Currency, EntitySearchResult, Language, PaymentMethod, Salutation, ShippingMethod } from "../storeApi";
+export type CountryListRequest = Criteria;
+export type CountryListResponse = EntitySearchResult & {
+    elements?: Array<Country>;
+};
+export type CountryStateListRequest = Criteria;
+export type CountryStateListResponse = EntitySearchResult & {
+    elements?: Array<CountryState>;
+};
+export type CurrencyListRequest = Criteria;
+export type CurrencyListResponse = EntitySearchResult & {
+    elements?: Array<Currency>;
+};
+export type LanguageListRequest = Criteria;
+export type LanguageListResponse = EntitySearchResult & {
+    elements?: Array<Language>;
+};
+export type SalutationListRequest = Criteria;
+export type SalutationListResponse = EntitySearchResult & {
+    elements?: Array<Salutation>;
+};
+export type ShippingMethodListRequest = Criteria;
+export type ShippingMethodListResponse = EntitySearchResult & {
+    elements?: Array<ShippingMethod>;
+};
+export type PaymentMethodListRequest = Criteria & {
+    onlyAvailable?: boolean;
+};
+export type PaymentMethodListResponse = {
+    total?: number;
+    aggregations?: object;
+    elements?: Array<PaymentMethod>;
+};

package/dist/types/clients/WishlistClient.d.ts

@@ -0,0 +1,21 @@
+import { Criteria, ProductListingResult } from "../storeApi";
+export type WishlistGetRequest = Criteria;
+export type WishlistGetResponse = {
+    wishlist?: {
+        customerId?: string;
+        salesChannelId?: string;
+    };
+    products?: ProductListingResult;
+};
+export type WishlistMergeOrCreateRequest = {
+    productIds?: Array<string>;
+};
+export type WishlistMergeOrCreateResponse = {
+    success?: boolean;
+};
+export type WishlistProductAddResponse = {
+    success?: boolean;
+};
+export type WishlistProductRemoveResponse = {
+    success?: boolean;
+};

package/dist/types/clients/index.d.ts

@@ -0,0 +1,16 @@
+export * from "./AccountClient";
+export * from "./AddressClient";
+export * from "./CartClient";
+export * from "./CategoryClient";
+export * from "./ContentClient";
+export * from "./ContextClient";
+export * from "./CustomerAuthenticationClient";
+export * from "./DocumentClient";
+export * from "./GatewayClient";
+export * from "./NewsletterClient";
+export * from "./OrderClient";
+export * from "./PaymentClient";
+export * from "./ProductClient";
+export * from "./SeoClient";
+export * from "./SystemClient";
+export * from "./WishlistClient";

package/dist/types/index.d.ts

@@ -0,0 +1,7 @@
+export * from "./auth";
+export * from "./clients";
+export * from "./storeApi";
+export { HTTPRequestMethod } from "./HTTPRequestMethod";
+export { ClientRequestOptions } from "./ClientRequestOptions";
+export { ClientResponse } from "./ClientResponse";
+export { RequestCacheEntry } from "./RequestCacheEntry";

package/dist/types/storeApi/Currency.d.ts

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

package/dist/types/storeApi/DeliveryTime.d.ts

@@ -0,0 +1,12 @@
+import { GenericRecord } from "./GenericRecord";
+export type DeliveryTime = {
+    id: string;
+    name: string;
+    min: number;
+    max: number;
+    unit: string;
+    customFields?: GenericRecord;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+    translated?: object;
+};

package/dist/types/storeApi/EntitySearchResult.d.ts

@@ -0,0 +1,7 @@
+export type EntitySearchResult = {
+    entity?: string;
+    total?: number;
+    aggregations?: Array<object>;
+    page?: number;
+    limit?: number;
+};

package/dist/types/storeApi/GenericRecord.d.ts

@@ -0,0 +1,3 @@
+export type GenericRecord = never | null | string | Array<String> | number | {
+    [key: string]: GenericRecord;
+};

package/dist/types/storeApi/PaymentMethod.d.ts

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

package/dist/types/storeApi/Rule.d.ts

@@ -0,0 +1,10 @@
+import { GenericRecord } from "./GenericRecord";
+export type Rule = {
+    id?: string;
+    name: string;
+    description?: string;
+    customFields?: GenericRecord;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+    extensions?: any;
+};

package/dist/types/storeApi/Salutation.d.ts

@@ -0,0 +1,11 @@
+import { GenericRecord } from "./GenericRecord";
+export type Salutation = {
+    id: string;
+    salutationKey: string;
+    displayName: string;
+    letterName: string;
+    customFields?: GenericRecord;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+    translated?: object;
+};

package/dist/types/storeApi/StateMachineState.d.ts

@@ -0,0 +1,10 @@
+import { GenericRecord } from "./GenericRecord";
+export type StateMachineState = {
+    id?: string;
+    technicalName: string;
+    name: string;
+    customFields?: GenericRecord;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+    translated?: object;
+};

package/dist/types/storeApi/Tag.d.ts

@@ -0,0 +1,6 @@
+export type Tag = {
+    id: string;
+    name: string;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+};

package/dist/types/storeApi/Tax.d.ts

@@ -0,0 +1,10 @@
+import { GenericRecord } from "./GenericRecord";
+export type Tax = {
+    id: string;
+    taxRate: number;
+    name: string;
+    position?: number;
+    customFields?: GenericRecord;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+};

package/dist/types/storeApi/TotalCountMode.d.ts

@@ -0,0 +1 @@
+export type TotalCountMode = "none" | "exact" | "next-pages";

package/dist/types/storeApi/Unit.d.ts

@@ -0,0 +1,10 @@
+import { GenericRecord } from "./GenericRecord";
+export type Unit = {
+    id: string;
+    shortCode: string;
+    name: string;
+    customFields?: GenericRecord;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+    translated?: object;
+};

package/dist/types/storeApi/aggregation/AggregationEntity.d.ts

@@ -0,0 +1,6 @@
+export type AggregationEntity = {
+    name: string;
+    type: "entity";
+    field: string;
+    definition: string;
+};

package/dist/types/storeApi/aggregation/AggregationFilter.d.ts

@@ -0,0 +1,6 @@
+import { Filters } from "../filter";
+export type AggregationFilter = {
+    name: string;
+    type: "filter";
+    filter: Array<Filters>;
+};

package/dist/types/storeApi/aggregation/AggregationHistogram.d.ts

@@ -0,0 +1,8 @@
+export type AggregationHistogram = {
+    name: string;
+    type: "histogram";
+    field: string;
+    interval?: number;
+    format?: string;
+    timeZone?: string;
+};

package/dist/types/storeApi/aggregation/AggregationMetrics.d.ts

@@ -0,0 +1,5 @@
+export type AggregationMetrics = {
+    name: string;
+    type: "avg" | "count" | "max" | "min" | "stats" | "sum";
+    field: string;
+};

package/dist/types/storeApi/aggregation/AggregationRange.d.ts

@@ -0,0 +1,13 @@
+export type AggregationRange = {
+    name: string;
+    type: "range";
+    field: string;
+    ranges: Array<{
+        from: number;
+        to: number;
+    } | {
+        from: number;
+    } | {
+        to: number;
+    }>;
+};

package/dist/types/storeApi/aggregation/AggregationTerms.d.ts

@@ -0,0 +1,8 @@
+import { Sort } from "../query";
+export type AggregationTerms = {
+    name: string;
+    type: "terms";
+    field: string;
+    limit?: number;
+    sort?: Array<Sort>;
+};

package/dist/types/storeApi/aggregation/Aggregations.d.ts

@@ -0,0 +1,2 @@
+import { AggregationEntity, AggregationFilter, AggregationHistogram, AggregationMetrics, AggregationRange, AggregationTerms } from ".";
+export type Aggregations = Array<AggregationEntity | AggregationFilter | AggregationHistogram | AggregationMetrics | AggregationRange | AggregationTerms>;

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

@@ -0,0 +1,7 @@
+export { AggregationEntity } from "./AggregationEntity";
+export { AggregationFilter } from "./AggregationFilter";
+export { AggregationHistogram } from "./AggregationHistogram";
+export { AggregationMetrics } from "./AggregationMetrics";
+export { AggregationRange } from "./AggregationRange";
+export { AggregationTerms } from "./AggregationTerms";
+export { Aggregations } from "./Aggregations";

package/dist/types/storeApi/cart/Cart.d.ts

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

package/dist/types/storeApi/cart/CartDelivery.d.ts

@@ -0,0 +1,13 @@
+import { CartDeliveryDate, CartDeliveryPosition, CartDeliveryShippingLocation } from ".";
+import { CountryState } from "../country";
+import { CalculatedPrice } from "../price";
+import { ShippingMethod } from "../shippingMethod";
+export type CartDelivery = {
+    deliveryDate?: CartDeliveryDate;
+    location?: CartDeliveryShippingLocation & {
+        state?: CountryState;
+    };
+    positions?: Array<CartDeliveryPosition>;
+    shippingCosts?: CalculatedPrice;
+    shippingMethod?: ShippingMethod;
+};

package/dist/types/storeApi/cart/CartDeliveryDate.d.ts

@@ -0,0 +1,4 @@
+export type CartDeliveryDate = {
+    earliest?: string;
+    latest?: string;
+};

package/dist/types/storeApi/cart/CartDeliveryInformation.d.ts

@@ -0,0 +1,12 @@
+import { CartDeliveryTime } from ".";
+export type CartDeliveryInformation = {
+    apiAlias: "cart_delivery_information";
+    freeDelivery?: boolean;
+    deliveryTime?: CartDeliveryTime;
+    height?: number;
+    length?: number;
+    restockTime?: number;
+    stock?: number;
+    weight?: number;
+    width?: number;
+};

package/dist/types/storeApi/cart/CartDeliveryPosition.d.ts

@@ -0,0 +1,9 @@
+import { CartDeliveryDate } from ".";
+import { LineItem } from "../lineItem";
+import { CalculatedPrice } from "../price";
+export type CartDeliveryPosition = {
+    deliveryDate?: CartDeliveryDate;
+    identifier?: string;
+    lineItem?: LineItem;
+    price?: CalculatedPrice;
+};

package/dist/types/storeApi/cart/CartDeliveryShippingLocation.d.ts

@@ -0,0 +1,7 @@
+import { Country } from "../country";
+import { CustomerAddress } from "../customer";
+export type CartDeliveryShippingLocation = {
+    apiAlias?: "cart_delivery_shipping_location";
+    country?: Country;
+    address?: CustomerAddress;
+};

package/dist/types/storeApi/cart/CartDeliveryTime.d.ts

@@ -0,0 +1,7 @@
+export type CartDeliveryTime = {
+    apiAlias?: "cart_delivery_time";
+    name?: string;
+    min?: number;
+    max?: number;
+    unit?: string;
+};

package/dist/types/storeApi/cart/CartError.d.ts

@@ -0,0 +1,8 @@
+export type CartError = {
+    items?: {
+        key?: string;
+        level?: 0 | 10 | 20;
+        message?: string;
+        messageKey?: string;
+    };
+};

package/dist/types/storeApi/cart/CartItems.d.ts

@@ -0,0 +1,2 @@
+import { LineItem } from "../lineItem";
+export type CartItems = Array<LineItem>;

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

@@ -0,0 +1,9 @@
+export { Cart } from "./Cart";
+export { CartDelivery } from "./CartDelivery";
+export { CartDeliveryDate } from "./CartDeliveryDate";
+export { CartDeliveryInformation } from "./CartDeliveryInformation";
+export { CartDeliveryPosition } from "./CartDeliveryPosition";
+export { CartDeliveryShippingLocation } from "./CartDeliveryShippingLocation";
+export { CartDeliveryTime } from "./CartDeliveryTime";
+export { CartError } from "./CartError";
+export { CartItems } from "./CartItems";

package/dist/types/storeApi/category/Category.d.ts

@@ -0,0 +1,50 @@
+import { GenericRecord } from "../GenericRecord";
+import { Media } from "../media";
+import { Tag } from "../Tag";
+import { CmsPage } from "../cms";
+import { SeoUrlEntity } from "../seo";
+export 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>;
+};

package/dist/types/storeApi/category/MainCategory.d.ts

@@ -0,0 +1,10 @@
+export type MainCategory = {
+    id: string;
+    productId: string;
+    productVersionId?: string;
+    categoryId: string;
+    categoryVersionId?: string;
+    salesChannelId: string;
+    readonly createdAt?: string;
+    readonly updatedAt?: string;
+};