@dropins/mcp 0.1.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.md +127 -0
- package/README.md +314 -0
- package/dist/common/project-reader.d.ts +55 -0
- package/dist/common/project-reader.js +173 -0
- package/dist/common/registry-loader.d.ts +101 -0
- package/dist/common/registry-loader.js +386 -0
- package/dist/common/response-handling.d.ts +12 -0
- package/dist/common/response-handling.js +21 -0
- package/dist/common/sanitize.d.ts +8 -0
- package/dist/common/sanitize.js +45 -0
- package/dist/common/synonyms.d.ts +9 -0
- package/dist/common/synonyms.js +127 -0
- package/dist/common/telemetry.d.ts +14 -0
- package/dist/common/telemetry.js +54 -0
- package/dist/common/types.d.ts +308 -0
- package/dist/common/types.js +1 -0
- package/dist/common/version.d.ts +2 -0
- package/dist/common/version.js +14 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +136 -0
- package/dist/operations/analyze-project.d.ts +13 -0
- package/dist/operations/analyze-project.js +125 -0
- package/dist/operations/check-block-health.d.ts +19 -0
- package/dist/operations/check-block-health.js +1149 -0
- package/dist/operations/check-config.d.ts +13 -0
- package/dist/operations/check-config.js +228 -0
- package/dist/operations/explain-event-flow.d.ts +16 -0
- package/dist/operations/explain-event-flow.js +218 -0
- package/dist/operations/get-upgrade-diff.d.ts +13 -0
- package/dist/operations/get-upgrade-diff.js +144 -0
- package/dist/operations/list-api-functions.d.ts +13 -0
- package/dist/operations/list-api-functions.js +53 -0
- package/dist/operations/list-containers.d.ts +13 -0
- package/dist/operations/list-containers.js +44 -0
- package/dist/operations/list-design-tokens.d.ts +13 -0
- package/dist/operations/list-design-tokens.js +47 -0
- package/dist/operations/list-events.d.ts +16 -0
- package/dist/operations/list-events.js +39 -0
- package/dist/operations/list-graphql-queries.d.ts +19 -0
- package/dist/operations/list-graphql-queries.js +84 -0
- package/dist/operations/list-i18n-keys.d.ts +19 -0
- package/dist/operations/list-i18n-keys.js +105 -0
- package/dist/operations/list-models.d.ts +16 -0
- package/dist/operations/list-models.js +80 -0
- package/dist/operations/list-slots.d.ts +16 -0
- package/dist/operations/list-slots.js +81 -0
- package/dist/operations/scaffold-block.d.ts +31 -0
- package/dist/operations/scaffold-block.js +331 -0
- package/dist/operations/scaffold-extension.d.ts +28 -0
- package/dist/operations/scaffold-extension.js +346 -0
- package/dist/operations/scaffold-slot.d.ts +22 -0
- package/dist/operations/scaffold-slot.js +189 -0
- package/dist/operations/search-commerce-docs.d.ts +16 -0
- package/dist/operations/search-commerce-docs.js +101 -0
- package/dist/operations/search-docs.d.ts +23 -0
- package/dist/operations/search-docs.js +298 -0
- package/dist/operations/suggest-event-handler.d.ts +16 -0
- package/dist/operations/suggest-event-handler.js +175 -0
- package/dist/operations/suggest-slot-implementation.d.ts +19 -0
- package/dist/operations/suggest-slot-implementation.js +183 -0
- package/dist/registry/api-functions.json +3045 -0
- package/dist/registry/block-patterns.json +78 -0
- package/dist/registry/containers.json +2003 -0
- package/dist/registry/design-tokens.json +577 -0
- package/dist/registry/docs/boilerplate.json +55 -0
- package/dist/registry/docs/dropins-all.json +97 -0
- package/dist/registry/docs/dropins-b2b.json +607 -0
- package/dist/registry/docs/dropins-cart.json +163 -0
- package/dist/registry/docs/dropins-checkout.json +193 -0
- package/dist/registry/docs/dropins-order.json +139 -0
- package/dist/registry/docs/dropins-payment-services.json +73 -0
- package/dist/registry/docs/dropins-personalization.json +67 -0
- package/dist/registry/docs/dropins-product-details.json +139 -0
- package/dist/registry/docs/dropins-product-discovery.json +85 -0
- package/dist/registry/docs/dropins-recommendations.json +67 -0
- package/dist/registry/docs/dropins-user-account.json +121 -0
- package/dist/registry/docs/dropins-user-auth.json +103 -0
- package/dist/registry/docs/dropins-wishlist.json +85 -0
- package/dist/registry/docs/get-started.json +85 -0
- package/dist/registry/docs/how-tos.json +19 -0
- package/dist/registry/docs/index.json +139 -0
- package/dist/registry/docs/licensing.json +19 -0
- package/dist/registry/docs/merchants.json +523 -0
- package/dist/registry/docs/resources.json +13 -0
- package/dist/registry/docs/sdk.json +139 -0
- package/dist/registry/docs/setup.json +145 -0
- package/dist/registry/docs/troubleshooting.json +19 -0
- package/dist/registry/events.json +2200 -0
- package/dist/registry/examples/index.json +19 -0
- package/dist/registry/examples/storefront-checkout.json +377 -0
- package/dist/registry/examples/storefront-quote-management.json +49 -0
- package/dist/registry/extensions.json +272 -0
- package/dist/registry/graphql.json +3469 -0
- package/dist/registry/i18n.json +1873 -0
- package/dist/registry/models.json +1001 -0
- package/dist/registry/sdk.json +2357 -0
- package/dist/registry/slots.json +2270 -0
- package/dist/registry/tools-components.json +595 -0
- package/dist/resources/guides.d.ts +7 -0
- package/dist/resources/guides.js +625 -0
- package/dist/resources/handlers.d.ts +31 -0
- package/dist/resources/handlers.js +322 -0
- package/package.json +47 -0
|
@@ -0,0 +1,1001 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": "1.0.0",
|
|
3
|
+
"description": "Auto-generated registry of model types referenced by event payloads and slot contexts (includes transitive dependencies)",
|
|
4
|
+
"dropins": {
|
|
5
|
+
"storefront-account": {
|
|
6
|
+
"version": "3.3.0",
|
|
7
|
+
"models": [
|
|
8
|
+
{
|
|
9
|
+
"name": "Country",
|
|
10
|
+
"kind": "type",
|
|
11
|
+
"definition": "type Country = {\n value: string;\n text: string;\n availableRegions?: {\n id: number;\n code: string;\n name: string;\n }[];\n};"
|
|
12
|
+
},
|
|
13
|
+
{
|
|
14
|
+
"name": "CustomerAddressesModel",
|
|
15
|
+
"kind": "interface",
|
|
16
|
+
"definition": "interface CustomerAddressesModel {\n firstName?: string;\n lastName?: string;\n city?: string;\n company?: string;\n countryCode?: string;\n region?: { region: string; regionCode: string; regionId: string | number };\n telephone?: string;\n id?: string;\n vatId?: string;\n postcode?: string;\n street?: string;\n streetMultiline_2?: string;\n defaultShipping?: boolean;\n defaultBilling?: boolean;\n uid?: string;\n}"
|
|
17
|
+
},
|
|
18
|
+
{
|
|
19
|
+
"name": "ProductImage",
|
|
20
|
+
"kind": "type",
|
|
21
|
+
"definition": "type ProductImage = {\n url: string;\n};"
|
|
22
|
+
},
|
|
23
|
+
{
|
|
24
|
+
"name": "Product",
|
|
25
|
+
"kind": "type",
|
|
26
|
+
"definition": "type Product = {\n smallImage: ProductImage;\n};"
|
|
27
|
+
},
|
|
28
|
+
{
|
|
29
|
+
"name": "OrderItem",
|
|
30
|
+
"kind": "type",
|
|
31
|
+
"definition": "type OrderItem = {\n quantityOrdered?: number;\n quantityShipped?: number;\n quantityInvoiced?: number;\n status: string;\n productName: string;\n id: string;\n product: Product;\n};"
|
|
32
|
+
},
|
|
33
|
+
{
|
|
34
|
+
"name": "PaymentMethod",
|
|
35
|
+
"kind": "type",
|
|
36
|
+
"definition": "type PaymentMethod = {\n name: string;\n};"
|
|
37
|
+
},
|
|
38
|
+
{
|
|
39
|
+
"name": "MoneyAmount",
|
|
40
|
+
"kind": "type",
|
|
41
|
+
"definition": "type MoneyAmount = {\n value: number;\n currency: string;\n};"
|
|
42
|
+
},
|
|
43
|
+
{
|
|
44
|
+
"name": "Discount",
|
|
45
|
+
"kind": "type",
|
|
46
|
+
"definition": "type Discount = {\n amount: MoneyAmount;\n label: string;\n};"
|
|
47
|
+
},
|
|
48
|
+
{
|
|
49
|
+
"name": "Tax",
|
|
50
|
+
"kind": "type",
|
|
51
|
+
"definition": "type Tax = {\n amount: MoneyAmount;\n rate: number;\n title: string;\n};"
|
|
52
|
+
},
|
|
53
|
+
{
|
|
54
|
+
"name": "OrderTotals",
|
|
55
|
+
"kind": "type",
|
|
56
|
+
"definition": "type OrderTotals = {\n discounts: Discount[];\n grandTotal: MoneyAmount;\n subtotal: MoneyAmount;\n taxes: Tax[];\n totalTax: MoneyAmount;\n totalShipping: MoneyAmount;\n};"
|
|
57
|
+
},
|
|
58
|
+
{
|
|
59
|
+
"name": "ShipmentsTracingModel",
|
|
60
|
+
"kind": "type",
|
|
61
|
+
"definition": "type ShipmentsTracingModel = {\n carrier: string;\n number: string;\n title: string;\n};"
|
|
62
|
+
},
|
|
63
|
+
{
|
|
64
|
+
"name": "ShipmentsModel",
|
|
65
|
+
"kind": "type",
|
|
66
|
+
"definition": "type ShipmentsModel = {\n id: string;\n number: string;\n tracking: ShipmentsTracingModel[];\n};"
|
|
67
|
+
},
|
|
68
|
+
{
|
|
69
|
+
"name": "OrderDetails",
|
|
70
|
+
"kind": "type",
|
|
71
|
+
"definition": "type OrderDetails = {\n status: string;\n token: string;\n carrier: string;\n email: string;\n id: string;\n number: string;\n orderDate: string;\n orderTime: string;\n items: OrderItem[];\n returns: ReturnProps[];\n shipments: ShipmentsModel[];\n paymentMethods: PaymentMethod[];\n shippingAddress: CustomerAddressesModel;\n billingAddress: CustomerAddressesModel;\n total: OrderTotals;\n};"
|
|
72
|
+
},
|
|
73
|
+
{
|
|
74
|
+
"name": "PaginationInfo",
|
|
75
|
+
"kind": "type",
|
|
76
|
+
"definition": "type PaginationInfo = {\n currentPage: number;\n pageSize: number;\n totalPages: number;\n};"
|
|
77
|
+
},
|
|
78
|
+
{
|
|
79
|
+
"name": "Region",
|
|
80
|
+
"kind": "type",
|
|
81
|
+
"definition": "type Region = {\n code: string;\n id?: number;\n name: string;\n};"
|
|
82
|
+
},
|
|
83
|
+
{
|
|
84
|
+
"name": "StoreConfigModel",
|
|
85
|
+
"kind": "interface",
|
|
86
|
+
"definition": "interface StoreConfigModel {\n baseMediaUrl: string;\n minLength: number;\n requiredCharacterClasses: number;\n storeCode: string;\n}"
|
|
87
|
+
},
|
|
88
|
+
{
|
|
89
|
+
"name": "StoredPaymentMethodDisplay",
|
|
90
|
+
"kind": "type",
|
|
91
|
+
"definition": "type StoredPaymentMethodDisplay = Pick<\n PaymentCardProps,\n 'cardBrand' | 'lastFourDigits' | 'expired' | 'variant'\n> & {\n publicHash: string;\n};"
|
|
92
|
+
},
|
|
93
|
+
{
|
|
94
|
+
"name": "KeysSortOrderProps",
|
|
95
|
+
"kind": "interface",
|
|
96
|
+
"definition": "interface KeysSortOrderProps {\n name: string;\n orderNumber?: number;\n label?: string | null;\n}"
|
|
97
|
+
},
|
|
98
|
+
{
|
|
99
|
+
"name": "ReturnProps",
|
|
100
|
+
"kind": "interface",
|
|
101
|
+
"definition": "interface ReturnProps {\n uid: string;\n number: string;\n order: {\n id: string;\n };\n}"
|
|
102
|
+
},
|
|
103
|
+
{
|
|
104
|
+
"name": "CustomerDataProps",
|
|
105
|
+
"kind": "type",
|
|
106
|
+
"definition": "type CustomerDataProps = KeysSortOrderProps & {\n value: string | number | boolean;\n};"
|
|
107
|
+
},
|
|
108
|
+
{
|
|
109
|
+
"name": "CustomerDataContext",
|
|
110
|
+
"kind": "interface",
|
|
111
|
+
"definition": "interface CustomerDataContext {\n customerData: CustomerDataProps[];\n}"
|
|
112
|
+
},
|
|
113
|
+
{
|
|
114
|
+
"name": "OrdersListActionContext",
|
|
115
|
+
"kind": "interface",
|
|
116
|
+
"definition": "interface OrdersListActionContext {\n orderHistoryListItem: OrderDetails;\n}"
|
|
117
|
+
},
|
|
118
|
+
{
|
|
119
|
+
"name": "OrdersListCardContext",
|
|
120
|
+
"kind": "interface",
|
|
121
|
+
"definition": "interface OrdersListCardContext {\n orderHistoryListItem: OrderDetails;\n}"
|
|
122
|
+
},
|
|
123
|
+
{
|
|
124
|
+
"name": "PaymentCardProps",
|
|
125
|
+
"kind": "interface",
|
|
126
|
+
"definition": "interface PaymentCardProps {\n cardBrand: string;\n lastFourDigits: string;\n expired?: boolean;\n onRemove?: () => void;\n variant?: 'secondary' | 'primary';\n minifiedView?: boolean;\n}"
|
|
127
|
+
}
|
|
128
|
+
]
|
|
129
|
+
},
|
|
130
|
+
"storefront-auth": {
|
|
131
|
+
"version": "3.2.0",
|
|
132
|
+
"models": [
|
|
133
|
+
{
|
|
134
|
+
"name": "AdobeCommerceOptimizerModel",
|
|
135
|
+
"kind": "interface",
|
|
136
|
+
"definition": "interface AdobeCommerceOptimizerModel {\n priceBookId: string;\n}"
|
|
137
|
+
},
|
|
138
|
+
{
|
|
139
|
+
"name": "PermissionsModel",
|
|
140
|
+
"kind": "interface",
|
|
141
|
+
"definition": "interface PermissionsModel {\n all?: boolean;\n admin?: boolean;\n [key: string]: boolean;\n}"
|
|
142
|
+
},
|
|
143
|
+
{
|
|
144
|
+
"name": "StoreConfigModel",
|
|
145
|
+
"kind": "interface",
|
|
146
|
+
"definition": "interface StoreConfigModel {\n autocompleteOnStorefront: boolean;\n minLength: number;\n requiredCharacterClasses: number;\n createAccountConfirmation: boolean;\n customerAccessTokenLifetime: number;\n}"
|
|
147
|
+
}
|
|
148
|
+
]
|
|
149
|
+
},
|
|
150
|
+
"storefront-cart": {
|
|
151
|
+
"version": "3.2.0",
|
|
152
|
+
"models": [
|
|
153
|
+
{
|
|
154
|
+
"name": "Price",
|
|
155
|
+
"kind": "type",
|
|
156
|
+
"definition": "type Price = {\n value: number;\n currency?: string;\n regularPrice?: number;\n};"
|
|
157
|
+
},
|
|
158
|
+
{
|
|
159
|
+
"name": "Product",
|
|
160
|
+
"kind": "type",
|
|
161
|
+
"definition": "type Product = {\n productId: number;\n name: string;\n sku: string;\n topLevelSku?: string | null;\n specialToDate?: string | null;\n specialFromDate?: string | null;\n newToDate?: string | null;\n newFromDate?: string | null;\n createdAt?: string | null;\n updatedAt?: string | null;\n manufacturer?: string | null;\n countryOfManufacture?: string | null;\n categories?: string[] | null;\n productType?: string | null;\n pricing?: {\n regularPrice: number;\n minimalPrice?: number;\n maximalPrice?: number;\n specialPrice?: number;\n tierPricing?: {\n customerGroupId?: number | null;\n qty: number;\n value: number;\n }[];\n currencyCode: string | null;\n };\n canonicalUrl?: string | null;\n mainImageUrl?: string | null;\n};"
|
|
162
|
+
},
|
|
163
|
+
{
|
|
164
|
+
"name": "ConfigurableOption",
|
|
165
|
+
"kind": "type",
|
|
166
|
+
"definition": "type ConfigurableOption = {\n id: number;\n optionLabel: string;\n valueId: number;\n valueLabel: string;\n};"
|
|
167
|
+
},
|
|
168
|
+
{
|
|
169
|
+
"name": "BundleOption",
|
|
170
|
+
"kind": "type",
|
|
171
|
+
"definition": "type BundleOption = {\n id: string;\n optionLabel: string;\n valueId: number;\n valueLabel: string;\n};"
|
|
172
|
+
},
|
|
173
|
+
{
|
|
174
|
+
"name": "CustomizableOption",
|
|
175
|
+
"kind": "type",
|
|
176
|
+
"definition": "type CustomizableOption = {\n id: string;\n optionLabel: string;\n valueId: number;\n valueLabel: string;\n};"
|
|
177
|
+
},
|
|
178
|
+
{
|
|
179
|
+
"name": "CartModel",
|
|
180
|
+
"kind": "interface",
|
|
181
|
+
"definition": "interface CartModel {\n totalGiftOptions: {\n giftWrappingForItems: Price;\n giftWrappingForItemsInclTax: Price;\n giftWrappingForOrder: Price;\n giftWrappingForOrderInclTax: Price;\n printedCard: Price;\n printedCardInclTax: Price;\n };\n cartGiftWrapping: {\n uid: string;\n design: string;\n selected: boolean;\n image: WrappingImage;\n price: Price;\n }[];\n giftReceiptIncluded: boolean;\n printedCardIncluded: boolean;\n giftMessage: {\n recipientName: string;\n senderName: string;\n message: string;\n };\n appliedGiftCards: AppliedGiftCardProps[];\n id: string;\n totalQuantity: number;\n totalUniqueItems: number;\n errors?: ItemError[];\n items: Item[];\n miniCartMaxItems: Item[];\n total: {\n includingTax: Price;\n excludingTax: Price;\n };\n discount?: Price;\n subtotal: {\n excludingTax: Price;\n includingTax: Price;\n includingDiscountOnly: Price;\n };\n appliedTaxes: TotalPriceModifier[];\n totalTax?: Price;\n appliedDiscounts: TotalPriceModifier[];\n shipping?: Price;\n isVirtual?: boolean;\n addresses: {\n shipping?: {\n countryCode: string;\n zipCode?: string;\n regionCode?: string;\n }[];\n };\n isGuestCart?: boolean;\n hasOutOfStockItems?: boolean;\n hasFullyOutOfStockItems?: boolean;\n appliedCoupons?: Coupon[];\n}"
|
|
182
|
+
},
|
|
183
|
+
{
|
|
184
|
+
"name": "AppliedGiftCardProps",
|
|
185
|
+
"kind": "interface",
|
|
186
|
+
"definition": "interface AppliedGiftCardProps {\n code: string;\n appliedBalance: Price;\n currentBalance: Price;\n giftCardBalance: Price;\n expirationDate: string;\n}"
|
|
187
|
+
},
|
|
188
|
+
{
|
|
189
|
+
"name": "Item",
|
|
190
|
+
"kind": "interface",
|
|
191
|
+
"definition": "interface Item {\n giftWrappingAvailable: boolean;\n giftWrappingPrice: {\n currency: string;\n value: number;\n };\n productGiftWrapping: {\n uid: string;\n design: string;\n selected: boolean;\n image: WrappingImage;\n price: Price;\n }[];\n giftMessage: {\n recipientName: string;\n senderName: string;\n message: string;\n };\n priceTiers: PriceTier[];\n giftMessageAvailable: boolean | null;\n taxedPrice: Price;\n rowTotal: Price;\n rowTotalIncludingTax: Price;\n itemType: string;\n uid: string;\n url: ItemURL;\n canonicalUrl: string;\n categories: string[];\n quantity: number;\n sku: string;\n topLevelSku: string;\n name: string;\n image: ItemImage;\n links?: ItemLinks;\n price: Price;\n total: Price;\n discountedTotal?: Price;\n discount?: Price;\n regularPrice: Price;\n discounted: boolean;\n bundleOptions?: { [key: string]: any };\n bundleOptionsUIDs?: string[];\n selectedOptions?: { [key: string]: any };\n selectedOptionsUIDs?: { [key: string]: any };\n customizableOptions?: { [key: string]: any };\n message?: string;\n recipient?: string;\n recipientEmail?: string;\n sender?: string;\n senderEmail?: string;\n lowInventory?: boolean;\n insufficientQuantity?: boolean;\n onlyXLeftInStock?: number | null;\n outOfStock?: boolean;\n notAvailableMessage?: string;\n stockLevel?: String;\n discountPercentage?: number;\n savingsAmount?: Price;\n productAttributes?: Attribute[];\n fixedProductTaxes?: FixedProductTax[];\n}"
|
|
192
|
+
},
|
|
193
|
+
{
|
|
194
|
+
"name": "WrappingImage",
|
|
195
|
+
"kind": "interface",
|
|
196
|
+
"definition": "interface WrappingImage {\n url: string;\n design: string;\n}"
|
|
197
|
+
},
|
|
198
|
+
{
|
|
199
|
+
"name": "PartialAddress",
|
|
200
|
+
"kind": "interface",
|
|
201
|
+
"definition": "interface PartialAddress {\n countryCode: string;\n postCode?: string;\n region?: string;\n regionCode?: string;\n regionId?: number;\n}"
|
|
202
|
+
},
|
|
203
|
+
{
|
|
204
|
+
"name": "ShippingMethod",
|
|
205
|
+
"kind": "interface",
|
|
206
|
+
"definition": "interface ShippingMethod {\n carrierCode: string;\n methodCode: string;\n amountExclTax?: Price;\n amountInclTax?: Price;\n}"
|
|
207
|
+
},
|
|
208
|
+
{
|
|
209
|
+
"name": "StoreConfigModel",
|
|
210
|
+
"kind": "interface",
|
|
211
|
+
"definition": "interface StoreConfigModel {\n displayMiniCart: boolean;\n miniCartMaxItemsDisplay: number;\n cartExpiresInDays: number;\n cartSummaryDisplayTotal: number;\n cartSummaryMaxItems: number;\n defaultCountry: string;\n categoryFixedProductTaxDisplaySetting: string;\n productFixedProductTaxDisplaySetting: string;\n salesFixedProductTaxDisplaySetting: string;\n shoppingCartDisplaySetting: {\n fullSummary: boolean;\n grandTotal: boolean;\n price: number | string;\n shipping: number | string;\n subtotal: number | string;\n taxGiftWrapping: number | string;\n zeroTax: boolean;\n };\n useConfigurableParentThumbnail: boolean;\n allowGiftWrappingOnOrder: boolean | null;\n allowGiftWrappingOnOrderItems: boolean | null;\n allowGiftMessageOnOrder: boolean | null;\n allowGiftMessageOnOrderItems: boolean | null;\n allowGiftReceipt: boolean;\n allowPrintedCard: boolean;\n printedCardPrice: Price;\n cartGiftWrapping: string;\n cartPrintedCard: string;\n}"
|
|
212
|
+
},
|
|
213
|
+
{
|
|
214
|
+
"name": "GiftWrappingConfigProps",
|
|
215
|
+
"kind": "type",
|
|
216
|
+
"definition": "type GiftWrappingConfigProps = {\n uid: string;\n design: string;\n selected: boolean;\n image: WrappingImage;\n price: Price;\n};"
|
|
217
|
+
},
|
|
218
|
+
{
|
|
219
|
+
"name": "ProductGiftOptionsConfig",
|
|
220
|
+
"kind": "type",
|
|
221
|
+
"definition": "type ProductGiftOptionsConfig = {\n giftWrappingAvailable: boolean;\n giftMessageAvailable: boolean;\n giftWrappingPrice?: Price;\n giftMessage?: {\n recipientName?: string;\n senderName?: string;\n message?: string;\n };\n productGiftWrapping: GiftWrappingConfigProps[];\n};"
|
|
222
|
+
}
|
|
223
|
+
]
|
|
224
|
+
},
|
|
225
|
+
"storefront-checkout": {
|
|
226
|
+
"version": "3.2.1",
|
|
227
|
+
"models": [
|
|
228
|
+
{
|
|
229
|
+
"name": "Address",
|
|
230
|
+
"kind": "interface",
|
|
231
|
+
"definition": "interface Address {\n city: string;\n company?: string;\n country: Country;\n customAttributes: CustomAttribute[];\n customerAddressUid?: string;\n fax?: string;\n firstName: string;\n id?: number;\n lastName: string;\n middleName?: string;\n postCode?: string;\n prefix?: string;\n region?: Region;\n street: string[];\n suffix?: string;\n telephone?: string;\n uid: string;\n vatId?: string;\n}"
|
|
232
|
+
},
|
|
233
|
+
{
|
|
234
|
+
"name": "ShippingAddress",
|
|
235
|
+
"kind": "interface",
|
|
236
|
+
"definition": "interface ShippingAddress extends Address {\n availableShippingMethods?: ShippingMethod[];\n selectedShippingMethod?: ShippingMethod;\n}"
|
|
237
|
+
},
|
|
238
|
+
{
|
|
239
|
+
"name": "AddressInput",
|
|
240
|
+
"kind": "interface",
|
|
241
|
+
"definition": "interface AddressInput {\n city: string;\n company?: string;\n countryCode: string;\n customAttributes?: CustomAttribute[];\n fax?: string;\n firstName: string;\n lastName: string;\n middleName?: string;\n postcode?: string;\n prefix?: string;\n region?: string;\n regionId?: number;\n saveInAddressBook?: boolean;\n street: string[];\n suffix?: string;\n telephone?: string;\n vatId?: string;\n}"
|
|
242
|
+
},
|
|
243
|
+
{
|
|
244
|
+
"name": "CheckoutError",
|
|
245
|
+
"kind": "interface",
|
|
246
|
+
"definition": "interface CheckoutError {\n message: string;\n code?: string;\n}"
|
|
247
|
+
},
|
|
248
|
+
{
|
|
249
|
+
"name": "Country",
|
|
250
|
+
"kind": "type",
|
|
251
|
+
"definition": "type Country = {\n code: string;\n label: string;\n};"
|
|
252
|
+
},
|
|
253
|
+
{
|
|
254
|
+
"name": "CustomAttribute",
|
|
255
|
+
"kind": "type",
|
|
256
|
+
"definition": "type CustomAttribute = {\n code: string;\n value: string;\n};"
|
|
257
|
+
},
|
|
258
|
+
{
|
|
259
|
+
"name": "Money",
|
|
260
|
+
"kind": "type",
|
|
261
|
+
"definition": "type Money = {\n value: number;\n currency: string;\n};"
|
|
262
|
+
},
|
|
263
|
+
{
|
|
264
|
+
"name": "AdditionalData",
|
|
265
|
+
"kind": "type",
|
|
266
|
+
"definition": "type AdditionalData = Record<string, unknown>;"
|
|
267
|
+
},
|
|
268
|
+
{
|
|
269
|
+
"name": "PaymentMethod",
|
|
270
|
+
"kind": "type",
|
|
271
|
+
"definition": "type PaymentMethod = {\n code: string;\n title: string;\n additionalData?: AdditionalData;\n};"
|
|
272
|
+
},
|
|
273
|
+
{
|
|
274
|
+
"name": "Region",
|
|
275
|
+
"kind": "type",
|
|
276
|
+
"definition": "type Region = {\n code: string;\n id?: number;\n name: string;\n};"
|
|
277
|
+
},
|
|
278
|
+
{
|
|
279
|
+
"name": "ShippingMethod",
|
|
280
|
+
"kind": "type",
|
|
281
|
+
"definition": "type ShippingMethod = {\n amount: Money;\n carrier: Carrier;\n code: string;\n title: string;\n value: string;\n amountExclTax?: Money;\n amountInclTax?: Money;\n originalAmount?: Money;\n};"
|
|
282
|
+
},
|
|
283
|
+
{
|
|
284
|
+
"name": "ValuesModel",
|
|
285
|
+
"kind": "interface",
|
|
286
|
+
"definition": "interface ValuesModel {\n email: string;\n isBillToShipping: boolean | undefined;\n selectedPaymentMethod: PaymentMethod | null;\n selectedShippingMethod: ShippingMethod | null;\n}"
|
|
287
|
+
},
|
|
288
|
+
{
|
|
289
|
+
"name": "CartModel",
|
|
290
|
+
"kind": "interface",
|
|
291
|
+
"definition": "interface CartModel {\n id: string;\n totalQuantity: number;\n errors?: ItemError[];\n items: Item[];\n miniCartMaxItems: Item[];\n total: {\n includingTax: Price;\n excludingTax: Price;\n };\n discount?: Price;\n subtotal: {\n excludingTax: Price;\n includingTax: Price;\n includingDiscountOnly: Price;\n };\n appliedTaxes: TotalPriceModifier[];\n totalTax?: Price;\n appliedDiscounts: TotalPriceModifier[];\n shipping?: Price;\n isVirtual?: boolean;\n addresses: {\n shipping?: {\n countryCode: string;\n zipCode?: string;\n regionCode?: string;\n }[];\n };\n isGuestCart?: boolean;\n}"
|
|
292
|
+
},
|
|
293
|
+
{
|
|
294
|
+
"name": "Item",
|
|
295
|
+
"kind": "interface",
|
|
296
|
+
"definition": "interface Item {\n taxedPrice: Price;\n rowTotal: Price;\n rowTotalIncludingTax: Price;\n itemType: string;\n uid: string;\n url: ItemURL;\n quantity: number;\n sku: string;\n name: string;\n image: ItemImage;\n links?: ItemLinks;\n price: Price;\n total: Price;\n discountedTotal?: Price;\n discount?: Price;\n regularPrice: Price;\n discounted: boolean;\n bundleOptions?: { [key: string]: any };\n selectedOptions?: { [key: string]: any };\n customizableOptions?: { [key: string]: any };\n message?: string;\n recipient?: string;\n recipientEmail?: string;\n sender?: string;\n senderEmail?: string;\n lowInventory?: boolean;\n insufficientQuantity?: boolean;\n onlyXLeftInStock?: number | null;\n outOfStock?: boolean;\n notAvailableMessage?: string;\n stockLevel?: string;\n}"
|
|
297
|
+
},
|
|
298
|
+
{
|
|
299
|
+
"name": "NegotiableQuoteModel",
|
|
300
|
+
"kind": "interface",
|
|
301
|
+
"definition": "interface NegotiableQuoteModel {\n uid: string;\n name: string;\n createdAt: string;\n salesRepName: string;\n expirationDate: string;\n updatedAt: string;\n status: NegotiableQuoteStatus;\n buyer: {\n firstname: string;\n lastname: string;\n };\n templateName?: string;\n comments?: {\n uid: string;\n createdAt: string;\n author: {\n firstname: string;\n lastname: string;\n };\n text: string;\n attachments?: {\n name: string;\n url: string;\n }[];\n }[];\n history?: NegotiableQuoteHistoryEntry[];\n prices: {\n appliedDiscounts?: Discount[];\n appliedTaxes?: Tax[];\n discount?: Currency;\n grandTotal?: Currency;\n grandTotalExcludingTax?: Currency;\n shippingExcludingTax?: Currency;\n shippingIncludingTax?: Currency;\n subtotalExcludingTax?: Currency;\n subtotalIncludingTax?: Currency;\n subtotalWithDiscountExcludingTax?: Currency;\n totalTax?: Currency;\n };\n items: NegotiableQuoteCartItem[];\n shippingAddresses?: ShippingAddress[];\n canCheckout: boolean;\n canSendForReview: boolean;\n}"
|
|
302
|
+
},
|
|
303
|
+
{
|
|
304
|
+
"name": "NegotiableQuoteCartItem",
|
|
305
|
+
"kind": "interface",
|
|
306
|
+
"definition": "interface NegotiableQuoteCartItem {\n product: {\n uid: string;\n sku: string;\n name: string;\n templateId?: string;\n templateName?: string;\n priceRange: {\n maximumPrice: {\n regularPrice: {\n value: number;\n };\n };\n };\n };\n catalogDiscount: {\n amountOff: number;\n percentOff: number;\n };\n discounts: {\n label: string;\n value: string;\n amount: Currency;\n }[];\n stockStatus: string;\n quantity: number;\n prices: {\n originalItemPrice: Currency;\n rowTotal: Currency;\n };\n configurableOptions?: {\n optionLabel: string;\n valueLabel: string;\n }[];\n bundleOptions?: {\n label: string;\n values: {\n label: string;\n quantity: number;\n originalPrice: Currency;\n price: Currency;\n }[];\n }[];\n noteFromBuyer?: ItemNote[];\n noteFromSeller?: ItemNote[];\n}"
|
|
307
|
+
},
|
|
308
|
+
{
|
|
309
|
+
"name": "ItemNote",
|
|
310
|
+
"kind": "interface",
|
|
311
|
+
"definition": "interface ItemNote {\n createdAt: string;\n creatorId: number;\n creatorType: number;\n negotiableQuoteItemUid: string;\n note: string;\n noteUid: string;\n}"
|
|
312
|
+
},
|
|
313
|
+
{
|
|
314
|
+
"name": "Currency",
|
|
315
|
+
"kind": "interface",
|
|
316
|
+
"definition": "interface Currency {\n value: number;\n currency: string;\n}"
|
|
317
|
+
},
|
|
318
|
+
{
|
|
319
|
+
"name": "Tax",
|
|
320
|
+
"kind": "interface",
|
|
321
|
+
"definition": "interface Tax {\n amount: Currency;\n label: string;\n}"
|
|
322
|
+
},
|
|
323
|
+
{
|
|
324
|
+
"name": "Discount",
|
|
325
|
+
"kind": "interface",
|
|
326
|
+
"definition": "interface Discount {\n amount: Currency;\n label: string;\n coupon?: Coupon;\n}"
|
|
327
|
+
},
|
|
328
|
+
{
|
|
329
|
+
"name": "Coupon",
|
|
330
|
+
"kind": "interface",
|
|
331
|
+
"definition": "interface Coupon {\n code: string;\n}"
|
|
332
|
+
},
|
|
333
|
+
{
|
|
334
|
+
"name": "NegotiableQuoteListEntry",
|
|
335
|
+
"kind": "interface",
|
|
336
|
+
"definition": "interface NegotiableQuoteListEntry {\n uid: string;\n name: string;\n createdAt: string;\n updatedAt: string;\n status: NegotiableQuoteStatus;\n buyer: {\n firstname: string;\n lastname: string;\n };\n templateName: string;\n prices: {\n grandTotal: Currency;\n };\n}"
|
|
337
|
+
},
|
|
338
|
+
{
|
|
339
|
+
"name": "NegotiableQuoteHistoryEntry",
|
|
340
|
+
"kind": "interface",
|
|
341
|
+
"definition": "interface NegotiableQuoteHistoryEntry {\n author: {\n firstname: string;\n lastname: string;\n };\n changeType: NegotiableQuoteHistoryEntryChangeType;\n changes: {\n commentAdded?: {\n comment: string;\n };\n customChanges?: {\n new_value: string;\n old_value: string;\n title: string;\n };\n expiration?: {\n newExpiration: string;\n oldExpiration: string;\n };\n productsRemoved?: {\n productsRemovedFromCatalog: string[];\n productsRemovedFromQuote?: {\n uid: string;\n name: string;\n sku: string;\n quantity: number;\n }[];\n };\n statuses?: {\n changes: {\n newStatus: string;\n oldStatus: string;\n }[];\n };\n total?: {\n newPrice: Currency;\n oldPrice: Currency;\n };\n };\n createdAt: string;\n uid: string;\n}"
|
|
342
|
+
},
|
|
343
|
+
{
|
|
344
|
+
"name": "PaginationInfo",
|
|
345
|
+
"kind": "interface",
|
|
346
|
+
"definition": "interface PaginationInfo {\n currentPage: number;\n totalCount: number;\n pageSize: number;\n startItem: number;\n endItem: number;\n totalPages: number;\n pageSizeOptions?: number[];\n}"
|
|
347
|
+
},
|
|
348
|
+
{
|
|
349
|
+
"name": "PermissionsModel",
|
|
350
|
+
"kind": "interface",
|
|
351
|
+
"definition": "interface PermissionsModel {\n all?: boolean;\n admin?: boolean;\n [key: string]: boolean | undefined;\n}"
|
|
352
|
+
}
|
|
353
|
+
]
|
|
354
|
+
},
|
|
355
|
+
"storefront-company-management": {
|
|
356
|
+
"version": "1.2.0",
|
|
357
|
+
"models": [
|
|
358
|
+
{
|
|
359
|
+
"name": "CompanyStructureNodeType",
|
|
360
|
+
"kind": "type",
|
|
361
|
+
"definition": "type CompanyStructureNodeType = 'team' | 'user';"
|
|
362
|
+
},
|
|
363
|
+
{
|
|
364
|
+
"name": "CompanyStructureNode",
|
|
365
|
+
"kind": "interface",
|
|
366
|
+
"definition": "interface CompanyStructureNode {\n id: string; \n parentId: string | null; \n label: string;\n type: CompanyStructureNodeType;\n entityId?: string; \n description?: string | null; \n}"
|
|
367
|
+
},
|
|
368
|
+
{
|
|
369
|
+
"name": "Country",
|
|
370
|
+
"kind": "type",
|
|
371
|
+
"definition": "type Country = {\n value: string;\n text: string;\n availableRegions?: {\n id: number;\n code: string;\n name: string;\n }[];\n};"
|
|
372
|
+
},
|
|
373
|
+
{
|
|
374
|
+
"name": "StoreConfigModel",
|
|
375
|
+
"kind": "interface",
|
|
376
|
+
"definition": "interface StoreConfigModel {\n defaultCountry: string;\n storeCode: string;\n}"
|
|
377
|
+
},
|
|
378
|
+
{
|
|
379
|
+
"name": "CompanyDataProps",
|
|
380
|
+
"kind": "interface",
|
|
381
|
+
"definition": "interface CompanyDataProps {\n name: string;\n label: string;\n value: string;\n}"
|
|
382
|
+
},
|
|
383
|
+
{
|
|
384
|
+
"name": "CompanyDataContext",
|
|
385
|
+
"kind": "interface",
|
|
386
|
+
"definition": "interface CompanyDataContext {\n companyData: CompanyDataProps[];\n}"
|
|
387
|
+
},
|
|
388
|
+
{
|
|
389
|
+
"name": "CompanyStructureDataContext",
|
|
390
|
+
"kind": "interface",
|
|
391
|
+
"definition": "interface CompanyStructureDataContext {\n structureData: CompanyStructureNode[];\n}"
|
|
392
|
+
}
|
|
393
|
+
]
|
|
394
|
+
},
|
|
395
|
+
"storefront-order": {
|
|
396
|
+
"version": "3.3.0",
|
|
397
|
+
"models": [
|
|
398
|
+
{
|
|
399
|
+
"name": "OrdersReturnItemsPropsModel",
|
|
400
|
+
"kind": "interface",
|
|
401
|
+
"definition": "interface OrdersReturnItemsPropsModel extends OrderItemModel {\n quantity: number;\n requestQuantity: number;\n status: string;\n uid: string;\n}"
|
|
402
|
+
},
|
|
403
|
+
{
|
|
404
|
+
"name": "OrdersReturnTrackingProps",
|
|
405
|
+
"kind": "interface",
|
|
406
|
+
"definition": "interface OrdersReturnTrackingProps {\n status: {\n text: string;\n type: string;\n };\n carrier: {\n uid: string;\n label: string;\n };\n trackingNumber: string;\n}"
|
|
407
|
+
},
|
|
408
|
+
{
|
|
409
|
+
"name": "OrdersReturnPropsModel",
|
|
410
|
+
"kind": "interface",
|
|
411
|
+
"definition": "interface OrdersReturnPropsModel {\n token: string;\n orderNumber: string;\n returnStatus: string;\n returnNumber: string;\n createdReturnAt: string;\n tracking: OrdersReturnTrackingProps[];\n items: OrdersReturnItemsPropsModel[];\n}"
|
|
412
|
+
},
|
|
413
|
+
{
|
|
414
|
+
"name": "OrderAddressModel",
|
|
415
|
+
"kind": "type",
|
|
416
|
+
"definition": "type OrderAddressModel = {\n city: string;\n company: string;\n countryCode: string;\n firstName: string;\n middleName: string;\n lastName: string;\n postCode: string;\n region: string;\n regionId: string;\n street: string[];\n telephone: string;\n customAttributes: { code: string; value: string }[];\n} | null;"
|
|
417
|
+
},
|
|
418
|
+
{
|
|
419
|
+
"name": "OrderItemProductModel",
|
|
420
|
+
"kind": "type",
|
|
421
|
+
"definition": "type OrderItemProductModel = {\n onlyXLeftInStock?: number;\n priceRange?: {\n maximumPrice?: {\n regularPrice?: MoneyProps;\n };\n };\n uid: string;\n __typename: string;\n stockStatus?: string;\n canonicalUrl?: string;\n urlKey?: string;\n id: string;\n image?: string;\n imageAlt?: string;\n name: string;\n productType: string;\n sku: string;\n thumbnail: {\n url: string;\n label: string;\n };\n};"
|
|
422
|
+
},
|
|
423
|
+
{
|
|
424
|
+
"name": "OrderItemModel",
|
|
425
|
+
"kind": "type",
|
|
426
|
+
"definition": "type OrderItemModel = {\n giftMessage: {\n senderName: string;\n recipientName: string;\n message: string;\n };\n giftWrappingAvailable: boolean;\n giftWrappingPrice: MoneyProps;\n productGiftWrapping: {\n uid: string;\n design: string;\n selected: boolean;\n image: {\n url: string;\n label: string;\n };\n price: MoneyProps;\n }[];\n taxCalculations: {\n includeAndExcludeTax: {\n originalPrice: MoneyProps;\n baseOriginalPrice: MoneyProps;\n baseDiscountedPrice: MoneyProps;\n baseExcludingTax: MoneyProps;\n };\n excludeTax: {\n originalPrice: MoneyProps;\n baseOriginalPrice: MoneyProps;\n baseDiscountedPrice: MoneyProps;\n baseExcludingTax: MoneyProps;\n };\n includeTax: {\n singleItemPrice: MoneyProps;\n baseOriginalPrice: MoneyProps;\n baseDiscountedPrice: MoneyProps;\n };\n };\n productSalePrice: MoneyProps;\n status?: string;\n currentReturnOrderQuantity?: number;\n eligibleForReturn: boolean;\n productSku?: string;\n type?: string;\n discounted?: boolean;\n id: string;\n productName?: string;\n productUrlKey?: string;\n regularPrice?: MoneyProps;\n price: MoneyProps;\n product?: OrderItemProductModel;\n selectedOptions?: Array<{ label: string; value: any }>;\n thumbnail?: { label: string; url: string };\n downloadableLinks: { count: number; result: string } | null;\n prices: {\n priceIncludingTax: MoneyProps;\n originalPrice: MoneyProps;\n originalPriceIncludingTax: MoneyProps;\n price: MoneyProps;\n discounts: [\n {\n label: string;\n amount: {\n value: number;\n };\n }\n ];\n };\n itemPrices: {\n priceIncludingTax: MoneyProps;\n originalPrice: MoneyProps;\n originalPriceIncludingTax: MoneyProps;\n price: MoneyProps;\n discounts: [\n {\n label: string;\n amount: {\n value: number;\n };\n }\n ];\n };\n bundleOptions: Record<string, string> | null;\n totalInclTax: MoneyProps;\n priceInclTax: MoneyProps;\n total: MoneyProps;\n configurableOptions: Record<string, string | number | boolean> | undefined;\n giftCard?: {\n senderName: string;\n senderEmail: string;\n recipientEmail: string;\n recipientName: string;\n message: string;\n };\n quantityCanceled: number;\n quantityInvoiced: number;\n quantityOrdered: number;\n quantityRefunded: number;\n quantityReturned: number;\n quantityShipped: number;\n requestQuantity?: number;\n totalQuantity: number;\n returnableQuantity?: number;\n quantityReturnRequested: number;\n};"
|
|
427
|
+
},
|
|
428
|
+
{
|
|
429
|
+
"name": "ShipmentItemsModel",
|
|
430
|
+
"kind": "type",
|
|
431
|
+
"definition": "type ShipmentItemsModel = {\n id: string;\n productSku: string;\n productName: string;\n quantityShipped: number;\n orderItem: OrderItemModel;\n};"
|
|
432
|
+
},
|
|
433
|
+
{
|
|
434
|
+
"name": "ShipmentsTracingModel",
|
|
435
|
+
"kind": "type",
|
|
436
|
+
"definition": "type ShipmentsTracingModel = {\n carrier: string;\n number: string;\n title: string;\n};"
|
|
437
|
+
},
|
|
438
|
+
{
|
|
439
|
+
"name": "ShipmentsModel",
|
|
440
|
+
"kind": "type",
|
|
441
|
+
"definition": "type ShipmentsModel = {\n id: string;\n number: string;\n tracking: ShipmentsTracingModel[];\n comments: OrderCommentItem[];\n items: ShipmentItemsModel[];\n};"
|
|
442
|
+
},
|
|
443
|
+
{
|
|
444
|
+
"name": "OrderDataModel",
|
|
445
|
+
"kind": "type",
|
|
446
|
+
"definition": "type OrderDataModel = {\n giftReceiptIncluded: boolean;\n printedCardIncluded: boolean;\n giftWrappingOrder: {\n price: MoneyProps;\n uid: string;\n };\n placeholderImage?: string;\n returnNumber?: string;\n id: string;\n orderStatusChangeDate?: string;\n number: string;\n email: string;\n token?: string;\n status: string;\n isVirtual: boolean;\n totalQuantity: number;\n shippingMethod?: string;\n carrier?: string;\n orderDate: string;\n comments: OrderCommentItem[];\n returns: OrdersReturnPropsModel[];\n discounts: { amount: MoneyProps; label: string }[];\n coupons: {\n code: string;\n }[];\n payments: {\n code: string;\n name: string;\n }[];\n shipping?: { code: string; amount: number; currency: string };\n shipments: ShipmentsModel[];\n items: OrderItemModel[];\n totalGiftCard: MoneyProps;\n grandTotal: MoneyProps;\n grandTotalExclTax: MoneyProps;\n totalShipping?: MoneyProps;\n subtotalExclTax: MoneyProps;\n subtotalInclTax: MoneyProps;\n totalTax: MoneyProps;\n shippingAddress: OrderAddressModel;\n totalGiftOptions: {\n giftWrappingForItems: MoneyProps;\n giftWrappingForItemsInclTax: MoneyProps;\n giftWrappingForOrder: MoneyProps;\n giftWrappingForOrderInclTax: MoneyProps;\n printedCard: MoneyProps;\n printedCardInclTax: MoneyProps;\n };\n billingAddress: OrderAddressModel;\n availableActions: AvailableActionsProps[];\n taxes: { amount: MoneyProps; rate: number; title: string }[];\n appliedGiftCards: {\n code: string;\n appliedBalance: MoneyProps;\n }[];\n};"
|
|
447
|
+
},
|
|
448
|
+
{
|
|
449
|
+
"name": "StoreConfigModel",
|
|
450
|
+
"kind": "interface",
|
|
451
|
+
"definition": "interface StoreConfigModel {\n baseMediaUrl: string;\n orderCancellationEnabled: boolean;\n orderCancellationReasons: OrderCancellationReason[];\n shoppingOrderDisplayPrice: OrderDisplayPriceProps;\n shoppingOrdersDisplayShipping: OrderDisplayPriceProps;\n shoppingOrdersDisplaySubtotal: OrderDisplayPriceProps;\n shoppingOrdersDisplayFullSummary: boolean;\n shoppingOrdersDisplayGrandTotal: boolean;\n shoppingOrdersDisplayZeroTax: boolean;\n salesPrintedCard: number;\n salesGiftWrapping: number;\n}"
|
|
452
|
+
},
|
|
453
|
+
{
|
|
454
|
+
"name": "OrderCancellationReason",
|
|
455
|
+
"kind": "interface",
|
|
456
|
+
"definition": "interface OrderCancellationReason {\n description: string;\n}"
|
|
457
|
+
},
|
|
458
|
+
{
|
|
459
|
+
"name": "MoneyProps",
|
|
460
|
+
"kind": "interface",
|
|
461
|
+
"definition": "interface MoneyProps {\n value: number;\n currency: string;\n}"
|
|
462
|
+
},
|
|
463
|
+
{
|
|
464
|
+
"name": "ReturnProps",
|
|
465
|
+
"kind": "interface",
|
|
466
|
+
"definition": "interface ReturnProps {\n uid: string;\n number: string;\n status: string;\n created_at: string;\n}"
|
|
467
|
+
},
|
|
468
|
+
{
|
|
469
|
+
"name": "StepsTypes",
|
|
470
|
+
"kind": "type",
|
|
471
|
+
"definition": "type StepsTypes = 'products' | 'attributes' | 'success' | 'error';"
|
|
472
|
+
},
|
|
473
|
+
{
|
|
474
|
+
"name": "KeysSortOrderProps",
|
|
475
|
+
"kind": "interface",
|
|
476
|
+
"definition": "interface KeysSortOrderProps {\n name: string;\n orderNumber?: number;\n label?: string | null;\n}"
|
|
477
|
+
},
|
|
478
|
+
{
|
|
479
|
+
"name": "CustomerAddressesModel",
|
|
480
|
+
"kind": "interface",
|
|
481
|
+
"definition": "interface CustomerAddressesModel {\n firstname?: string;\n lastname?: string;\n city?: string;\n company?: string;\n countryCode?: string;\n region?: { region: string; regionCode: string; regionId: string | number };\n telephone?: string;\n id?: string;\n vatId?: string;\n postcode?: string;\n street?: string;\n street_2?: string;\n defaultShipping?: boolean;\n defaultBilling?: boolean;\n}"
|
|
482
|
+
},
|
|
483
|
+
{
|
|
484
|
+
"name": "OrderCommentItem",
|
|
485
|
+
"kind": "interface",
|
|
486
|
+
"definition": "interface OrderCommentItem {\n message: string;\n timestamp: string;\n}"
|
|
487
|
+
}
|
|
488
|
+
]
|
|
489
|
+
},
|
|
490
|
+
"storefront-pdp": {
|
|
491
|
+
"version": "3.1.0",
|
|
492
|
+
"models": [
|
|
493
|
+
{
|
|
494
|
+
"name": "Product",
|
|
495
|
+
"kind": "type",
|
|
496
|
+
"definition": "type Product = {\n productId: number;\n name: string;\n sku: string;\n topLevelSku?: string | null;\n variantName?: string | null;\n specialToDate?: string | null;\n specialFromDate?: string | null;\n newToDate?: string | null;\n newFromDate?: string | null;\n createdAt?: string | null;\n updatedAt?: string | null;\n manufacturer?: string | null;\n countryOfManufacture?: string | null;\n categories?: string[] | null;\n productType?: ProductType;\n pricing?: {\n regularPrice: number;\n minimalPrice?: number;\n maximalPrice?: number;\n specialPrice?: number;\n tierPricing?: {\n customerGroupId?: number | null;\n qty: number;\n value: number;\n }[];\n currencyCode: string | null;\n };\n canonicalUrl?: string | null;\n mainImageUrl?: string | null;\n};"
|
|
497
|
+
},
|
|
498
|
+
{
|
|
499
|
+
"name": "ProductModel",
|
|
500
|
+
"kind": "interface",
|
|
501
|
+
"definition": "interface ProductModel {\n name: string;\n sku: string;\n isBundle: boolean;\n addToCartAllowed: boolean;\n inStock: boolean | null;\n shortDescription?: string;\n metaDescription?: string;\n metaKeyword?: string;\n metaTitle?: string;\n description?: string;\n images?: Image[];\n videos?: Video[];\n prices?: Prices;\n attributes?: Attribute[];\n options?: Option[];\n optionUIDs?: string[];\n url?: string;\n urlKey?: string;\n externalId?: string;\n externalParentId?: string;\n variantSku?: string;\n variantName?: string;\n productType?: ProductType | undefined;\n}"
|
|
502
|
+
},
|
|
503
|
+
{
|
|
504
|
+
"name": "Option",
|
|
505
|
+
"kind": "interface",
|
|
506
|
+
"definition": "interface Option {\n id: string;\n type: 'text' | 'image' | 'color' | 'dropdown';\n typename:\n | 'ProductViewOptionValueProduct'\n | 'ProductViewOptionValueSwatch'\n | 'ProductViewOptionValueConfiguration';\n label: string;\n required: boolean;\n multiple: boolean;\n items: OptionValue[];\n}"
|
|
507
|
+
},
|
|
508
|
+
{
|
|
509
|
+
"name": "ValuesModel",
|
|
510
|
+
"kind": "interface",
|
|
511
|
+
"definition": "interface ValuesModel {\n sku: string;\n quantity: number;\n optionsUIDs?: string[];\n enteredOptions?: Array<{ uid: string; value: string }>;\n}"
|
|
512
|
+
}
|
|
513
|
+
]
|
|
514
|
+
},
|
|
515
|
+
"storefront-personalization": {
|
|
516
|
+
"version": "3.1.1",
|
|
517
|
+
"models": [
|
|
518
|
+
{
|
|
519
|
+
"name": "PersonalizationData",
|
|
520
|
+
"kind": "interface",
|
|
521
|
+
"definition": "interface PersonalizationData {\n segments: string[],\n groups: string[],\n cartRules: string[]\n}"
|
|
522
|
+
},
|
|
523
|
+
{
|
|
524
|
+
"name": "StoreConfigModel",
|
|
525
|
+
"kind": "interface",
|
|
526
|
+
"definition": "interface StoreConfigModel {\n shareActiveSegments: boolean;\n shareCustomerGroup: boolean;\n shareAppliedCartRule: boolean;\n customerAccessTokenLifetime: number;\n}"
|
|
527
|
+
},
|
|
528
|
+
{
|
|
529
|
+
"name": "CartModel",
|
|
530
|
+
"kind": "interface",
|
|
531
|
+
"definition": "interface CartModel {\n id: string;\n}"
|
|
532
|
+
},
|
|
533
|
+
{
|
|
534
|
+
"name": "OrderDataModel",
|
|
535
|
+
"kind": "interface",
|
|
536
|
+
"definition": "interface OrderDataModel {\n id: string;\n}"
|
|
537
|
+
}
|
|
538
|
+
]
|
|
539
|
+
},
|
|
540
|
+
"storefront-purchase-order": {
|
|
541
|
+
"version": "1.1.1",
|
|
542
|
+
"models": [
|
|
543
|
+
{
|
|
544
|
+
"name": "CartModel",
|
|
545
|
+
"kind": "interface",
|
|
546
|
+
"definition": "interface CartModel {\n cart: {\n id: string;\n items: {\n uid: string;\n quantity: number;\n product: {\n uid: string;\n name: string;\n sku: string;\n };\n }[];\n pagination?: {\n currentPage: number;\n pageSize: number;\n totalPages: number;\n totalCount: number;\n };\n };\n userErrors: Array<{\n message: string;\n }>;\n}"
|
|
547
|
+
},
|
|
548
|
+
{
|
|
549
|
+
"name": "Money",
|
|
550
|
+
"kind": "interface",
|
|
551
|
+
"definition": "interface Money {\n value: number;\n currency: string;\n}"
|
|
552
|
+
},
|
|
553
|
+
{
|
|
554
|
+
"name": "Coupon",
|
|
555
|
+
"kind": "interface",
|
|
556
|
+
"definition": "interface Coupon {\n code: string;\n label: string;\n}"
|
|
557
|
+
},
|
|
558
|
+
{
|
|
559
|
+
"name": "PaymentMethod",
|
|
560
|
+
"kind": "interface",
|
|
561
|
+
"definition": "interface PaymentMethod {\n name: string;\n type: string;\n additionalData: Record<string, any>;\n}"
|
|
562
|
+
},
|
|
563
|
+
{
|
|
564
|
+
"name": "OrderItem",
|
|
565
|
+
"kind": "interface",
|
|
566
|
+
"definition": "interface OrderItem {\n id: string;\n productName: string;\n productSku: string;\n quantityOrdered: number;\n quantityShipped: number;\n quantityInvoiced: number;\n quantityRefunded: number;\n price: Money;\n total: Money;\n}"
|
|
567
|
+
},
|
|
568
|
+
{
|
|
569
|
+
"name": "PurchaseOrderModel",
|
|
570
|
+
"kind": "interface",
|
|
571
|
+
"definition": "interface PurchaseOrderModel {\n typename: string;\n uid: string;\n number: string;\n status: string;\n availableActions: string[];\n approvalFlow:\n | {\n ruleName: string;\n events: Array<{\n message: string;\n name: string;\n role: string;\n status: string;\n updatedAt: string;\n }>;\n }[]\n | [];\n comments?: Array<{\n uid: string;\n createdAt: string;\n author: {\n firstname: string;\n lastname: string;\n email: string;\n };\n text: string;\n }>;\n createdAt: string;\n updatedAt: string;\n createdBy: {\n firstname: string;\n lastname: string;\n email: string;\n };\n historyLog?: Array<{\n activity: string;\n createdAt: string;\n message: string;\n uid: string;\n }>;\n quote: QuoteProps | null;\n order: {\n orderNumber: string;\n id: string;\n };\n}"
|
|
572
|
+
},
|
|
573
|
+
{
|
|
574
|
+
"name": "PurchaseOrderStatusSlotContext",
|
|
575
|
+
"kind": "type",
|
|
576
|
+
"definition": "type PurchaseOrderStatusSlotContext = {\n loading: boolean;\n availableActions?: PURCHASE_ORDER_ACTION[];\n handleApprove: () => void;\n handleReject: () => void;\n handleCancel: () => void;\n handlePlaceOrder: () => void;\n};"
|
|
577
|
+
}
|
|
578
|
+
]
|
|
579
|
+
},
|
|
580
|
+
"storefront-quick-order": {
|
|
581
|
+
"version": "1.0.0-beta.3",
|
|
582
|
+
"models": [
|
|
583
|
+
{
|
|
584
|
+
"name": "AddAllToCartContext",
|
|
585
|
+
"kind": "type",
|
|
586
|
+
"definition": "type AddAllToCartContext = {\n handleAddToCart: (() => void) | undefined;\n clearItems: (() => void) | undefined;\n loading?: boolean;\n isDisabledButton?: boolean;\n};"
|
|
587
|
+
},
|
|
588
|
+
{
|
|
589
|
+
"name": "QuickOrderItemSearchContext",
|
|
590
|
+
"kind": "type",
|
|
591
|
+
"definition": "type QuickOrderItemSearchContext = {\n item: OrderItem;\n scope: string;\n handleSearchChange: (e: Event) => void;\n searchResults: OrderItem[];\n searchValue: string;\n shouldShowResults: boolean;\n handleItemClick: (item: OrderItem) => void;\n};"
|
|
592
|
+
},
|
|
593
|
+
{
|
|
594
|
+
"name": "QuickOrderSearchAutocompleteItemContext",
|
|
595
|
+
"kind": "type",
|
|
596
|
+
"definition": "type QuickOrderSearchAutocompleteItemContext<\n T extends SearchItem = SearchItem\n> = {\n item: T;\n index: number;\n activeIndex: number;\n createItemClickHandler: (item: T) => () => void;\n};"
|
|
597
|
+
},
|
|
598
|
+
{
|
|
599
|
+
"name": "ProductPriceContext",
|
|
600
|
+
"kind": "type",
|
|
601
|
+
"definition": "type ProductPriceContext = {\n item: OrderItem;\n scope: string;\n};"
|
|
602
|
+
},
|
|
603
|
+
{
|
|
604
|
+
"name": "ProductOptionsContext",
|
|
605
|
+
"kind": "type",
|
|
606
|
+
"definition": "type ProductOptionsContext = {\n item: OrderItem;\n scope: string;\n};"
|
|
607
|
+
},
|
|
608
|
+
{
|
|
609
|
+
"name": "ProductImage",
|
|
610
|
+
"kind": "interface",
|
|
611
|
+
"definition": "interface ProductImage {\n url: string;\n label: string;\n roles: string[];\n}"
|
|
612
|
+
},
|
|
613
|
+
{
|
|
614
|
+
"name": "ProductPrice",
|
|
615
|
+
"kind": "interface",
|
|
616
|
+
"definition": "interface ProductPrice {\n regular?: {\n amount?: number;\n currency?: string;\n variant?: string;\n };\n final: {\n amount?: number;\n minimumAmount?: number;\n maximumAmount?: number;\n currency: string;\n variant?: string;\n };\n tiers: Array<unknown>;\n visible: boolean;\n}"
|
|
617
|
+
},
|
|
618
|
+
{
|
|
619
|
+
"name": "ProductAttribute",
|
|
620
|
+
"kind": "interface",
|
|
621
|
+
"definition": "interface ProductAttribute {\n id: string;\n label: string;\n value: string;\n}"
|
|
622
|
+
},
|
|
623
|
+
{
|
|
624
|
+
"name": "ProductOptionItem",
|
|
625
|
+
"kind": "interface",
|
|
626
|
+
"definition": "interface ProductOptionItem {\n id: string;\n inStock: boolean;\n label: string;\n selected: boolean;\n value: string;\n}"
|
|
627
|
+
},
|
|
628
|
+
{
|
|
629
|
+
"name": "ProductOption",
|
|
630
|
+
"kind": "interface",
|
|
631
|
+
"definition": "interface ProductOption {\n id: string;\n type: string;\n typename: string;\n label: string;\n required: boolean;\n multiple: boolean;\n items: ProductOptionItem[];\n}"
|
|
632
|
+
},
|
|
633
|
+
{
|
|
634
|
+
"name": "ProductData",
|
|
635
|
+
"kind": "interface",
|
|
636
|
+
"definition": "interface ProductData {\n name: string;\n sku: string;\n isBundle: boolean;\n addToCartAllowed: boolean;\n inStock: boolean;\n shortDescription: string;\n metaDescription: string;\n metaKeyword: string;\n metaTitle: string;\n description: string;\n images: ProductImage[];\n prices: ProductPrice;\n attributes: ProductAttribute[];\n options: ProductOption[];\n optionUIDs?: string[]; \n url: string;\n urlKey: string;\n externalId: string;\n productType: string;\n}"
|
|
637
|
+
},
|
|
638
|
+
{
|
|
639
|
+
"name": "OrderItem",
|
|
640
|
+
"kind": "interface",
|
|
641
|
+
"definition": "interface OrderItem extends ProductData {\n id?: string;\n variantSku?: string;\n parentSku?: string;\n sku: string;\n quantity: number;\n}"
|
|
642
|
+
},
|
|
643
|
+
{
|
|
644
|
+
"name": "SubmitSkuValue",
|
|
645
|
+
"kind": "type",
|
|
646
|
+
"definition": "type SubmitSkuValue = Array<{ sku: string; quantity: number }>;"
|
|
647
|
+
},
|
|
648
|
+
{
|
|
649
|
+
"name": "ProductVariantAttribute",
|
|
650
|
+
"kind": "interface",
|
|
651
|
+
"definition": "interface ProductVariantAttribute {\n name: string;\n label: string;\n value: string | number;\n roles: string[];\n}"
|
|
652
|
+
},
|
|
653
|
+
{
|
|
654
|
+
"name": "ProductVariantImage",
|
|
655
|
+
"kind": "interface",
|
|
656
|
+
"definition": "interface ProductVariantImage {\n url: string;\n}"
|
|
657
|
+
},
|
|
658
|
+
{
|
|
659
|
+
"name": "ProductVariantPrice",
|
|
660
|
+
"kind": "interface",
|
|
661
|
+
"definition": "interface ProductVariantPrice {\n final: {\n amount: {\n currency: string;\n value: number;\n };\n };\n}"
|
|
662
|
+
},
|
|
663
|
+
{
|
|
664
|
+
"name": "ProductVariant",
|
|
665
|
+
"kind": "interface",
|
|
666
|
+
"definition": "interface ProductVariant {\n selections?: string[];\n parentSku?: string;\n product: {\n sku: string;\n name: string;\n inStock: boolean;\n images: ProductVariantImage[];\n attributes: ProductVariantAttribute[];\n price: ProductVariantPrice;\n };\n}"
|
|
667
|
+
},
|
|
668
|
+
{
|
|
669
|
+
"name": "VariantTableData",
|
|
670
|
+
"kind": "interface",
|
|
671
|
+
"definition": "interface VariantTableData {\n sku: string;\n name: string;\n inStock: boolean;\n attributes: Record<string, { label: string; value: string | number }>;\n price: number;\n quantity: number;\n subtotal: number;\n image: string;\n optionsUIDs?: string[];\n parentSku?: string;\n}"
|
|
672
|
+
},
|
|
673
|
+
{
|
|
674
|
+
"name": "VariantActionsContext",
|
|
675
|
+
"kind": "type",
|
|
676
|
+
"definition": "type VariantActionsContext = {\n onClear: () => void;\n onSaveToCsv: () => void;\n onCollectData: () => VariantTableData[];\n isDisabled: boolean;\n variantsCount: number;\n};"
|
|
677
|
+
},
|
|
678
|
+
{
|
|
679
|
+
"name": "VariantCellContext",
|
|
680
|
+
"kind": "type",
|
|
681
|
+
"definition": "type VariantCellContext = {\n variant: ProductVariant;\n quantity: number;\n onQuantityChange: (sku: string, quantity: number) => void;\n};"
|
|
682
|
+
},
|
|
683
|
+
{
|
|
684
|
+
"name": "SearchItem",
|
|
685
|
+
"kind": "interface",
|
|
686
|
+
"definition": "interface SearchItem {\n sku: string;\n [key: string]: any;\n}"
|
|
687
|
+
}
|
|
688
|
+
]
|
|
689
|
+
},
|
|
690
|
+
"storefront-quote-management": {
|
|
691
|
+
"version": "1.1.2",
|
|
692
|
+
"models": [
|
|
693
|
+
{
|
|
694
|
+
"name": "ShippingAddress",
|
|
695
|
+
"kind": "interface",
|
|
696
|
+
"definition": "interface ShippingAddress {\n uid?: string;\n firstname: string;\n lastname: string;\n company?: string;\n street: string[];\n city: string;\n region?: {\n code: string;\n label: string;\n regionId: number;\n };\n postcode: string;\n country: {\n code: string;\n label: string;\n };\n telephone: string;\n}"
|
|
697
|
+
},
|
|
698
|
+
{
|
|
699
|
+
"name": "NegotiableQuoteModel",
|
|
700
|
+
"kind": "interface",
|
|
701
|
+
"definition": "interface NegotiableQuoteModel {\n uid: string;\n name: string;\n createdAt: string;\n salesRepName: string;\n expirationDate: string;\n updatedAt: string;\n status: NegotiableQuoteStatus;\n isVirtual: boolean;\n buyer: {\n firstname: string;\n lastname: string;\n };\n email?: string;\n templateName?: string;\n totalQuantity: number;\n comments?: {\n uid: string;\n createdAt: string;\n author: {\n firstname: string;\n lastname: string;\n };\n text: string;\n attachments?: {\n name: string;\n url: string;\n }[];\n }[];\n history?: NegotiableQuoteHistoryEntry[];\n prices: {\n appliedDiscounts?: Discount[];\n appliedTaxes?: Tax[];\n discount?: Currency;\n grandTotal?: Currency;\n grandTotalExcludingTax?: Currency;\n shippingExcludingTax?: Currency;\n shippingIncludingTax?: Currency;\n subtotalExcludingTax?: Currency;\n subtotalIncludingTax?: Currency;\n subtotalWithDiscountExcludingTax?: Currency;\n totalTax?: Currency;\n };\n items: CartItemModel[];\n shippingAddresses?: ShippingAddress[];\n canCheckout: boolean;\n canSendForReview: boolean;\n lockedForEditing?: boolean;\n canDelete: boolean;\n canClose: boolean;\n canUpdateQuote: boolean;\n readOnly: boolean;\n}"
|
|
702
|
+
},
|
|
703
|
+
{
|
|
704
|
+
"name": "ConfigurableOption",
|
|
705
|
+
"kind": "interface",
|
|
706
|
+
"definition": "interface ConfigurableOption {\n optionLabel: string;\n valueLabel: string;\n}"
|
|
707
|
+
},
|
|
708
|
+
{
|
|
709
|
+
"name": "BundleOption",
|
|
710
|
+
"kind": "interface",
|
|
711
|
+
"definition": "interface BundleOption {\n label: string;\n values: {\n label: string;\n quantity: number;\n originalPrice: Currency;\n price: Currency;\n }[];\n}"
|
|
712
|
+
},
|
|
713
|
+
{
|
|
714
|
+
"name": "CustomizableOption",
|
|
715
|
+
"kind": "interface",
|
|
716
|
+
"definition": "interface CustomizableOption {\n type: string;\n label: string;\n values: {\n label: string;\n value: string;\n }[];\n}"
|
|
717
|
+
},
|
|
718
|
+
{
|
|
719
|
+
"name": "CartItemModel",
|
|
720
|
+
"kind": "interface",
|
|
721
|
+
"definition": "interface CartItemModel {\n itemType: string;\n uid: string;\n product: {\n uid: string;\n sku: string;\n name: string;\n templateId?: string;\n templateName?: string;\n priceRange: {\n maximumPrice: {\n regularPrice: Currency;\n };\n };\n };\n image: ItemImage;\n links?: ItemLinks;\n discounted: boolean;\n discountedTotal: Currency;\n catalogDiscount: {\n amountOff: number;\n percentOff: number;\n };\n rowCatalogDiscount: {\n amountOff: number;\n percentOff: number;\n };\n discounts: {\n label: string;\n value: string;\n amount: Currency;\n }[];\n discountPercentage?: number;\n insufficientQuantity?: boolean;\n outOfStock?: boolean;\n stockStatus: string;\n quantity: number;\n prices: {\n regularPrice: Currency;\n priceIncludingTax: Currency;\n originalItemPrice: Currency;\n originalRowTotal: Currency;\n rowTotal: Currency;\n rowTotalIncludingTax: Currency;\n };\n savingsAmount?: Currency;\n configurableOptions?: ConfigurableOption[];\n bundleOptions?: BundleOption[];\n customizableOptions?: CustomizableOption[];\n noteFromBuyer?: ItemNote[];\n noteFromSeller?: ItemNote[];\n}"
|
|
722
|
+
},
|
|
723
|
+
{
|
|
724
|
+
"name": "ItemNote",
|
|
725
|
+
"kind": "interface",
|
|
726
|
+
"definition": "interface ItemNote {\n createdAt: string;\n creatorId: number;\n creatorType: number;\n negotiableQuoteItemUid: string;\n note: string;\n noteUid: string;\n}"
|
|
727
|
+
},
|
|
728
|
+
{
|
|
729
|
+
"name": "Currency",
|
|
730
|
+
"kind": "interface",
|
|
731
|
+
"definition": "interface Currency {\n value: number;\n currency: string;\n}"
|
|
732
|
+
},
|
|
733
|
+
{
|
|
734
|
+
"name": "Tax",
|
|
735
|
+
"kind": "interface",
|
|
736
|
+
"definition": "interface Tax {\n amount: Currency;\n label: string;\n}"
|
|
737
|
+
},
|
|
738
|
+
{
|
|
739
|
+
"name": "Discount",
|
|
740
|
+
"kind": "interface",
|
|
741
|
+
"definition": "interface Discount {\n amount: Currency;\n label: string;\n coupon?: Coupon;\n}"
|
|
742
|
+
},
|
|
743
|
+
{
|
|
744
|
+
"name": "Coupon",
|
|
745
|
+
"kind": "interface",
|
|
746
|
+
"definition": "interface Coupon {\n code: string;\n}"
|
|
747
|
+
},
|
|
748
|
+
{
|
|
749
|
+
"name": "NegotiableQuoteListEntry",
|
|
750
|
+
"kind": "interface",
|
|
751
|
+
"definition": "interface NegotiableQuoteListEntry {\n uid: string;\n name: string;\n createdAt: string;\n updatedAt: string;\n status: NegotiableQuoteStatus;\n buyer: {\n firstname: string;\n lastname: string;\n };\n templateName: string;\n prices: {\n grandTotal: Currency;\n };\n}"
|
|
752
|
+
},
|
|
753
|
+
{
|
|
754
|
+
"name": "NegotiableQuoteHistoryEntry",
|
|
755
|
+
"kind": "interface",
|
|
756
|
+
"definition": "interface NegotiableQuoteHistoryEntry {\n author: {\n firstname: string;\n lastname: string;\n };\n changeType: NegotiableQuoteHistoryEntryChangeType;\n changes: {\n commentAdded?: {\n comment: string;\n };\n customChanges?: {\n new_value: string;\n old_value: string;\n title: string;\n };\n expiration?: {\n newExpiration: string;\n oldExpiration: string;\n };\n productsRemoved?: {\n productsRemovedFromCatalog: string[];\n productsRemovedFromQuote?: {\n uid: string;\n name: string;\n sku: string;\n quantity: number;\n }[];\n };\n statuses?: {\n changes: {\n newStatus: string;\n oldStatus: string;\n }[];\n };\n total?: {\n newPrice: Currency;\n oldPrice: Currency;\n };\n };\n createdAt: string;\n uid: string;\n}"
|
|
757
|
+
},
|
|
758
|
+
{
|
|
759
|
+
"name": "PaginationInfo",
|
|
760
|
+
"kind": "interface",
|
|
761
|
+
"definition": "interface PaginationInfo {\n currentPage: number;\n totalCount: number;\n pageSize: number;\n startItem: number;\n endItem: number;\n totalPages: number;\n pageSizeOptions?: number[];\n}"
|
|
762
|
+
},
|
|
763
|
+
{
|
|
764
|
+
"name": "NegotiableQuoteTemplateModel",
|
|
765
|
+
"kind": "interface",
|
|
766
|
+
"definition": "interface NegotiableQuoteTemplateModel {\n id: string;\n uid: string;\n name: string;\n createdAt: string;\n updatedAt: string;\n expirationDate?: string;\n status: NegotiableQuoteTemplateStatus;\n salesRepName: string;\n buyer: {\n firstname: string;\n lastname: string;\n };\n comments?: QuoteTemplateComment[];\n history?: NegotiableQuoteHistoryEntry[];\n prices: {\n subtotalExcludingTax?: Currency;\n subtotalIncludingTax?: Currency;\n subtotalWithDiscountExcludingTax?: Currency;\n grandTotal?: Currency;\n appliedTaxes?: {\n amount: Currency;\n label: string;\n }[];\n };\n items: CartItemModel[];\n shippingAddresses?: ShippingAddress[];\n referenceDocuments?: {\n uid: string;\n name: string;\n identifier?: string;\n url: string;\n }[];\n quantityThresholds?: {\n min?: number;\n max?: number;\n };\n canAccept: boolean;\n canDelete: boolean;\n canReopen: boolean;\n canCancel: boolean;\n canSendForReview: boolean;\n canGenerateQuoteFromTemplate: boolean;\n canEditTemplateItems: boolean;\n}"
|
|
767
|
+
},
|
|
768
|
+
{
|
|
769
|
+
"name": "QuoteTemplateComment",
|
|
770
|
+
"kind": "interface",
|
|
771
|
+
"definition": "interface QuoteTemplateComment {\n uid: string;\n createdAt: string;\n author: {\n firstname: string;\n lastname: string;\n };\n text: string;\n attachments?: {\n name: string;\n url: string;\n }[];\n}"
|
|
772
|
+
},
|
|
773
|
+
{
|
|
774
|
+
"name": "NegotiableQuoteTemplatesListModel",
|
|
775
|
+
"kind": "interface",
|
|
776
|
+
"definition": "interface NegotiableQuoteTemplatesListModel {\n items: NegotiableQuoteTemplateListEntry[];\n pageInfo: {\n currentPage: number;\n pageSize: number;\n totalPages: number;\n };\n totalCount: number;\n paginationInfo?: PaginationInfo;\n sortFields?: {\n default: string;\n options: Array<{\n label: string;\n value: string;\n }>;\n };\n}"
|
|
777
|
+
},
|
|
778
|
+
{
|
|
779
|
+
"name": "NegotiableQuoteTemplateListEntry",
|
|
780
|
+
"kind": "interface",
|
|
781
|
+
"definition": "interface NegotiableQuoteTemplateListEntry {\n id: string;\n uid: string;\n name: string;\n createdAt: string;\n updatedAt: string;\n status: NegotiableQuoteTemplateStatus;\n state: 'active' | 'inactive' | 'in_review';\n lastSharedAt: string;\n lastOrderedAt: string;\n expirationDate: string;\n ordersPlaced: number;\n prices: {\n grandTotal: Currency;\n minNegotiatedGrandTotal: Currency;\n };\n canGenerateQuoteFromTemplate?: boolean;\n}"
|
|
782
|
+
},
|
|
783
|
+
{
|
|
784
|
+
"name": "StoreConfigModel",
|
|
785
|
+
"kind": "interface",
|
|
786
|
+
"definition": "interface StoreConfigModel {\n quoteSummaryDisplayTotal: number;\n quoteSummaryMaxItems: number;\n quoteDisplaySettings: {\n zeroTax: boolean;\n subtotal: QuoteDisplayAmount;\n price: QuoteDisplayAmount;\n shipping: QuoteDisplayAmount;\n fullSummary: boolean;\n grandTotal: boolean;\n };\n useConfigurableParentThumbnail: boolean;\n quoteMinimumAmount: number | null;\n quoteMinimumAmountMessage: string | null;\n}"
|
|
787
|
+
},
|
|
788
|
+
{
|
|
789
|
+
"name": "RemoveNegotiableQuoteItemsInput",
|
|
790
|
+
"kind": "interface",
|
|
791
|
+
"definition": "interface RemoveNegotiableQuoteItemsInput {\n quoteUid: string;\n quoteItemUids: string[];\n}"
|
|
792
|
+
},
|
|
793
|
+
{
|
|
794
|
+
"name": "AddressInput",
|
|
795
|
+
"kind": "interface",
|
|
796
|
+
"definition": "interface AddressInput {\n city: string;\n company?: string;\n countryCode: string;\n firstname: string;\n lastname: string;\n postcode: string;\n region?: string;\n regionId?: number;\n saveInAddressBook?: boolean;\n street: string[];\n telephone: string;\n additionalInput?: Record<string, any>;\n}"
|
|
797
|
+
}
|
|
798
|
+
]
|
|
799
|
+
},
|
|
800
|
+
"storefront-recommendations": {
|
|
801
|
+
"version": "4.0.0",
|
|
802
|
+
"models": [
|
|
803
|
+
{
|
|
804
|
+
"name": "Image",
|
|
805
|
+
"kind": "type",
|
|
806
|
+
"definition": "type Image = {\n label?: string | null;\n url: string;\n};"
|
|
807
|
+
},
|
|
808
|
+
{
|
|
809
|
+
"name": "Prices",
|
|
810
|
+
"kind": "type",
|
|
811
|
+
"definition": "type Prices = {\n maximum: Price;\n minimum: Price;\n};"
|
|
812
|
+
},
|
|
813
|
+
{
|
|
814
|
+
"name": "Price",
|
|
815
|
+
"kind": "type",
|
|
816
|
+
"definition": "type Price = {\n finalAdjustments: Array<Adjustment>;\n final: number;\n regular: number;\n regularAdjustments: Array<Adjustment>;\n};"
|
|
817
|
+
},
|
|
818
|
+
{
|
|
819
|
+
"name": "Adjustment",
|
|
820
|
+
"kind": "type",
|
|
821
|
+
"definition": "type Adjustment = {\n code: string;\n amount: number;\n};"
|
|
822
|
+
},
|
|
823
|
+
{
|
|
824
|
+
"name": "RecommendationUnitModel",
|
|
825
|
+
"kind": "interface",
|
|
826
|
+
"definition": "interface RecommendationUnitModel {\n displayOrder: number;\n pageType: PageType;\n title: string;\n items: Item[];\n totalProducts: number;\n typeId: string;\n unitId: string;\n unitName: string;\n userError: string;\n}"
|
|
827
|
+
},
|
|
828
|
+
{
|
|
829
|
+
"name": "PageType",
|
|
830
|
+
"kind": "type",
|
|
831
|
+
"definition": "type PageType = 'Product';"
|
|
832
|
+
},
|
|
833
|
+
{
|
|
834
|
+
"name": "Item",
|
|
835
|
+
"kind": "interface",
|
|
836
|
+
"definition": "interface Item {\n uid: string;\n sku: string;\n name: string;\n urlKey: string;\n images: ItemImage[];\n price: FinalPrice;\n priceRange?: {\n minimum?: FinalPrice;\n maximum?: FinalPrice;\n };\n visibility: string;\n queryType: string;\n itemType: string;\n inStock?: boolean;\n}"
|
|
837
|
+
},
|
|
838
|
+
{
|
|
839
|
+
"name": "FinalPrice",
|
|
840
|
+
"kind": "interface",
|
|
841
|
+
"definition": "interface FinalPrice {\n final?: {\n amount?: Price;\n };\n}"
|
|
842
|
+
}
|
|
843
|
+
]
|
|
844
|
+
},
|
|
845
|
+
"storefront-requisition-list": {
|
|
846
|
+
"version": "1.3.0",
|
|
847
|
+
"models": [
|
|
848
|
+
{
|
|
849
|
+
"name": "PageInfo",
|
|
850
|
+
"kind": "interface",
|
|
851
|
+
"definition": "interface PageInfo {\n page_size: number;\n current_page: number;\n total_pages: number;\n}"
|
|
852
|
+
},
|
|
853
|
+
{
|
|
854
|
+
"name": "RequisitionList",
|
|
855
|
+
"kind": "interface",
|
|
856
|
+
"definition": "interface RequisitionList {\n uid: string;\n name: string;\n description: string;\n updated_at: string;\n items_count: number;\n items: Item[];\n page_info?: PageInfo;\n}"
|
|
857
|
+
},
|
|
858
|
+
{
|
|
859
|
+
"name": "RequisitionListActionPayload",
|
|
860
|
+
"kind": "interface",
|
|
861
|
+
"definition": "interface RequisitionListActionPayload {\n action: 'add' | 'delete' | 'update' | 'move' | 'moveToList' | 'copyToList' | 'create';\n type: 'success' | 'error';\n context: 'product' | 'requisitionList';\n skus?: string[]; \n message?: string[]; \n }"
|
|
862
|
+
}
|
|
863
|
+
]
|
|
864
|
+
},
|
|
865
|
+
"storefront-product-discovery": {
|
|
866
|
+
"version": "3.1.0",
|
|
867
|
+
"models": [
|
|
868
|
+
{
|
|
869
|
+
"name": "SearchFilter",
|
|
870
|
+
"kind": "interface",
|
|
871
|
+
"definition": "interface SearchFilter {\n attribute: string;\n eq?: string;\n in?: Array<string>;\n range?: {\n from?: number;\n to?: number;\n };\n}"
|
|
872
|
+
},
|
|
873
|
+
{
|
|
874
|
+
"name": "Scope",
|
|
875
|
+
"kind": "type",
|
|
876
|
+
"definition": "type Scope = 'search' | 'popover' | string;"
|
|
877
|
+
},
|
|
878
|
+
{
|
|
879
|
+
"name": "SearchVariables",
|
|
880
|
+
"kind": "interface",
|
|
881
|
+
"definition": "interface SearchVariables {\n scope?: Scope;\n phrase?: string;\n filter?: SearchFilter[];\n sort?: SortOrder[];\n currentPage?: number;\n pageSize?: number;\n context?: SearchContext;\n}"
|
|
882
|
+
},
|
|
883
|
+
{
|
|
884
|
+
"name": "SearchContext",
|
|
885
|
+
"kind": "interface",
|
|
886
|
+
"definition": "interface SearchContext {\n customerGroup?: string;\n userViewHistory?: ViewHistoryRecord[];\n}"
|
|
887
|
+
},
|
|
888
|
+
{
|
|
889
|
+
"name": "ViewHistoryRecord",
|
|
890
|
+
"kind": "interface",
|
|
891
|
+
"definition": "interface ViewHistoryRecord {\n sku: string;\n dateTime: string;\n}"
|
|
892
|
+
},
|
|
893
|
+
{
|
|
894
|
+
"name": "SortOrder",
|
|
895
|
+
"kind": "interface",
|
|
896
|
+
"definition": "interface SortOrder {\n attribute: string;\n direction: 'ASC' | 'DESC';\n}"
|
|
897
|
+
},
|
|
898
|
+
{
|
|
899
|
+
"name": "RefineOption",
|
|
900
|
+
"kind": "interface",
|
|
901
|
+
"definition": "interface RefineOption {\n label: string;\n attribute: string;\n numeric: boolean;\n bidirectional: boolean;\n}"
|
|
902
|
+
},
|
|
903
|
+
{
|
|
904
|
+
"name": "ProductSearchResult",
|
|
905
|
+
"kind": "interface",
|
|
906
|
+
"definition": "interface ProductSearchResult {\n facets: SearchFacet[];\n items: Product[];\n pageInfo: {\n currentPage: number;\n totalPages: number;\n totalItems: number;\n pageSize: number;\n };\n suggestions?: string[];\n totalCount: number;\n metadata?: {\n filterableAttributes: RefineOption[];\n sortableAttributes: RefineOption[];\n };\n}"
|
|
907
|
+
},
|
|
908
|
+
{
|
|
909
|
+
"name": "SearchFacet",
|
|
910
|
+
"kind": "interface",
|
|
911
|
+
"definition": "interface SearchFacet {\n title: string;\n attribute: string;\n buckets: FacetBucket[];\n}"
|
|
912
|
+
},
|
|
913
|
+
{
|
|
914
|
+
"name": "FacetBucket",
|
|
915
|
+
"kind": "interface",
|
|
916
|
+
"definition": "interface FacetBucket {\n title: string;\n count: number;\n __typename: string;\n from?: number;\n to?: number;\n selected?: boolean;\n}"
|
|
917
|
+
},
|
|
918
|
+
{
|
|
919
|
+
"name": "Product",
|
|
920
|
+
"kind": "interface",
|
|
921
|
+
"definition": "interface Product {\n id: string;\n name: string;\n sku: string;\n shortDescription: string;\n url: string;\n urlKey: string;\n metaTitle: string;\n metaKeywords: string;\n metaDescription: string;\n lowStock: boolean;\n links: any[];\n attributes: ProductViewAttribute[];\n images: ProductImage[];\n description: string;\n externalId: string;\n inputOptions: any[];\n addToCartAllowed: boolean;\n price?: ProductViewPrice;\n priceRange?: {\n minimum: ProductViewPrice;\n maximum: ProductViewPrice;\n };\n inStock: boolean;\n typename: string;\n initialized?: boolean;\n}"
|
|
922
|
+
},
|
|
923
|
+
{
|
|
924
|
+
"name": "ProductViewPrice",
|
|
925
|
+
"kind": "interface",
|
|
926
|
+
"definition": "interface ProductViewPrice {\n final: ProductPrice;\n regular: ProductPrice;\n roles?: string[];\n}"
|
|
927
|
+
},
|
|
928
|
+
{
|
|
929
|
+
"name": "ProductPrice",
|
|
930
|
+
"kind": "interface",
|
|
931
|
+
"definition": "interface ProductPrice {\n amount: {\n value: number;\n currency: string;\n };\n}"
|
|
932
|
+
},
|
|
933
|
+
{
|
|
934
|
+
"name": "ProductViewAttribute",
|
|
935
|
+
"kind": "interface",
|
|
936
|
+
"definition": "interface ProductViewAttribute {\n label?: string;\n name: string;\n roles?: string[];\n value?: any;\n}"
|
|
937
|
+
},
|
|
938
|
+
{
|
|
939
|
+
"name": "ProductImage",
|
|
940
|
+
"kind": "interface",
|
|
941
|
+
"definition": "interface ProductImage {\n label: string;\n roles: string[];\n url: string;\n}"
|
|
942
|
+
}
|
|
943
|
+
]
|
|
944
|
+
},
|
|
945
|
+
"storefront-wishlist": {
|
|
946
|
+
"version": "3.2.0",
|
|
947
|
+
"models": [
|
|
948
|
+
{
|
|
949
|
+
"name": "Product",
|
|
950
|
+
"kind": "interface",
|
|
951
|
+
"definition": "interface Product {\n name: string;\n sku: string;\n isBundle: boolean;\n addToCartAllowed: boolean;\n inStock: boolean | null;\n shortDescription?: string;\n metaDescription?: string;\n metaKeyword?: string;\n metaTitle?: string;\n description?: string;\n images?: Image[];\n prices: Prices;\n attributes?: Attribute[];\n options?: Option[];\n optionUIDs?: string[];\n url?: string;\n urlKey?: string;\n externalId?: string;\n externalParentId?: string;\n variantSku?: string;\n productType?: ProductType | undefined;\n}"
|
|
952
|
+
},
|
|
953
|
+
{
|
|
954
|
+
"name": "Image",
|
|
955
|
+
"kind": "interface",
|
|
956
|
+
"definition": "interface Image {\n url: string;\n label: string;\n width?: number;\n height?: number;\n}"
|
|
957
|
+
},
|
|
958
|
+
{
|
|
959
|
+
"name": "Prices",
|
|
960
|
+
"kind": "interface",
|
|
961
|
+
"definition": "interface Prices {\n regular: Price;\n final: Price;\n visible: boolean;\n}"
|
|
962
|
+
},
|
|
963
|
+
{
|
|
964
|
+
"name": "Option",
|
|
965
|
+
"kind": "interface",
|
|
966
|
+
"definition": "interface Option {\n id: string;\n type: 'text' | 'image' | 'color' | 'dropdown';\n typename:\n | 'ProductViewOptionValueProduct'\n | 'ProductViewOptionValueSwatch'\n | 'ProductViewOptionValueConfiguration';\n label: string;\n required: boolean;\n multiple: boolean;\n items: OptionValue[];\n}"
|
|
967
|
+
},
|
|
968
|
+
{
|
|
969
|
+
"name": "SelectedCustomizableOption",
|
|
970
|
+
"kind": "interface",
|
|
971
|
+
"definition": "interface SelectedCustomizableOption {\n customizable_option_uid: string;\n label: string;\n type: string;\n required: boolean;\n sort_order: number;\n values: SelectedCustomizableOptionValue[];\n}"
|
|
972
|
+
},
|
|
973
|
+
{
|
|
974
|
+
"name": "SelectedCustomizableOptionValue",
|
|
975
|
+
"kind": "interface",
|
|
976
|
+
"definition": "interface SelectedCustomizableOptionValue {\n customizable_option_value_uid: string;\n label: string;\n value: string;\n}"
|
|
977
|
+
},
|
|
978
|
+
{
|
|
979
|
+
"name": "StoreConfigModel",
|
|
980
|
+
"kind": "interface",
|
|
981
|
+
"definition": "interface StoreConfigModel {\n wishlistIsEnabled: boolean;\n wishlistMaxNumber: number;\n wishlistMultipleListIsEnabled: boolean;\n}"
|
|
982
|
+
},
|
|
983
|
+
{
|
|
984
|
+
"name": "Wishlist",
|
|
985
|
+
"kind": "interface",
|
|
986
|
+
"definition": "interface Wishlist {\n id: string;\n updated_at: string;\n sharing_code: string;\n items_count: number;\n items: Item[];\n}"
|
|
987
|
+
},
|
|
988
|
+
{
|
|
989
|
+
"name": "Item",
|
|
990
|
+
"kind": "interface",
|
|
991
|
+
"definition": "interface Item {\n id: string;\n quantity: number;\n description: string;\n added_at: string;\n selectedOptions: { uid: string }[];\n enteredOptions?: { uid: string; value: string }[];\n product: { sku: string };\n customizableOptions: SelectedCustomizableOption[];\n}"
|
|
992
|
+
},
|
|
993
|
+
{
|
|
994
|
+
"name": "WishlistActionPayload",
|
|
995
|
+
"kind": "interface",
|
|
996
|
+
"definition": "interface WishlistActionPayload {\n action: WishlistAlertProps.action;\n item: WishlistAlertProps.item;\n }"
|
|
997
|
+
}
|
|
998
|
+
]
|
|
999
|
+
}
|
|
1000
|
+
}
|
|
1001
|
+
}
|