@devite/shopware-client 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +52 -0
- package/dist/index.cjs +1330 -0
- package/dist/index.d.cts +2186 -0
- package/dist/index.d.mts +2186 -0
- package/dist/index.d.ts +2186 -0
- package/dist/index.mjs +1314 -0
- package/dist/src/ShopwareClient.d.ts +31 -0
- package/dist/src/auth/AuthenticationStore.d.ts +8 -0
- package/dist/src/auth/AuthenticationType.d.ts +5 -0
- package/dist/src/auth/entries/AuthenticationEntry.d.ts +10 -0
- package/dist/src/auth/entries/ContextTokenEntry.d.ts +13 -0
- package/dist/src/auth/entries/OAuthEntry.d.ts +15 -0
- package/dist/src/auth/entries/index.d.ts +3 -0
- package/dist/src/auth/errors/ExpiredError.d.ts +4 -0
- package/dist/src/auth/errors/NotSavedError.d.ts +4 -0
- package/dist/src/auth/errors/index.d.ts +2 -0
- package/dist/src/auth/index.d.ts +4 -0
- package/dist/src/clients/AccountClient.d.ts +16 -0
- package/dist/src/clients/AddressClient.d.ts +11 -0
- package/dist/src/clients/CartClient.d.ts +10 -0
- package/dist/src/clients/CategoryClient.d.ts +8 -0
- package/dist/src/clients/Client.d.ts +16 -0
- package/dist/src/clients/ContentClient.d.ts +9 -0
- package/dist/src/clients/ContextClient.d.ts +7 -0
- package/dist/src/clients/CustomerAuthenticationClient.d.ts +11 -0
- package/dist/src/clients/DocumentClient.d.ts +6 -0
- package/dist/src/clients/GatewayClient.d.ts +6 -0
- package/dist/src/clients/NewsletterClient.d.ts +8 -0
- package/dist/src/clients/OrderClient.d.ts +10 -0
- package/dist/src/clients/PaymentClient.d.ts +6 -0
- package/dist/src/clients/ProductClient.d.ts +14 -0
- package/dist/src/clients/SeoClient.d.ts +8 -0
- package/dist/src/clients/SystemClient.d.ts +12 -0
- package/dist/src/clients/WishlistClient.d.ts +9 -0
- package/dist/src/clients/index.d.ts +17 -0
- package/dist/src/index.d.ts +1 -0
- package/dist/src/payloads/BinaryPayload.d.ts +10 -0
- package/dist/src/payloads/JsonPayload.d.ts +10 -0
- package/dist/src/payloads/Payload.d.ts +6 -0
- package/dist/src/payloads/index.d.ts +3 -0
- package/dist/tests/auth/AuthenticationStore.test.d.ts +1 -0
- package/dist/tests/auth/entries/ContextTokenEntry.test.d.ts +1 -0
- package/dist/tests/auth/entries/OAuthEntry.test.d.ts +1 -0
- package/dist/types/ClientRequestOptions.d.ts +8 -0
- package/dist/types/ClientResponse.d.ts +7 -0
- package/dist/types/HTTPRequestMethod.d.ts +8 -0
- package/dist/types/RequestCacheEntry.d.ts +5 -0
- package/dist/types/auth/OAuthResponseBody.d.ts +5 -0
- package/dist/types/auth/index.d.ts +1 -0
- package/dist/types/clients/AccountClient.d.ts +70 -0
- package/dist/types/clients/AddressClient.d.ts +7 -0
- package/dist/types/clients/CartClient.d.ts +17 -0
- package/dist/types/clients/CategoryClient.d.ts +12 -0
- package/dist/types/clients/ContentClient.d.ts +29 -0
- package/dist/types/clients/ContextClient.d.ts +18 -0
- package/dist/types/clients/CustomerAuthenticationClient.d.ts +44 -0
- package/dist/types/clients/DocumentClient.d.ts +3 -0
- package/dist/types/clients/GatewayClient.d.ts +18 -0
- package/dist/types/clients/NewsletterClient.d.ts +21 -0
- package/dist/types/clients/OrderClient.d.ts +26 -0
- package/dist/types/clients/PaymentClient.d.ts +8 -0
- package/dist/types/clients/ProductClient.d.ts +49 -0
- package/dist/types/clients/SeoClient.d.ts +7 -0
- package/dist/types/clients/SystemClient.d.ts +33 -0
- package/dist/types/clients/WishlistClient.d.ts +21 -0
- package/dist/types/clients/index.d.ts +16 -0
- package/dist/types/index.d.ts +7 -0
- package/dist/types/storeApi/Currency.d.ts +26 -0
- package/dist/types/storeApi/DeliveryTime.d.ts +12 -0
- package/dist/types/storeApi/EntitySearchResult.d.ts +7 -0
- package/dist/types/storeApi/GenericRecord.d.ts +3 -0
- package/dist/types/storeApi/PaymentMethod.d.ts +24 -0
- package/dist/types/storeApi/Rule.d.ts +10 -0
- package/dist/types/storeApi/Salutation.d.ts +11 -0
- package/dist/types/storeApi/StateMachineState.d.ts +10 -0
- package/dist/types/storeApi/Tag.d.ts +6 -0
- package/dist/types/storeApi/Tax.d.ts +10 -0
- package/dist/types/storeApi/TotalCountMode.d.ts +1 -0
- package/dist/types/storeApi/Unit.d.ts +10 -0
- package/dist/types/storeApi/aggregation/AggregationEntity.d.ts +6 -0
- package/dist/types/storeApi/aggregation/AggregationFilter.d.ts +6 -0
- package/dist/types/storeApi/aggregation/AggregationHistogram.d.ts +8 -0
- package/dist/types/storeApi/aggregation/AggregationMetrics.d.ts +5 -0
- package/dist/types/storeApi/aggregation/AggregationRange.d.ts +13 -0
- package/dist/types/storeApi/aggregation/AggregationTerms.d.ts +8 -0
- package/dist/types/storeApi/aggregation/Aggregations.d.ts +2 -0
- package/dist/types/storeApi/aggregation/index.d.ts +7 -0
- package/dist/types/storeApi/cart/Cart.d.ts +19 -0
- package/dist/types/storeApi/cart/CartDelivery.d.ts +13 -0
- package/dist/types/storeApi/cart/CartDeliveryDate.d.ts +4 -0
- package/dist/types/storeApi/cart/CartDeliveryInformation.d.ts +12 -0
- package/dist/types/storeApi/cart/CartDeliveryPosition.d.ts +9 -0
- package/dist/types/storeApi/cart/CartDeliveryShippingLocation.d.ts +7 -0
- package/dist/types/storeApi/cart/CartDeliveryTime.d.ts +7 -0
- package/dist/types/storeApi/cart/CartError.d.ts +8 -0
- package/dist/types/storeApi/cart/CartItems.d.ts +2 -0
- package/dist/types/storeApi/cart/index.d.ts +9 -0
- package/dist/types/storeApi/category/Category.d.ts +50 -0
- package/dist/types/storeApi/category/MainCategory.d.ts +10 -0
- package/dist/types/storeApi/category/index.d.ts +2 -0
- package/dist/types/storeApi/cms/BackgroundMediaMode.d.ts +1 -0
- package/dist/types/storeApi/cms/CmsBlock.d.ts +28 -0
- package/dist/types/storeApi/cms/CmsPage.d.ts +23 -0
- package/dist/types/storeApi/cms/CmsSection.d.ts +25 -0
- package/dist/types/storeApi/cms/CmsSlot.d.ts +20 -0
- package/dist/types/storeApi/cms/LandingPage.d.ts +23 -0
- package/dist/types/storeApi/cms/Visibility.d.ts +5 -0
- package/dist/types/storeApi/cms/index.d.ts +7 -0
- package/dist/types/storeApi/country/Country.d.ts +40 -0
- package/dist/types/storeApi/country/CountryState.d.ts +13 -0
- package/dist/types/storeApi/country/index.d.ts +2 -0
- package/dist/types/storeApi/customer/Customer.d.ts +61 -0
- package/dist/types/storeApi/customer/CustomerAddress.d.ts +7 -0
- package/dist/types/storeApi/customer/CustomerAddressBody.d.ts +23 -0
- package/dist/types/storeApi/customer/CustomerGroup.d.ts +20 -0
- package/dist/types/storeApi/customer/index.d.ts +4 -0
- package/dist/types/storeApi/document/ShopwareDocument.d.ts +29 -0
- package/dist/types/storeApi/document/ShopwareDocumentBaseConfig.d.ts +17 -0
- package/dist/types/storeApi/document/ShopwareDocumentType.d.ts +10 -0
- package/dist/types/storeApi/document/index.d.ts +3 -0
- package/dist/types/storeApi/filter/EqualsFilter.d.ts +5 -0
- package/dist/types/storeApi/filter/Filters.d.ts +2 -0
- package/dist/types/storeApi/filter/MultiNotFilter.d.ts +6 -0
- package/dist/types/storeApi/filter/RangeFilter.d.ts +10 -0
- package/dist/types/storeApi/filter/SimpleFilter.d.ts +5 -0
- package/dist/types/storeApi/filter/index.d.ts +5 -0
- package/dist/types/storeApi/index.d.ts +32 -0
- package/dist/types/storeApi/lineItem/LineItem.d.ts +32 -0
- package/dist/types/storeApi/lineItem/LineItemPayload.d.ts +74 -0
- package/dist/types/storeApi/lineItem/LineItemType.d.ts +1 -0
- package/dist/types/storeApi/lineItem/index.d.ts +3 -0
- package/dist/types/storeApi/link/Link.d.ts +4 -0
- package/dist/types/storeApi/link/Links.d.ts +2 -0
- package/dist/types/storeApi/link/index.d.ts +2 -0
- package/dist/types/storeApi/locale/Language.d.ts +16 -0
- package/dist/types/storeApi/locale/Locale.d.ts +11 -0
- package/dist/types/storeApi/locale/index.d.ts +2 -0
- package/dist/types/storeApi/media/Media.d.ts +25 -0
- package/dist/types/storeApi/media/MediaThumbnail.d.ts +12 -0
- package/dist/types/storeApi/media/ProductMedia.d.ts +15 -0
- package/dist/types/storeApi/media/index.d.ts +3 -0
- package/dist/types/storeApi/order/Order.d.ts +58 -0
- package/dist/types/storeApi/order/OrderAddress.d.ts +8 -0
- package/dist/types/storeApi/order/OrderCustomer.d.ts +18 -0
- package/dist/types/storeApi/order/OrderDelivery.d.ts +24 -0
- package/dist/types/storeApi/order/OrderDeliveryPosition.d.ts +17 -0
- package/dist/types/storeApi/order/OrderLineItem.d.ts +43 -0
- package/dist/types/storeApi/order/OrderLineItemDownload.d.ts +17 -0
- package/dist/types/storeApi/order/OrderReturn.d.ts +14 -0
- package/dist/types/storeApi/order/OrderReturnLineItem.d.ts +14 -0
- package/dist/types/storeApi/order/OrderReturnLineItemReason.d.ts +6 -0
- package/dist/types/storeApi/order/OrderTransaction.d.ts +22 -0
- package/dist/types/storeApi/order/OrderTransactionCapture.d.ts +20 -0
- package/dist/types/storeApi/order/OrderTransactionCaptureRefund.d.ts +21 -0
- package/dist/types/storeApi/order/OrderTransactionCaptureRefundPosition.d.ts +21 -0
- package/dist/types/storeApi/order/index.d.ts +14 -0
- package/dist/types/storeApi/price/CalculatedPrice.d.ts +25 -0
- package/dist/types/storeApi/price/CartListPrice.d.ts +6 -0
- package/dist/types/storeApi/price/CartPriceQuantity.d.ts +16 -0
- package/dist/types/storeApi/price/CartPriceReference.d.ts +12 -0
- package/dist/types/storeApi/price/CartRegulationPrice.d.ts +4 -0
- package/dist/types/storeApi/price/Price.d.ts +18 -0
- package/dist/types/storeApi/price/index.d.ts +6 -0
- package/dist/types/storeApi/product/Product.d.ts +107 -0
- package/dist/types/storeApi/product/ProductConfiguratorSetting.d.ts +17 -0
- package/dist/types/storeApi/product/ProductDownload.d.ts +16 -0
- package/dist/types/storeApi/product/ProductListingResult.d.ts +29 -0
- package/dist/types/storeApi/product/ProductManufacturer.d.ts +15 -0
- package/dist/types/storeApi/product/ProductReview.d.ts +16 -0
- package/dist/types/storeApi/product/ProductReviewSummary.d.ts +8 -0
- package/dist/types/storeApi/product/ProductStream.d.ts +10 -0
- package/dist/types/storeApi/product/crossSelling/CrossSellingElement.d.ts +9 -0
- package/dist/types/storeApi/product/crossSelling/ProductCrossSelling.d.ts +13 -0
- package/dist/types/storeApi/product/crossSelling/index.d.ts +2 -0
- package/dist/types/storeApi/product/index.d.ts +9 -0
- package/dist/types/storeApi/propertyGroup/PropertyGroup.d.ts +17 -0
- package/dist/types/storeApi/propertyGroup/PropertyGroupOption.d.ts +18 -0
- package/dist/types/storeApi/propertyGroup/index.d.ts +2 -0
- package/dist/types/storeApi/query/Criteria.d.ts +20 -0
- package/dist/types/storeApi/query/Include.d.ts +1 -0
- package/dist/types/storeApi/query/Query.d.ts +5 -0
- package/dist/types/storeApi/query/Sort.d.ts +6 -0
- package/dist/types/storeApi/query/index.d.ts +5 -0
- package/dist/types/storeApi/query/product/ProductListingCriteria.d.ts +25 -0
- package/dist/types/storeApi/query/product/ProductListingFlags.d.ts +4 -0
- package/dist/types/storeApi/query/product/index.d.ts +2 -0
- package/dist/types/storeApi/salesChannel/SalesChannel.d.ts +23 -0
- package/dist/types/storeApi/salesChannel/SalesChannelContext.d.ts +38 -0
- package/dist/types/storeApi/salesChannel/index.d.ts +2 -0
- package/dist/types/storeApi/seo/SeoUrlEntity.d.ts +18 -0
- package/dist/types/storeApi/seo/Sitemap.d.ts +4 -0
- package/dist/types/storeApi/seo/index.d.ts +2 -0
- package/dist/types/storeApi/shippingMethod/ShippingMethod.d.ts +29 -0
- package/dist/types/storeApi/shippingMethod/ShippingMethodPrice.d.ts +15 -0
- package/dist/types/storeApi/shippingMethod/index.d.ts +2 -0
- package/package.json +45 -0
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export type BackgroundMediaMode = "cover" | "auto" | "contain";
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import { BackgroundMediaMode, CmsSlot, Visibility } from ".";
|
|
2
|
+
import { GenericRecord } from "../GenericRecord";
|
|
3
|
+
import { Media } from "../media";
|
|
4
|
+
export type CmsBlock = {
|
|
5
|
+
apiAlias: "cms_block";
|
|
6
|
+
id?: string;
|
|
7
|
+
position: number;
|
|
8
|
+
type: "image" | "text" | "product-listing" | "image-two-column";
|
|
9
|
+
name?: string;
|
|
10
|
+
sectionPosition?: "main" | "sidebar";
|
|
11
|
+
marginTop?: string;
|
|
12
|
+
marginBottom?: string;
|
|
13
|
+
marginLeft?: string;
|
|
14
|
+
marginRight?: string;
|
|
15
|
+
backgroundColor?: string;
|
|
16
|
+
backgroundMediaId?: string;
|
|
17
|
+
backgroundMediaMode?: BackgroundMediaMode;
|
|
18
|
+
cssClass?: string;
|
|
19
|
+
visibility?: Visibility;
|
|
20
|
+
sectionId: string;
|
|
21
|
+
customFields?: GenericRecord;
|
|
22
|
+
versionId?: string;
|
|
23
|
+
cmsSectionVersionId?: string;
|
|
24
|
+
readonly createdAt?: string;
|
|
25
|
+
readonly updatedAt?: string;
|
|
26
|
+
backgroundMedia?: Media;
|
|
27
|
+
slots?: Array<CmsSlot>;
|
|
28
|
+
};
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { GenericRecord } from "../GenericRecord";
|
|
2
|
+
import { CmsSection, LandingPage } from "./";
|
|
3
|
+
import { Media } from "../media";
|
|
4
|
+
export type CmsPage = {
|
|
5
|
+
apiAlias: "cms_page";
|
|
6
|
+
id: string;
|
|
7
|
+
versionId?: string;
|
|
8
|
+
name?: string;
|
|
9
|
+
type: "landingpage" | "page" | "product_list" | "product_detail";
|
|
10
|
+
entity?: string;
|
|
11
|
+
cssClass?: string;
|
|
12
|
+
config?: {
|
|
13
|
+
backgroundColor?: string;
|
|
14
|
+
};
|
|
15
|
+
previewMediaId?: string;
|
|
16
|
+
customFields?: GenericRecord;
|
|
17
|
+
readonly createdAt?: string;
|
|
18
|
+
readonly updatedAt?: string;
|
|
19
|
+
translated?: object;
|
|
20
|
+
sections?: Array<CmsSection>;
|
|
21
|
+
previewMedia?: Media;
|
|
22
|
+
landingPages?: Array<LandingPage>;
|
|
23
|
+
};
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import { BackgroundMediaMode, CmsBlock, CmsPage, Visibility } from ".";
|
|
2
|
+
import { GenericRecord } from "../GenericRecord";
|
|
3
|
+
import { Media } from "../media";
|
|
4
|
+
export type CmsSection = {
|
|
5
|
+
apiAlias: "cms_section";
|
|
6
|
+
id?: string;
|
|
7
|
+
position: number;
|
|
8
|
+
type: "sidebar" | "fullwidth";
|
|
9
|
+
name?: string;
|
|
10
|
+
sizingMode?: "boxed" | "full_width";
|
|
11
|
+
mobileBehavior?: string;
|
|
12
|
+
backgroundColor?: string;
|
|
13
|
+
backgroundMediaId?: string;
|
|
14
|
+
backgroundMediaMode?: BackgroundMediaMode;
|
|
15
|
+
cssClass?: string;
|
|
16
|
+
pageId: string;
|
|
17
|
+
visibility?: Visibility;
|
|
18
|
+
customFields?: GenericRecord;
|
|
19
|
+
cmsPageVersionId?: string;
|
|
20
|
+
readonly createdAt?: string;
|
|
21
|
+
readonly updatedAt?: string;
|
|
22
|
+
page?: CmsPage;
|
|
23
|
+
backgroundMedia?: Media;
|
|
24
|
+
blocks?: Array<CmsBlock>;
|
|
25
|
+
};
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { GenericRecord } from "../GenericRecord";
|
|
2
|
+
import { CmsBlock } from ".";
|
|
3
|
+
export type CmsSlot = {
|
|
4
|
+
id: string;
|
|
5
|
+
versionId?: string;
|
|
6
|
+
type: "image" | "text" | "form" | "product-listing" | "category-navigation" | "product-box" | "buy-box" | "sidebar-filter";
|
|
7
|
+
slot: string;
|
|
8
|
+
locked?: boolean;
|
|
9
|
+
config?: object;
|
|
10
|
+
customFields?: GenericRecord;
|
|
11
|
+
readonly data?: object;
|
|
12
|
+
blockId: string;
|
|
13
|
+
fieldConfig?: object;
|
|
14
|
+
cmsBlockVersionId?: string;
|
|
15
|
+
readonly createdAt?: string;
|
|
16
|
+
readonly updatedAt?: string;
|
|
17
|
+
translated?: object;
|
|
18
|
+
block?: CmsBlock;
|
|
19
|
+
VersionId?: string;
|
|
20
|
+
};
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { GenericRecord } from "../GenericRecord";
|
|
2
|
+
import { CmsPage } from ".";
|
|
3
|
+
import { SeoUrlEntity } from "../seo";
|
|
4
|
+
export type LandingPage = {
|
|
5
|
+
apiAlias: "landing_page";
|
|
6
|
+
id: string;
|
|
7
|
+
versionId?: string;
|
|
8
|
+
active?: boolean;
|
|
9
|
+
name: string;
|
|
10
|
+
customFields?: GenericRecord;
|
|
11
|
+
slotConfig?: object;
|
|
12
|
+
metaTitle?: string;
|
|
13
|
+
metaDescription?: string;
|
|
14
|
+
keywords?: string;
|
|
15
|
+
url: string;
|
|
16
|
+
cmsPageId?: string;
|
|
17
|
+
cmsPageVersionId?: string;
|
|
18
|
+
readonly createdAt?: string;
|
|
19
|
+
readonly updatedAt?: string;
|
|
20
|
+
translated?: object;
|
|
21
|
+
cmsPage?: CmsPage;
|
|
22
|
+
seoUrls?: Array<SeoUrlEntity>;
|
|
23
|
+
};
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
export { BackgroundMediaMode } from "./BackgroundMediaMode";
|
|
2
|
+
export { CmsBlock } from "./CmsBlock";
|
|
3
|
+
export { CmsPage } from "./CmsPage";
|
|
4
|
+
export { CmsSection } from "./CmsSection";
|
|
5
|
+
export { CmsSlot } from "./CmsSlot";
|
|
6
|
+
export { LandingPage } from "./LandingPage";
|
|
7
|
+
export { Visibility } from "./Visibility";
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import { GenericRecord } from "../GenericRecord";
|
|
2
|
+
import { CountryState } from ".";
|
|
3
|
+
export type Country = {
|
|
4
|
+
id: string;
|
|
5
|
+
name: string;
|
|
6
|
+
iso?: string;
|
|
7
|
+
position?: number;
|
|
8
|
+
active?: boolean;
|
|
9
|
+
shippingAvailable?: boolean;
|
|
10
|
+
iso3?: string;
|
|
11
|
+
displayStateInRegistration?: boolean;
|
|
12
|
+
forceStateInRegistration?: boolean;
|
|
13
|
+
checkVatIdPattern?: boolean;
|
|
14
|
+
vatIdRequired?: boolean;
|
|
15
|
+
vatIdPattern?: string;
|
|
16
|
+
customFields?: GenericRecord;
|
|
17
|
+
customerTax?: {
|
|
18
|
+
enabled: boolean;
|
|
19
|
+
currencyId: string;
|
|
20
|
+
amount: number;
|
|
21
|
+
};
|
|
22
|
+
companyTax?: {
|
|
23
|
+
enabled: boolean;
|
|
24
|
+
currencyId: string;
|
|
25
|
+
amount: number;
|
|
26
|
+
};
|
|
27
|
+
postalCodeRequired?: boolean;
|
|
28
|
+
checkPostalCodePattern?: boolean;
|
|
29
|
+
checkAdvancedPostalCodePattern?: boolean;
|
|
30
|
+
advancedPostalCodePattern?: string;
|
|
31
|
+
addressFormat: string;
|
|
32
|
+
defaultPostalCodePattern?: string;
|
|
33
|
+
isEu?: boolean;
|
|
34
|
+
readonly createdAt?: string;
|
|
35
|
+
readonly updatedAt?: string;
|
|
36
|
+
translated?: object;
|
|
37
|
+
states?: Array<CountryState>;
|
|
38
|
+
taxFree?: boolean;
|
|
39
|
+
companyTaxFree?: boolean;
|
|
40
|
+
};
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { GenericRecord } from "../GenericRecord";
|
|
2
|
+
export type CountryState = {
|
|
3
|
+
id: string;
|
|
4
|
+
countryId: string;
|
|
5
|
+
shortCode: string;
|
|
6
|
+
name: string;
|
|
7
|
+
position?: number;
|
|
8
|
+
active?: boolean;
|
|
9
|
+
customFields?: GenericRecord;
|
|
10
|
+
readonly createdAt?: string;
|
|
11
|
+
readonly updatedAt?: string;
|
|
12
|
+
translated?: object;
|
|
13
|
+
};
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
import { GenericRecord } from "../GenericRecord";
|
|
2
|
+
import { CustomerAddress, CustomerGroup } from ".";
|
|
3
|
+
import { Language } from "../locale";
|
|
4
|
+
import { PaymentMethod } from "../PaymentMethod";
|
|
5
|
+
import { Salutation } from "../Salutation";
|
|
6
|
+
import { Tag } from "../Tag";
|
|
7
|
+
export type Customer = {
|
|
8
|
+
apiAlias: "customer";
|
|
9
|
+
id: string;
|
|
10
|
+
groupId: string;
|
|
11
|
+
salesChannelId: string;
|
|
12
|
+
languageId: string;
|
|
13
|
+
lastPaymentMethodId?: string;
|
|
14
|
+
defaultBillingAddressId: string;
|
|
15
|
+
defaultShippingAddressId: string;
|
|
16
|
+
customerNumber: string;
|
|
17
|
+
salutationId?: string;
|
|
18
|
+
firstName: string;
|
|
19
|
+
lastName: string;
|
|
20
|
+
company?: string;
|
|
21
|
+
email: string;
|
|
22
|
+
title?: string;
|
|
23
|
+
vatIds?: Array<string>;
|
|
24
|
+
affiliateCode?: string;
|
|
25
|
+
campaignCode?: string;
|
|
26
|
+
active?: boolean;
|
|
27
|
+
doubleOptInRegistration?: boolean;
|
|
28
|
+
doubleOptInEmailSentDate?: string;
|
|
29
|
+
doubleOptInConfirmDate?: string;
|
|
30
|
+
hash?: string;
|
|
31
|
+
guest?: boolean;
|
|
32
|
+
firstLogin?: string;
|
|
33
|
+
lastLogin?: string;
|
|
34
|
+
birthday?: string;
|
|
35
|
+
readonly lastOrderDate?: string;
|
|
36
|
+
readonly orderCount?: number;
|
|
37
|
+
readonly orderTotalAmount?: number;
|
|
38
|
+
readonly reviewCount?: number;
|
|
39
|
+
customFields?: GenericRecord;
|
|
40
|
+
readonly tagIds?: Array<string>;
|
|
41
|
+
accountType?: string;
|
|
42
|
+
createdById?: string;
|
|
43
|
+
updatedById?: string;
|
|
44
|
+
defaultPaymentMethodId: string;
|
|
45
|
+
readonly createdAt?: string;
|
|
46
|
+
readonly updatedAt?: string;
|
|
47
|
+
group?: CustomerGroup;
|
|
48
|
+
language?: Language;
|
|
49
|
+
lastPaymentMethod?: PaymentMethod;
|
|
50
|
+
defaultBillingAddress?: CustomerAddress;
|
|
51
|
+
activeBillingAddress: CustomerAddress;
|
|
52
|
+
defaultShippingAddress?: CustomerAddress;
|
|
53
|
+
activeShippingAddress: CustomerAddress;
|
|
54
|
+
salutation?: Salutation;
|
|
55
|
+
addresses?: Array<CustomerAddress>;
|
|
56
|
+
tags?: Array<Tag>;
|
|
57
|
+
defaultPaymentMethod?: PaymentMethod;
|
|
58
|
+
extensions?: {
|
|
59
|
+
specificFeatures?: any;
|
|
60
|
+
};
|
|
61
|
+
};
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { GenericRecord } from "../GenericRecord";
|
|
2
|
+
import { Country, CountryState } from "../country";
|
|
3
|
+
import { Salutation } from "../Salutation";
|
|
4
|
+
export type CustomerAddressBody = {
|
|
5
|
+
countryId: string;
|
|
6
|
+
countryStateId?: string;
|
|
7
|
+
salutationId?: string;
|
|
8
|
+
firstName: string;
|
|
9
|
+
lastName: string;
|
|
10
|
+
zipcode?: string;
|
|
11
|
+
city: string;
|
|
12
|
+
company?: string;
|
|
13
|
+
street: string;
|
|
14
|
+
department?: string;
|
|
15
|
+
title?: string;
|
|
16
|
+
phoneNumber?: string;
|
|
17
|
+
additionalAddressLine1?: string;
|
|
18
|
+
additionalAddressLine2?: string;
|
|
19
|
+
customFields?: GenericRecord;
|
|
20
|
+
country?: Country;
|
|
21
|
+
countryState?: CountryState;
|
|
22
|
+
salutation?: Salutation;
|
|
23
|
+
};
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { GenericRecord } from "../GenericRecord";
|
|
2
|
+
export type CustomerGroup = {
|
|
3
|
+
id: string;
|
|
4
|
+
name: string;
|
|
5
|
+
displayGross?: boolean;
|
|
6
|
+
customFields?: GenericRecord;
|
|
7
|
+
registrationActive?: boolean;
|
|
8
|
+
registrationTitle?: string;
|
|
9
|
+
registrationIntroduction?: string;
|
|
10
|
+
registrationOnlyCompanyRegistration?: boolean;
|
|
11
|
+
registrationSeoMetaDescription?: string;
|
|
12
|
+
readonly createdAt?: string;
|
|
13
|
+
readonly updatedAt?: string;
|
|
14
|
+
translated: {
|
|
15
|
+
name?: string;
|
|
16
|
+
registrationIntroduction?: string;
|
|
17
|
+
registrationSeoMetaDescription?: string;
|
|
18
|
+
registrationTitle?: string;
|
|
19
|
+
};
|
|
20
|
+
};
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import { GenericRecord } from "../GenericRecord";
|
|
2
|
+
import { ShopwareDocumentType } from ".";
|
|
3
|
+
import { Order } from "../order";
|
|
4
|
+
import { Media } from "../media";
|
|
5
|
+
export type ShopwareDocument = {
|
|
6
|
+
id: string;
|
|
7
|
+
documentTypeId: string;
|
|
8
|
+
fileType: string;
|
|
9
|
+
referenceDocumentId?: string;
|
|
10
|
+
orderId: string;
|
|
11
|
+
documentMediaFileId?: string;
|
|
12
|
+
orderVersionId?: string;
|
|
13
|
+
config: {
|
|
14
|
+
name: string;
|
|
15
|
+
title: string;
|
|
16
|
+
};
|
|
17
|
+
sent?: boolean;
|
|
18
|
+
static?: boolean;
|
|
19
|
+
deepLinkCode: string;
|
|
20
|
+
documentNumber?: string;
|
|
21
|
+
customFields?: GenericRecord;
|
|
22
|
+
readonly createdAt?: string;
|
|
23
|
+
readonly updatedAt?: string;
|
|
24
|
+
documentType?: ShopwareDocumentType;
|
|
25
|
+
order?: Order;
|
|
26
|
+
referencedDocument?: ShopwareDocument;
|
|
27
|
+
dependantDocuments?: Array<ShopwareDocument>;
|
|
28
|
+
documentMediaFile?: Media;
|
|
29
|
+
};
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { GenericRecord } from "../GenericRecord";
|
|
2
|
+
import { Media } from "../media";
|
|
3
|
+
export type ShopwareDocumentBaseConfig = {
|
|
4
|
+
id: string;
|
|
5
|
+
documentTypeId: string;
|
|
6
|
+
logoId?: string;
|
|
7
|
+
name: string;
|
|
8
|
+
filenamePrefix?: string;
|
|
9
|
+
filenameSuffix?: string;
|
|
10
|
+
global?: boolean;
|
|
11
|
+
documentNumber?: string;
|
|
12
|
+
config?: object;
|
|
13
|
+
readonly createdAt?: string;
|
|
14
|
+
customFields?: GenericRecord;
|
|
15
|
+
readonly updatedAt?: string;
|
|
16
|
+
logo?: Media;
|
|
17
|
+
};
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { GenericRecord } from "../GenericRecord";
|
|
2
|
+
export type ShopwareDocumentType = {
|
|
3
|
+
id: string;
|
|
4
|
+
name: string;
|
|
5
|
+
technicalName: string;
|
|
6
|
+
readonly createdAt?: string;
|
|
7
|
+
readonly updatedAt?: string;
|
|
8
|
+
customFields?: GenericRecord;
|
|
9
|
+
translated?: object;
|
|
10
|
+
};
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
export * from "./aggregation";
|
|
2
|
+
export * from "./cart";
|
|
3
|
+
export * from "./category";
|
|
4
|
+
export * from "./cms";
|
|
5
|
+
export * from "./country";
|
|
6
|
+
export * from "./customer";
|
|
7
|
+
export * from "./document";
|
|
8
|
+
export * from "./filter";
|
|
9
|
+
export * from "./lineItem";
|
|
10
|
+
export * from "./link";
|
|
11
|
+
export * from "./locale";
|
|
12
|
+
export * from "./media";
|
|
13
|
+
export * from "./order";
|
|
14
|
+
export * from "./price";
|
|
15
|
+
export * from "./product";
|
|
16
|
+
export * from "./propertyGroup";
|
|
17
|
+
export * from "./query";
|
|
18
|
+
export * from "./salesChannel";
|
|
19
|
+
export * from "./seo";
|
|
20
|
+
export * from "./shippingMethod";
|
|
21
|
+
export { Currency } from "./Currency";
|
|
22
|
+
export { DeliveryTime } from "./DeliveryTime";
|
|
23
|
+
export { EntitySearchResult } from "./EntitySearchResult";
|
|
24
|
+
export { GenericRecord } from "./GenericRecord";
|
|
25
|
+
export { PaymentMethod } from "./PaymentMethod";
|
|
26
|
+
export { Rule } from "./Rule";
|
|
27
|
+
export { Salutation } from "./Salutation";
|
|
28
|
+
export { StateMachineState } from "./StateMachineState";
|
|
29
|
+
export { Tag } from "./Tag";
|
|
30
|
+
export { Tax } from "./Tax";
|
|
31
|
+
export { TotalCountMode } from "./TotalCountMode";
|
|
32
|
+
export { Unit } from "./Unit";
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
import { ProductMedia } from "../media";
|
|
2
|
+
import { CartDeliveryInformation } from "../cart";
|
|
3
|
+
import { LineItemPayload, LineItemType } from ".";
|
|
4
|
+
import { CalculatedPrice, CartPriceQuantity } from "../price";
|
|
5
|
+
export type LineItem = {
|
|
6
|
+
children?: Array<LineItem>;
|
|
7
|
+
cover?: ProductMedia;
|
|
8
|
+
dataContextHash?: string;
|
|
9
|
+
dataTimestamp?: string;
|
|
10
|
+
deliveryInformation?: CartDeliveryInformation;
|
|
11
|
+
description?: string;
|
|
12
|
+
good?: boolean;
|
|
13
|
+
id: string;
|
|
14
|
+
label?: string;
|
|
15
|
+
modified?: string;
|
|
16
|
+
modifiedByApp?: boolean;
|
|
17
|
+
payload?: LineItemPayload;
|
|
18
|
+
price?: CalculatedPrice;
|
|
19
|
+
priceDefinition?: CartPriceQuantity;
|
|
20
|
+
quantity?: number;
|
|
21
|
+
quantityInformation?: {
|
|
22
|
+
maxPurchase?: number;
|
|
23
|
+
minPurchase?: number;
|
|
24
|
+
purchaseSteps?: number;
|
|
25
|
+
};
|
|
26
|
+
referencedId?: string;
|
|
27
|
+
removable?: boolean;
|
|
28
|
+
stackable?: boolean;
|
|
29
|
+
states?: Array<"is-physical" | "is-download">;
|
|
30
|
+
type: LineItemType;
|
|
31
|
+
uniqueIdentifier?: string;
|
|
32
|
+
};
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
import { Links } from "../link";
|
|
2
|
+
import { GenericRecord } from "../GenericRecord";
|
|
3
|
+
import { CalculatedPrice } from "../price";
|
|
4
|
+
export type LineItemPayload = {
|
|
5
|
+
type: string;
|
|
6
|
+
id: string;
|
|
7
|
+
attributes?: object;
|
|
8
|
+
relationships?: object;
|
|
9
|
+
links?: Links;
|
|
10
|
+
meta?: object;
|
|
11
|
+
versionId?: string;
|
|
12
|
+
parentId?: string;
|
|
13
|
+
parentVersionId?: string;
|
|
14
|
+
manufacturerId?: string;
|
|
15
|
+
productManufacturerVersionId?: string;
|
|
16
|
+
unitId?: string;
|
|
17
|
+
taxId?: string;
|
|
18
|
+
coverId?: string;
|
|
19
|
+
productMediaVersionId?: string;
|
|
20
|
+
deliveryTimeId?: string;
|
|
21
|
+
canonicalProductId?: string;
|
|
22
|
+
canonicalProductVersionId?: string;
|
|
23
|
+
cmsPageId?: string;
|
|
24
|
+
cmsPageVersionId?: string;
|
|
25
|
+
productNumber: string;
|
|
26
|
+
restockTime?: number;
|
|
27
|
+
active?: boolean;
|
|
28
|
+
available?: boolean;
|
|
29
|
+
isCloseout?: boolean;
|
|
30
|
+
availableStock?: number;
|
|
31
|
+
stock: number;
|
|
32
|
+
displayGroup?: string;
|
|
33
|
+
manufacturerNumber?: string;
|
|
34
|
+
ean?: string;
|
|
35
|
+
purchaseSteps?: number;
|
|
36
|
+
maxPurchase?: number;
|
|
37
|
+
minPurchase?: number;
|
|
38
|
+
purchaseUnit?: number;
|
|
39
|
+
referenceUnit?: number;
|
|
40
|
+
shippingFree?: boolean;
|
|
41
|
+
markAsTopseller?: boolean;
|
|
42
|
+
weight?: number;
|
|
43
|
+
width?: number;
|
|
44
|
+
height?: number;
|
|
45
|
+
length?: number;
|
|
46
|
+
releaseDate?: string;
|
|
47
|
+
ratingAverage?: number;
|
|
48
|
+
categoryTree?: Array<string>;
|
|
49
|
+
propertyIds?: Array<string>;
|
|
50
|
+
optionIds?: Array<string>;
|
|
51
|
+
streamIds?: Array<string>;
|
|
52
|
+
tagIds?: Array<string>;
|
|
53
|
+
categoryIds?: Array<string>;
|
|
54
|
+
childCount?: number;
|
|
55
|
+
sales?: number;
|
|
56
|
+
states?: Array<string>;
|
|
57
|
+
metaDescription?: string;
|
|
58
|
+
name: string;
|
|
59
|
+
keywords?: string;
|
|
60
|
+
description?: string;
|
|
61
|
+
metaTitle?: string;
|
|
62
|
+
packUnit?: string;
|
|
63
|
+
packUnitPlural?: string;
|
|
64
|
+
customFields?: GenericRecord;
|
|
65
|
+
calculatedPrice?: CalculatedPrice;
|
|
66
|
+
calculatedPrices?: Array<CalculatedPrice>;
|
|
67
|
+
calculatedMaxPurchase?: number;
|
|
68
|
+
calculatedCheapestPrice?: CalculatedPrice;
|
|
69
|
+
isNew?: boolean;
|
|
70
|
+
sortedProperties?: object;
|
|
71
|
+
createdAt?: string;
|
|
72
|
+
updatedAt?: string;
|
|
73
|
+
translated?: object;
|
|
74
|
+
};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export type LineItemType = "product" | "credit" | "custom" | "promotion" | "discount" | "container" | "quantity";
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { GenericRecord } from "../GenericRecord";
|
|
2
|
+
import { Locale } from ".";
|
|
3
|
+
export type Language = {
|
|
4
|
+
id: string;
|
|
5
|
+
parentId?: string;
|
|
6
|
+
localeId: string;
|
|
7
|
+
translationCodeId?: string;
|
|
8
|
+
name: string;
|
|
9
|
+
customFields?: GenericRecord;
|
|
10
|
+
readonly createdAt?: string;
|
|
11
|
+
readonly updatedAt?: string;
|
|
12
|
+
parent?: Language;
|
|
13
|
+
locale?: Locale;
|
|
14
|
+
translationCode?: Locale;
|
|
15
|
+
children?: Array<Language>;
|
|
16
|
+
};
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { GenericRecord } from "../GenericRecord";
|
|
2
|
+
export type Locale = {
|
|
3
|
+
id: string;
|
|
4
|
+
code: string;
|
|
5
|
+
name: string;
|
|
6
|
+
territory: string;
|
|
7
|
+
customFields?: GenericRecord;
|
|
8
|
+
readonly createdAt?: string;
|
|
9
|
+
readonly updatedAt?: string;
|
|
10
|
+
translated?: object;
|
|
11
|
+
};
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import { GenericRecord } from "../GenericRecord";
|
|
2
|
+
import { MediaThumbnail } from ".";
|
|
3
|
+
export type Media = {
|
|
4
|
+
apiAlias: "media";
|
|
5
|
+
id: string;
|
|
6
|
+
readonly mimeType?: string;
|
|
7
|
+
readonly fileExtension: string;
|
|
8
|
+
readonly uploadedAt?: string;
|
|
9
|
+
readonly fileName: string;
|
|
10
|
+
readonly fileSize?: number;
|
|
11
|
+
readonly metaData?: object;
|
|
12
|
+
config?: object;
|
|
13
|
+
alt?: string;
|
|
14
|
+
title?: string;
|
|
15
|
+
url: string;
|
|
16
|
+
path: string;
|
|
17
|
+
hasFile: boolean;
|
|
18
|
+
private: boolean;
|
|
19
|
+
customFields?: GenericRecord;
|
|
20
|
+
readonly createdAt?: string;
|
|
21
|
+
readonly updatedAt?: string;
|
|
22
|
+
translated: object;
|
|
23
|
+
thumbnails?: Array<MediaThumbnail>;
|
|
24
|
+
extensions?: any;
|
|
25
|
+
};
|