@ikas/storefront-api 6.1.0-beta.22 → 6.1.0-beta.220
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/build/__api/models/AddItemToCartInput.d.ts +2 -0
- package/build/__api/models/AddLoyaltyToCartInput.d.ts +12 -0
- package/build/__api/models/CartLoyaltyLine.d.ts +14 -0
- package/build/__api/models/CartV2.d.ts +3 -0
- package/build/__api/models/CheckoutSettings.d.ts +1 -0
- package/build/__api/models/CustomerReview.d.ts +6 -0
- package/build/__api/models/CustomerReviewProductModel.d.ts +15 -0
- package/build/__api/models/CustomerReviewReplyInfo.d.ts +10 -0
- package/build/__api/models/GetCustomerReviewImageUploadUrlResponse.d.ts +11 -0
- package/build/__api/models/HepsipayFrameInitResponse.d.ts +11 -0
- package/build/__api/models/ListOrderTransactionWithPricesResponse.d.ts +1 -0
- package/build/__api/models/LoyaltyCustomerInfo.d.ts +16 -0
- package/build/__api/models/LoyaltyProgram.d.ts +26 -0
- package/build/__api/models/LoyaltyProgramDiscountSettings.d.ts +11 -0
- package/build/__api/models/LoyaltyProgramEarningMethod.d.ts +31 -0
- package/build/__api/models/LoyaltyProgramEarningMethodOrderSettings.d.ts +12 -0
- package/build/__api/models/LoyaltyProgramEarningMethodProductSettings.d.ts +12 -0
- package/build/__api/models/LoyaltyProgramFilter.d.ts +11 -0
- package/build/__api/models/LoyaltyProgramMethodTranslation.d.ts +10 -0
- package/build/__api/models/LoyaltyProgramPeriod.d.ts +11 -0
- package/build/__api/models/LoyaltyProgramPointHistory.d.ts +19 -0
- package/build/__api/models/LoyaltyProgramPointHistoryTypeEnumFilterInput.d.ts +13 -0
- package/build/__api/models/LoyaltyProgramPointLimit.d.ts +10 -0
- package/build/__api/models/LoyaltyProgramSaleChannel.d.ts +11 -0
- package/build/__api/models/LoyaltyProgramSpendingMethod.d.ts +24 -0
- package/build/__api/models/LoyaltyProgramTier.d.ts +19 -0
- package/build/__api/models/LoyaltyProgramTierTranslation.d.ts +10 -0
- package/build/__api/models/OrderAdjustment.d.ts +3 -1
- package/build/__api/models/OrderLineItem.d.ts +5 -0
- package/build/__api/models/OrderLineItemCustomerSubscriptionPlan.d.ts +9 -0
- package/build/__api/models/OrderLineItemSubscriptionPlan.d.ts +12 -0
- package/build/__api/models/OrderLineItemSubscriptionPlanPeriod.d.ts +19 -0
- package/build/__api/models/OrderLoyaltyLine.d.ts +13 -0
- package/build/__api/models/ProductSearchResponse.d.ts +2 -0
- package/build/__api/models/SearchInput.d.ts +2 -0
- package/build/__api/models/SearchSuggestion.d.ts +12 -0
- package/build/__api/models/StorefrontWidgetSettings.d.ts +14 -0
- package/build/__api/models/StorefrontWidgetSettingsRouting.d.ts +10 -0
- package/build/__api/models/SubscriptionPlanDiscount.d.ts +11 -0
- package/build/__api/models/UpdatePaypalOrderAddressInput.d.ts +12 -0
- package/build/__api/models/UpdatePaypalOrderCustomerInput.d.ts +12 -0
- package/build/__api/models/UpdatePaypalOrderInput.d.ts +16 -0
- package/build/__api/mutations/addItemToCart.d.ts +13 -0
- package/build/__api/mutations/addItemToCart.js +1 -1
- package/build/__api/mutations/createPaypalOrder.d.ts +2 -0
- package/build/__api/mutations/createPaypalOrder.js +1 -1
- package/build/__api/mutations/customerLogin.d.ts +6 -2
- package/build/__api/mutations/customerLogin.js +1 -1
- package/build/__api/mutations/getCustomerReviewImageUploadUrl.d.ts +13 -0
- package/build/__api/mutations/getPaypalClientId.d.ts +1 -1
- package/build/__api/mutations/getPaypalClientId.js +1 -1
- package/build/__api/mutations/hepsipayFrameInit.d.ts +13 -0
- package/build/__api/mutations/hepsipayFrameInit.js +1 -0
- package/build/__api/mutations/registerCustomer.d.ts +8 -4
- package/build/__api/mutations/registerCustomer.js +1 -1
- package/build/__api/mutations/removeLoyaltyPointsFromCart.d.ts +533 -0
- package/build/__api/mutations/removeLoyaltyPointsFromCart.js +1 -0
- package/build/__api/mutations/resendCustomerPhoneVerificationCode.d.ts +2 -5
- package/build/__api/mutations/resendCustomerPhoneVerificationCode.js +1 -1
- package/build/__api/mutations/updatePaypalOrder.d.ts +8 -0
- package/build/__api/mutations/updatePaypalOrder.js +1 -0
- package/build/__api/mutations/useLoyaltyPoints.d.ts +532 -0
- package/build/__api/mutations/useLoyaltyPoints.js +1 -0
- package/build/__api/mutations/validateCustomerPhoneVerificationCode.d.ts +1 -0
- package/build/__api/mutations/validateCustomerPhoneVerificationCode.js +1 -1
- package/build/__api/mutations/validateOTPCode.d.ts +97 -0
- package/build/__api/mutations/validateOTPCode.js +1 -0
- package/build/__api/queries/getAvailableStockLocations.d.ts +1 -0
- package/build/__api/queries/getAvailableStockLocations.js +1 -1
- package/build/__api/queries/getCart.d.ts +13 -0
- package/build/__api/queries/getCartById.d.ts +25 -1
- package/build/__api/queries/getCartById.js +1 -1
- package/build/__api/queries/getCheckoutByCartId.d.ts +13 -0
- package/build/__api/queries/getCheckoutById.d.ts +13 -0
- package/build/__api/queries/getCustomerOrders.d.ts +19 -0
- package/build/__api/queries/getCustomerOrders.js +1 -1
- package/build/__api/queries/getLoyaltyCustomerInfo.d.ts +32 -0
- package/build/__api/queries/getLoyaltyCustomerInfo.js +1 -0
- package/build/__api/queries/getLoyaltyProgram.d.ts +83 -0
- package/build/__api/queries/getLoyaltyProgram.js +1 -0
- package/build/__api/queries/getOrder.d.ts +19 -0
- package/build/__api/queries/getStoreCreditBalance.d.ts +25 -0
- package/build/__api/queries/getStoreCreditBalance.js +1 -0
- package/build/__api/queries/getStorefrontWidgetSettings.d.ts +14 -0
- package/build/__api/queries/getStorefrontWidgetSettings.js +1 -0
- package/build/__api/queries/listCheckoutSettings.d.ts +1 -0
- package/build/__api/queries/listCheckoutSettings.js +1 -1
- package/build/__api/queries/listCustomerReviewSummary.d.ts +1 -0
- package/build/__api/queries/listCustomerReviews.d.ts +12 -0
- package/build/__api/queries/listCustomerReviews.js +1 -1
- package/build/__api/queries/listEarningMethods.d.ts +35 -0
- package/build/__api/queries/listEarningMethods.js +1 -0
- package/build/__api/queries/listLoyaltyProgramPointHistory.d.ts +22 -0
- package/build/__api/queries/listLoyaltyProgramPointHistory.js +1 -0
- package/build/__api/queries/listLoyaltyProgramTiers.d.ts +20 -0
- package/build/__api/queries/listLoyaltyProgramTiers.js +1 -0
- package/build/__api/queries/listOrderTransactionsWithPrices.d.ts +1 -0
- package/build/__api/queries/listOrderTransactionsWithPrices.js +1 -1
- package/build/__api/queries/listSpendingMethodsByCartId.d.ts +28 -0
- package/build/__api/queries/listSpendingMethodsByCartId.js +1 -0
- package/build/__api/queries/searchProducts.d.ts +21 -0
- package/build/__api/queries/searchProducts.js +1 -1
- package/build/__api/types/index.d.ts +409 -12
- package/build/__api/types/index.js +1 -1
- package/build/api/cart/index.d.ts +5 -1
- package/build/api/cart/index.js +1 -1
- package/build/api/checkout/index.d.ts +7 -2
- package/build/api/checkout/index.js +1 -1
- package/build/api/customer/index.d.ts +37 -6
- package/build/api/customer/index.js +1 -1
- package/build/api/loyalty/index.d.ts +14 -0
- package/build/api/loyalty/index.js +1 -0
- package/build/api/product/index.d.ts +2 -1
- package/build/api/product/index.js +1 -1
- package/build/api/storefront/index.d.ts +7 -1
- package/build/index.d.ts +4 -2
- package/build/index.js +1 -1
- package/build/index2.js +1 -1
- package/package.json +7 -7
- package/build/__api/queries/checkOrderStocks.d.ts +0 -13
|
@@ -13,7 +13,9 @@ export declare enum CampaignApplicablePriceEnum {
|
|
|
13
13
|
export declare enum CampaignCreatedForEnum {
|
|
14
14
|
ABANDONED_CHECKOUT = "ABANDONED_CHECKOUT",
|
|
15
15
|
CART = "CART",
|
|
16
|
-
CUSTOMER_REVIEW = "CUSTOMER_REVIEW"
|
|
16
|
+
CUSTOMER_REVIEW = "CUSTOMER_REVIEW",
|
|
17
|
+
LOYALTY_SPEND = "LOYALTY_SPEND",
|
|
18
|
+
MARKETING_CAMPAIGN = "MARKETING_CAMPAIGN"
|
|
17
19
|
}
|
|
18
20
|
export declare enum CampaignFilterTypeEnum {
|
|
19
21
|
CATEGORY = "CATEGORY",
|
|
@@ -167,6 +169,11 @@ export declare enum CustomerEmailSubscriptionStatusesEnum {
|
|
|
167
169
|
PENDING_CONFIRMATION = "PENDING_CONFIRMATION",
|
|
168
170
|
SUBSCRIBED = "SUBSCRIBED"
|
|
169
171
|
}
|
|
172
|
+
export declare enum CustomerGenderTypeEnum {
|
|
173
|
+
FEMALE = "FEMALE",
|
|
174
|
+
MALE = "MALE",
|
|
175
|
+
OTHER = "OTHER"
|
|
176
|
+
}
|
|
170
177
|
export declare enum CustomerPriceListRuleFilterTypeEnum {
|
|
171
178
|
CATEGORY = "CATEGORY",
|
|
172
179
|
PRODUCT = "PRODUCT",
|
|
@@ -198,6 +205,10 @@ export declare enum GetSuggestedProductsMethodEnum {
|
|
|
198
205
|
SAMPLING = "SAMPLING",
|
|
199
206
|
VIEWED_TOGETHER = "VIEWED_TOGETHER"
|
|
200
207
|
}
|
|
208
|
+
export declare enum GiftCardTypeEnum {
|
|
209
|
+
GIFT_CARD = "GIFT_CARD",
|
|
210
|
+
STORE_CREDIT = "STORE_CREDIT"
|
|
211
|
+
}
|
|
201
212
|
export declare enum HTMLMetaDataTargetTypeEnum {
|
|
202
213
|
BRAND = "BRAND",
|
|
203
214
|
CATEGORY = "CATEGORY",
|
|
@@ -406,6 +417,13 @@ export declare enum ProductSearchShowStockOptionEnum {
|
|
|
406
417
|
SHOW_ALL = "SHOW_ALL",
|
|
407
418
|
SHOW_OUT_OF_STOCK_AT_END = "SHOW_OUT_OF_STOCK_AT_END"
|
|
408
419
|
}
|
|
420
|
+
export declare enum ProductTypeEnum {
|
|
421
|
+
BUNDLE = "BUNDLE",
|
|
422
|
+
DIGITAL = "DIGITAL",
|
|
423
|
+
MEMBERSHIP = "MEMBERSHIP",
|
|
424
|
+
PHYSICAL = "PHYSICAL",
|
|
425
|
+
SUBSCRIPTION = "SUBSCRIPTION"
|
|
426
|
+
}
|
|
409
427
|
export declare enum ProductUnitTypeEnum {
|
|
410
428
|
CENTILITER = "CENTILITER",
|
|
411
429
|
CENTIMETER = "CENTIMETER",
|
|
@@ -515,6 +533,20 @@ export declare enum StorefrontTypeEnum {
|
|
|
515
533
|
B2B_STOREFRONT = "B2B_STOREFRONT",
|
|
516
534
|
STOREFRONT = "STOREFRONT"
|
|
517
535
|
}
|
|
536
|
+
export declare enum SubscriptionPlanDurationUnitTypeEnum {
|
|
537
|
+
DAY = "DAY",
|
|
538
|
+
MONTH = "MONTH",
|
|
539
|
+
WEEK = "WEEK",
|
|
540
|
+
YEAR = "YEAR"
|
|
541
|
+
}
|
|
542
|
+
export declare enum SubscriptionPlanPaymentTypeEnum {
|
|
543
|
+
POST_PAID = "POST_PAID",
|
|
544
|
+
PRE_PAID = "PRE_PAID"
|
|
545
|
+
}
|
|
546
|
+
export declare enum SubscriptionPlanStatusEnum {
|
|
547
|
+
ACTIVE = "ACTIVE",
|
|
548
|
+
PASSIVE = "PASSIVE"
|
|
549
|
+
}
|
|
518
550
|
export declare enum TemplateEnum {
|
|
519
551
|
ABANDONED_CHECKOUT = "ABANDONED_CHECKOUT",
|
|
520
552
|
CONTACT_FORM_MERCHANT = "CONTACT_FORM_MERCHANT",
|
|
@@ -764,6 +796,11 @@ export interface BuyXThenGetY {
|
|
|
764
796
|
getY: GetY;
|
|
765
797
|
maxUsagePerOrder: number | null;
|
|
766
798
|
}
|
|
799
|
+
export interface HepsipayFrameInitResponse {
|
|
800
|
+
frameToken: string | null;
|
|
801
|
+
frameUrl: string | null;
|
|
802
|
+
transactionId: string;
|
|
803
|
+
}
|
|
767
804
|
export interface Campaign {
|
|
768
805
|
applicableCustomerGroupIds: string[] | null;
|
|
769
806
|
applicableCustomerIds: string[] | null;
|
|
@@ -928,6 +965,7 @@ export interface CartV2 {
|
|
|
928
965
|
customerId: string | null;
|
|
929
966
|
deleted: boolean | null;
|
|
930
967
|
dueDate: any | null;
|
|
968
|
+
edited: boolean | null;
|
|
931
969
|
giftCardLines: OrderGiftCardLine[] | null;
|
|
932
970
|
giftPackageLines: OrderGiftPackageLine[] | null;
|
|
933
971
|
giftPackageNote: string | null;
|
|
@@ -935,6 +973,7 @@ export interface CartV2 {
|
|
|
935
973
|
id: string;
|
|
936
974
|
isGiftPackage: boolean | null;
|
|
937
975
|
itemCount: number | null;
|
|
976
|
+
loyaltyLines: OrderLoyaltyLine[] | null;
|
|
938
977
|
merchantId: string;
|
|
939
978
|
note: string | null;
|
|
940
979
|
orderAdjustments: OrderAdjustment[] | null;
|
|
@@ -1088,6 +1127,7 @@ export interface CheckoutSettings {
|
|
|
1088
1127
|
options: CheckoutOption[] | null;
|
|
1089
1128
|
phoneRequirement: CheckoutRequirementEnum;
|
|
1090
1129
|
postalCodeRequirement: CheckoutRequirementEnum | null;
|
|
1130
|
+
showBillingAddressOnShippingStep: boolean | null;
|
|
1091
1131
|
showCheckoutNote: boolean | null;
|
|
1092
1132
|
showCompanyInfoInShippingAddress: boolean | null;
|
|
1093
1133
|
showTermsAndConditionsCheckbox: boolean;
|
|
@@ -1335,6 +1375,13 @@ export interface CustomerFavoriteProduct {
|
|
|
1335
1375
|
productId: string;
|
|
1336
1376
|
updatedAt: any | null;
|
|
1337
1377
|
}
|
|
1378
|
+
export interface CustomerLoginResponse {
|
|
1379
|
+
customer: Customer | null;
|
|
1380
|
+
flowId: string | null;
|
|
1381
|
+
otpSend: boolean | null;
|
|
1382
|
+
token: string;
|
|
1383
|
+
tokenExpiry: number;
|
|
1384
|
+
}
|
|
1338
1385
|
export interface CustomerPriceListRule {
|
|
1339
1386
|
filters: CustomerPriceListRuleFilter[] | null;
|
|
1340
1387
|
shouldMatchAllFilters: boolean | null;
|
|
@@ -1345,11 +1392,6 @@ export interface CustomerPriceListRuleFilter {
|
|
|
1345
1392
|
type: CustomerPriceListRuleFilterTypeEnum;
|
|
1346
1393
|
valueList: string[];
|
|
1347
1394
|
}
|
|
1348
|
-
export interface CustomerLoginResponse {
|
|
1349
|
-
customer: Customer | null;
|
|
1350
|
-
token: string;
|
|
1351
|
-
tokenExpiry: number;
|
|
1352
|
-
}
|
|
1353
1395
|
export interface CustomerRefreshTokenResponse {
|
|
1354
1396
|
token: string;
|
|
1355
1397
|
tokenExpiry: number;
|
|
@@ -1358,16 +1400,20 @@ export interface CustomerReview {
|
|
|
1358
1400
|
comment: string | null;
|
|
1359
1401
|
createdAt: any | null;
|
|
1360
1402
|
customerId: string | null;
|
|
1361
|
-
deleted: boolean
|
|
1403
|
+
deleted: boolean;
|
|
1362
1404
|
email: string | null;
|
|
1363
1405
|
firstName: string | null;
|
|
1364
1406
|
id: string;
|
|
1365
1407
|
imageIds: string[] | null;
|
|
1408
|
+
isPrivateReply: boolean | null;
|
|
1366
1409
|
lastName: string | null;
|
|
1410
|
+
locale: string | null;
|
|
1367
1411
|
orderId: string | null;
|
|
1368
1412
|
orderNumber: string | null;
|
|
1413
|
+
product: CustomerReviewProductModel | null;
|
|
1369
1414
|
productId: string;
|
|
1370
1415
|
reply: string | null;
|
|
1416
|
+
replyInfo: CustomerReviewReplyInfo | null;
|
|
1371
1417
|
salesChannelId: string | null;
|
|
1372
1418
|
star: number;
|
|
1373
1419
|
status: CustomerReviewStatusEnum | null;
|
|
@@ -1375,6 +1421,18 @@ export interface CustomerReview {
|
|
|
1375
1421
|
title: string | null;
|
|
1376
1422
|
updatedAt: any | null;
|
|
1377
1423
|
}
|
|
1424
|
+
export interface CustomerReviewProductModel {
|
|
1425
|
+
brandId: string | null;
|
|
1426
|
+
categoryIds: string[] | null;
|
|
1427
|
+
id: string | null;
|
|
1428
|
+
tagIds: string | null;
|
|
1429
|
+
type: ProductTypeEnum | null;
|
|
1430
|
+
vendorId: string | null;
|
|
1431
|
+
}
|
|
1432
|
+
export interface CustomerReviewReplyInfo {
|
|
1433
|
+
createdAt: any | null;
|
|
1434
|
+
staffId: string | null;
|
|
1435
|
+
}
|
|
1378
1436
|
export interface CustomerReviewSFPaginationResponse {
|
|
1379
1437
|
count: number;
|
|
1380
1438
|
data: CustomerReview[];
|
|
@@ -1385,7 +1443,7 @@ export interface CustomerReviewSFPaginationResponse {
|
|
|
1385
1443
|
export interface CustomerReviewSummary {
|
|
1386
1444
|
averageStar: number;
|
|
1387
1445
|
createdAt: any | null;
|
|
1388
|
-
deleted: boolean
|
|
1446
|
+
deleted: boolean;
|
|
1389
1447
|
id: string;
|
|
1390
1448
|
productId: string;
|
|
1391
1449
|
stars: CustomerReviewSummaryStar[];
|
|
@@ -1468,6 +1526,11 @@ export interface GetAvailableStockLocationAddressCountry {
|
|
|
1468
1526
|
export interface GetAvailableStockLocationsResponse {
|
|
1469
1527
|
stockLocations: GetAvailableStockLocation[];
|
|
1470
1528
|
}
|
|
1529
|
+
export interface GetCustomerReviewImageUploadUrlResponse {
|
|
1530
|
+
fields: any;
|
|
1531
|
+
imageId: string;
|
|
1532
|
+
uploadUrl: string;
|
|
1533
|
+
}
|
|
1471
1534
|
export interface GetPaypalClientIdResponse {
|
|
1472
1535
|
clientId: string;
|
|
1473
1536
|
merchantClientId: string | null;
|
|
@@ -1496,6 +1559,28 @@ export interface GetY {
|
|
|
1496
1559
|
discountRatio: number;
|
|
1497
1560
|
filter: CampaignFilter;
|
|
1498
1561
|
}
|
|
1562
|
+
export interface GiftCard {
|
|
1563
|
+
active: boolean;
|
|
1564
|
+
amount: number;
|
|
1565
|
+
code: string;
|
|
1566
|
+
createdAt: any | null;
|
|
1567
|
+
customerId: string | null;
|
|
1568
|
+
deleted: boolean;
|
|
1569
|
+
endDate: any | null;
|
|
1570
|
+
id: string;
|
|
1571
|
+
minimumRequiredCartAmount: number | null;
|
|
1572
|
+
salesChannels: GiftCardSalesChannel[] | null;
|
|
1573
|
+
startDate: any | null;
|
|
1574
|
+
type: GiftCardTypeEnum;
|
|
1575
|
+
updatedAt: any | null;
|
|
1576
|
+
usedAllAmount: boolean | null;
|
|
1577
|
+
usedAmount: number;
|
|
1578
|
+
}
|
|
1579
|
+
export interface GiftCardSalesChannel {
|
|
1580
|
+
salesChannelId: string;
|
|
1581
|
+
storefrontId: string | null;
|
|
1582
|
+
storefrontRoutingId: string | null;
|
|
1583
|
+
}
|
|
1499
1584
|
export interface HTMLMetaData {
|
|
1500
1585
|
canonicals: string[] | null;
|
|
1501
1586
|
createdAt: any | null;
|
|
@@ -1556,6 +1641,7 @@ export interface ListOrderTransactionWithPricesRefundableTransaction {
|
|
|
1556
1641
|
export interface ListOrderTransactionWithPricesResponse {
|
|
1557
1642
|
chargedAmount: number;
|
|
1558
1643
|
orderFinalPrice: number;
|
|
1644
|
+
pendingAmount: number;
|
|
1559
1645
|
refundableTransactions: ListOrderTransactionWithPricesRefundableTransaction[];
|
|
1560
1646
|
refundedAmount: number;
|
|
1561
1647
|
remainingBalance: number;
|
|
@@ -1691,9 +1777,11 @@ export interface OrderAdjustment {
|
|
|
1691
1777
|
campaignId: string | null;
|
|
1692
1778
|
campaignType: CampaignTypeEnum | null;
|
|
1693
1779
|
couponId: string | null;
|
|
1780
|
+
createdFor: CampaignCreatedForEnum | null;
|
|
1694
1781
|
name: string;
|
|
1695
1782
|
order: number;
|
|
1696
1783
|
type: OrderAdjustmentEnum;
|
|
1784
|
+
usedLoyaltyPoints: number | null;
|
|
1697
1785
|
}
|
|
1698
1786
|
export interface OrderAdjustmentAppliedOrderLine {
|
|
1699
1787
|
amount: number;
|
|
@@ -1726,6 +1814,7 @@ export interface OrderGiftCardLine {
|
|
|
1726
1814
|
code: string;
|
|
1727
1815
|
giftCardId: string;
|
|
1728
1816
|
id: string;
|
|
1817
|
+
type: GiftCardTypeEnum | null;
|
|
1729
1818
|
}
|
|
1730
1819
|
export interface OrderGiftPackageLine {
|
|
1731
1820
|
price: number;
|
|
@@ -1783,11 +1872,31 @@ export interface OrderLineItem {
|
|
|
1783
1872
|
status: OrderLineItemStatusEnum;
|
|
1784
1873
|
statusUpdatedAt: any | null;
|
|
1785
1874
|
stockLocationId: string | null;
|
|
1875
|
+
subscriptionPlan: OrderLineItemSubscriptionPlan | null;
|
|
1786
1876
|
taxValue: number | null;
|
|
1787
1877
|
unitPrice: number | null;
|
|
1788
1878
|
updatedAt: any | null;
|
|
1789
1879
|
variant: OrderLineVariant;
|
|
1790
1880
|
}
|
|
1881
|
+
export interface OrderLineItemCustomerSubscriptionPlan {
|
|
1882
|
+
id: string;
|
|
1883
|
+
}
|
|
1884
|
+
export interface OrderLineItemSubscriptionPlan {
|
|
1885
|
+
id: string;
|
|
1886
|
+
name: string;
|
|
1887
|
+
period: OrderLineItemSubscriptionPlanPeriod;
|
|
1888
|
+
}
|
|
1889
|
+
export interface OrderLineItemSubscriptionPlanPeriod {
|
|
1890
|
+
cutOffDay: number | null;
|
|
1891
|
+
discount: SubscriptionPlanDiscount | null;
|
|
1892
|
+
durationUnit: SubscriptionPlanDurationUnitTypeEnum;
|
|
1893
|
+
durationValue: number;
|
|
1894
|
+
id: string;
|
|
1895
|
+
maxOrders: number | null;
|
|
1896
|
+
paymentType: SubscriptionPlanPaymentTypeEnum;
|
|
1897
|
+
scheduledOrderDay: number | null;
|
|
1898
|
+
title: string;
|
|
1899
|
+
}
|
|
1791
1900
|
export interface OrderLineOption {
|
|
1792
1901
|
name: string;
|
|
1793
1902
|
productOptionId: string;
|
|
@@ -2233,6 +2342,7 @@ export interface ProductSearchResponse {
|
|
|
2233
2342
|
limit: number;
|
|
2234
2343
|
page: number;
|
|
2235
2344
|
results: SearchProduct[];
|
|
2345
|
+
suggestions: SearchSuggestion[] | null;
|
|
2236
2346
|
totalCount: number;
|
|
2237
2347
|
}
|
|
2238
2348
|
export interface ProductTagTranslation {
|
|
@@ -2544,6 +2654,29 @@ export interface SearchProductStockLocation {
|
|
|
2544
2654
|
stockCount: number;
|
|
2545
2655
|
stockLocationId: string;
|
|
2546
2656
|
}
|
|
2657
|
+
export interface SearchProductSubscriptionPlan {
|
|
2658
|
+
name: string;
|
|
2659
|
+
periods: SearchProductSubscriptionPlanPeriod[];
|
|
2660
|
+
status: SubscriptionPlanStatusEnum;
|
|
2661
|
+
subscriptionPlanId: string;
|
|
2662
|
+
translations: SubscriptionPlanTranslation[] | null;
|
|
2663
|
+
}
|
|
2664
|
+
export interface SearchProductSubscriptionPlanDiscount {
|
|
2665
|
+
amount: number;
|
|
2666
|
+
type: OrderAmountTypeEnum;
|
|
2667
|
+
}
|
|
2668
|
+
export interface SearchProductSubscriptionPlanPeriod {
|
|
2669
|
+
cutOffDay: number | null;
|
|
2670
|
+
discount: SearchProductSubscriptionPlanDiscount | null;
|
|
2671
|
+
durationUnit: SubscriptionPlanDurationUnitTypeEnum;
|
|
2672
|
+
durationValue: number;
|
|
2673
|
+
id: string;
|
|
2674
|
+
maxOrders: number | null;
|
|
2675
|
+
paymentType: SubscriptionPlanPaymentTypeEnum;
|
|
2676
|
+
scheduledOrderDay: number | null;
|
|
2677
|
+
status: SubscriptionPlanStatusEnum;
|
|
2678
|
+
title: string;
|
|
2679
|
+
}
|
|
2547
2680
|
export interface SearchProductTag {
|
|
2548
2681
|
id: string;
|
|
2549
2682
|
name: string;
|
|
@@ -2554,6 +2687,12 @@ export interface SearchProductVariantType {
|
|
|
2554
2687
|
variantType: SearchVariantType;
|
|
2555
2688
|
variantValueIds: string[];
|
|
2556
2689
|
}
|
|
2690
|
+
export interface SearchSuggestion {
|
|
2691
|
+
brandId: string | null;
|
|
2692
|
+
categoryId: string | null;
|
|
2693
|
+
id: string;
|
|
2694
|
+
term: string;
|
|
2695
|
+
}
|
|
2557
2696
|
export interface SearchVariant {
|
|
2558
2697
|
attributes: SearchProductAttributeValue[] | null;
|
|
2559
2698
|
barcodeList: string[] | null;
|
|
@@ -2567,6 +2706,7 @@ export interface SearchVariant {
|
|
|
2567
2706
|
sellIfOutOfStock: boolean | null;
|
|
2568
2707
|
sku: string | null;
|
|
2569
2708
|
stocks: SearchProductStockLocation[] | null;
|
|
2709
|
+
subscriptionPlan: SearchProductSubscriptionPlan | null;
|
|
2570
2710
|
unit: VariantUnitModel | null;
|
|
2571
2711
|
variantValues: SearchVariationValueRelation[] | null;
|
|
2572
2712
|
weight: number | null;
|
|
@@ -2650,6 +2790,10 @@ export interface StockLocationAddressState {
|
|
|
2650
2790
|
id: string | null;
|
|
2651
2791
|
name: string | null;
|
|
2652
2792
|
}
|
|
2793
|
+
export interface StoreCreditBalanceResponse {
|
|
2794
|
+
amount: number;
|
|
2795
|
+
storeCredits: GiftCard[];
|
|
2796
|
+
}
|
|
2653
2797
|
export interface Storefront {
|
|
2654
2798
|
analytics4Id: string | null;
|
|
2655
2799
|
createdAt: any | null;
|
|
@@ -2890,6 +3034,15 @@ export interface StorefrontTransaction {
|
|
|
2890
3034
|
type: TransactionTypeEnum;
|
|
2891
3035
|
updatedAt: any | null;
|
|
2892
3036
|
}
|
|
3037
|
+
export interface SubscriptionPlanDiscount {
|
|
3038
|
+
amount: number;
|
|
3039
|
+
type: OrderAmountTypeEnum;
|
|
3040
|
+
}
|
|
3041
|
+
export interface SubscriptionPlanTranslation {
|
|
3042
|
+
description: string | null;
|
|
3043
|
+
locale: string;
|
|
3044
|
+
title: string;
|
|
3045
|
+
}
|
|
2893
3046
|
export interface Town {
|
|
2894
3047
|
createdAt: any | null;
|
|
2895
3048
|
deleted: boolean | null;
|
|
@@ -3066,6 +3219,8 @@ export interface AddItemToCartInput {
|
|
|
3066
3219
|
priceListId?: string | null;
|
|
3067
3220
|
salesChannelId: string;
|
|
3068
3221
|
storefrontThemeId: string;
|
|
3222
|
+
subscriptionPlanId?: string | null;
|
|
3223
|
+
subscriptionPlanPeriodId?: string | null;
|
|
3069
3224
|
}
|
|
3070
3225
|
export interface AppliedProductInput {
|
|
3071
3226
|
productId?: string | null;
|
|
@@ -3216,6 +3371,16 @@ export interface CustomerAttributeValueInput {
|
|
|
3216
3371
|
customerAttributeOptionId?: string | null;
|
|
3217
3372
|
value?: string | null;
|
|
3218
3373
|
}
|
|
3374
|
+
export interface CustomerRegisterSubscriptionInput {
|
|
3375
|
+
email: boolean;
|
|
3376
|
+
phone: boolean;
|
|
3377
|
+
sms: boolean;
|
|
3378
|
+
}
|
|
3379
|
+
export interface CustomerAttributeValueInput {
|
|
3380
|
+
customerAttributeId?: string | null;
|
|
3381
|
+
customerAttributeOptionId?: string | null;
|
|
3382
|
+
value?: string | null;
|
|
3383
|
+
}
|
|
3219
3384
|
export interface DateFilterInput {
|
|
3220
3385
|
eq?: any | null;
|
|
3221
3386
|
gt?: any | null;
|
|
@@ -3460,10 +3625,12 @@ export interface SearchDynamicCurrencySettings {
|
|
|
3460
3625
|
}
|
|
3461
3626
|
export interface SearchInput {
|
|
3462
3627
|
barcodeList?: string[] | null;
|
|
3628
|
+
baseCategoryIdList?: string[] | null;
|
|
3463
3629
|
brandId?: string | null;
|
|
3464
3630
|
brandIdList?: string[] | null;
|
|
3465
3631
|
categoryIdList?: string[] | null;
|
|
3466
3632
|
dynamicCurrencySettings?: SearchDynamicCurrencySettings | null;
|
|
3633
|
+
enableSuggestions?: boolean | null;
|
|
3467
3634
|
facetList?: SearchInputFacetListInput[] | null;
|
|
3468
3635
|
filterList?: SearchInputFilterListInput[] | null;
|
|
3469
3636
|
locale?: string | null;
|
|
@@ -3521,6 +3688,26 @@ export interface UpdateCartCampaignOfferInput {
|
|
|
3521
3688
|
quantity?: number | null;
|
|
3522
3689
|
variantId: string;
|
|
3523
3690
|
}
|
|
3691
|
+
export interface UpdatePaypalOrderAddressInput {
|
|
3692
|
+
city?: string | null;
|
|
3693
|
+
country?: string | null;
|
|
3694
|
+
postalCode?: string | null;
|
|
3695
|
+
state?: string | null;
|
|
3696
|
+
}
|
|
3697
|
+
export interface UpdatePaypalOrderCustomerInput {
|
|
3698
|
+
email?: string | null;
|
|
3699
|
+
firstName?: string | null;
|
|
3700
|
+
id?: string | null;
|
|
3701
|
+
lastName?: string | null;
|
|
3702
|
+
}
|
|
3703
|
+
export interface UpdatePaypalOrderInput {
|
|
3704
|
+
address?: UpdatePaypalOrderAddressInput | null;
|
|
3705
|
+
cartId: string;
|
|
3706
|
+
customer?: UpdatePaypalOrderCustomerInput | null;
|
|
3707
|
+
shippingSettingsId?: string | null;
|
|
3708
|
+
shippingZoneRateId?: string | null;
|
|
3709
|
+
transactionId: string;
|
|
3710
|
+
}
|
|
3524
3711
|
export declare enum StorefrontPopupDeviceTypeEnum {
|
|
3525
3712
|
ALL = "ALL",
|
|
3526
3713
|
DESKTOP = "DESKTOP",
|
|
@@ -3632,8 +3819,218 @@ export interface SaveCustomerFormDataInput {
|
|
|
3632
3819
|
storefrontPopupId?: string | null;
|
|
3633
3820
|
subscriptions?: CustomerRegisterSubscriptionInput | null;
|
|
3634
3821
|
}
|
|
3635
|
-
export
|
|
3636
|
-
|
|
3637
|
-
|
|
3638
|
-
|
|
3822
|
+
export interface AddLoyaltyToCartInput {
|
|
3823
|
+
amount?: number | null;
|
|
3824
|
+
cartId: string;
|
|
3825
|
+
loyaltyProgramId: string;
|
|
3826
|
+
loyaltySpendingMethodId: string;
|
|
3827
|
+
}
|
|
3828
|
+
export interface CartLoyaltyLine {
|
|
3829
|
+
campaignType: CampaignTypeEnum | null;
|
|
3830
|
+
discountAmount: number;
|
|
3831
|
+
discountAmountType: OrderAmountTypeEnum;
|
|
3832
|
+
loyaltySpendingMethodId: string;
|
|
3833
|
+
pointUsed: number;
|
|
3834
|
+
}
|
|
3835
|
+
export interface LoyaltyCustomerInfo {
|
|
3836
|
+
cartLoyaltyLines: CartLoyaltyLine[] | null;
|
|
3837
|
+
customerTier: LoyaltyProgramTier | null;
|
|
3838
|
+
loyaltyProgramCustomerId: string;
|
|
3839
|
+
loyaltyProgramId: string;
|
|
3840
|
+
nextTierRequiredPoint: number | null;
|
|
3841
|
+
totalPoint: number;
|
|
3842
|
+
}
|
|
3843
|
+
export interface LoyaltyProgram {
|
|
3844
|
+
createdAt: any | null;
|
|
3845
|
+
deleted: boolean;
|
|
3846
|
+
earningMethods: LoyaltyProgramEarningMethod[] | null;
|
|
3847
|
+
id: string;
|
|
3848
|
+
isPassive: boolean | null;
|
|
3849
|
+
name: string;
|
|
3850
|
+
orderStatusToWinPoints: LoyaltyProgramOrderStatusToWinPointsEnum;
|
|
3851
|
+
previousOrderStartDate: any | null;
|
|
3852
|
+
refillPointsOnRefund: boolean;
|
|
3853
|
+
salesChannels: LoyaltyProgramSaleChannel[] | null;
|
|
3854
|
+
spendingMethods: LoyaltyProgramSpendingMethod[] | null;
|
|
3855
|
+
tiers: LoyaltyProgramTier[] | null;
|
|
3856
|
+
tokenName: string | null;
|
|
3857
|
+
updatedAt: any | null;
|
|
3858
|
+
validityPeriod: LoyaltyProgramPeriod | null;
|
|
3859
|
+
}
|
|
3860
|
+
export interface LoyaltyProgramDiscountSettings {
|
|
3861
|
+
discountAmount: number | null;
|
|
3862
|
+
freeProductId: string | null;
|
|
3863
|
+
point: number;
|
|
3864
|
+
}
|
|
3865
|
+
export interface LoyaltyProgramEarningMethod {
|
|
3866
|
+
amountPerPointsEarned: number | null;
|
|
3867
|
+
createdAt: any | null;
|
|
3868
|
+
deleted: boolean;
|
|
3869
|
+
description: string | null;
|
|
3870
|
+
earnedPointLimit: LoyaltyProgramPointLimit | null;
|
|
3871
|
+
id: string;
|
|
3872
|
+
isActive: boolean;
|
|
3873
|
+
lastValidityDate: any | null;
|
|
3874
|
+
loyaltyProgramId: string;
|
|
3875
|
+
methodType: EarningMethodTypeEnum;
|
|
3876
|
+
orderSettings: LoyaltyProgramEarningMethodOrderSettings | null;
|
|
3877
|
+
pointEarningType: LoyaltyProgramPointEarningTypeEnum;
|
|
3878
|
+
pointsEarned: number;
|
|
3879
|
+
productSettings: LoyaltyProgramEarningMethodProductSettings | null;
|
|
3880
|
+
quantityPerPointsEarned: number | null;
|
|
3881
|
+
segmentId: string | null;
|
|
3882
|
+
tierIds: string[] | null;
|
|
3883
|
+
translations: LoyaltyProgramMethodTranslation[] | null;
|
|
3884
|
+
updatedAt: any | null;
|
|
3885
|
+
validityPeriod: LoyaltyProgramPeriod | null;
|
|
3886
|
+
}
|
|
3887
|
+
export interface LoyaltyProgramEarningMethodOrderSettings {
|
|
3888
|
+
maxOrderAmount: number | null;
|
|
3889
|
+
minOrderAmount: number;
|
|
3890
|
+
productFilters: LoyaltyProgramFilter[] | null;
|
|
3891
|
+
}
|
|
3892
|
+
export interface LoyaltyProgramEarningMethodProductSettings {
|
|
3893
|
+
maxProductQuantity: number | null;
|
|
3894
|
+
minProductQuantity: number | null;
|
|
3895
|
+
productFilters: LoyaltyProgramFilter[] | null;
|
|
3896
|
+
}
|
|
3897
|
+
export interface LoyaltyProgramFilter {
|
|
3898
|
+
idList: string[];
|
|
3899
|
+
type: LoyaltyProgramFilterTypeEnum;
|
|
3900
|
+
}
|
|
3901
|
+
export interface LoyaltyProgramMethodTranslation {
|
|
3902
|
+
description: string;
|
|
3903
|
+
locale: string;
|
|
3904
|
+
}
|
|
3905
|
+
export interface LoyaltyProgramPeriod {
|
|
3906
|
+
period: string | null;
|
|
3907
|
+
periodType: PeriodTypeEnum | null;
|
|
3908
|
+
}
|
|
3909
|
+
export interface LoyaltyProgramPointHistory {
|
|
3910
|
+
amount: number;
|
|
3911
|
+
createdAt: any | null;
|
|
3912
|
+
customerId: string;
|
|
3913
|
+
deleted: boolean;
|
|
3914
|
+
expireDate: any | null;
|
|
3915
|
+
id: string;
|
|
3916
|
+
loyaltyProgramCustomerId: string;
|
|
3917
|
+
loyaltyProgramEarningMethodId: string | null;
|
|
3918
|
+
loyaltyProgramId: string;
|
|
3919
|
+
loyaltyProgramSpendingMethodId: string | null;
|
|
3920
|
+
orderId: string | null;
|
|
3921
|
+
type: LoyaltyProgramPointHistoryTypeEnum;
|
|
3922
|
+
updatedAt: any | null;
|
|
3923
|
+
}
|
|
3924
|
+
export interface LoyaltyProgramPointLimit {
|
|
3925
|
+
maxPointLimit: number | null;
|
|
3926
|
+
minPointLimit: number | null;
|
|
3927
|
+
}
|
|
3928
|
+
export interface LoyaltyProgramSaleChannel {
|
|
3929
|
+
routingIds: string[] | null;
|
|
3930
|
+
salesChannelId: string;
|
|
3931
|
+
storefrontId: string | null;
|
|
3932
|
+
}
|
|
3933
|
+
export interface LoyaltyProgramSpendingMethod {
|
|
3934
|
+
createdAt: any | null;
|
|
3935
|
+
deleted: boolean;
|
|
3936
|
+
description: string | null;
|
|
3937
|
+
discountSettings: LoyaltyProgramDiscountSettings | null;
|
|
3938
|
+
id: string;
|
|
3939
|
+
isActive: boolean;
|
|
3940
|
+
isAvailable: boolean | null;
|
|
3941
|
+
isDynamic: boolean;
|
|
3942
|
+
loyaltyProgramId: string;
|
|
3943
|
+
pointUsageLimit: LoyaltyProgramPointLimit | null;
|
|
3944
|
+
productFilters: LoyaltyProgramFilter[] | null;
|
|
3945
|
+
translations: LoyaltyProgramMethodTranslation[] | null;
|
|
3946
|
+
type: LoyaltyProgramMethodSpendingTypeEnum;
|
|
3947
|
+
updatedAt: any | null;
|
|
3948
|
+
}
|
|
3949
|
+
export interface LoyaltyProgramTier {
|
|
3950
|
+
createdAt: any | null;
|
|
3951
|
+
customerSegmentId: string | null;
|
|
3952
|
+
deleted: boolean;
|
|
3953
|
+
id: string;
|
|
3954
|
+
isActive: boolean;
|
|
3955
|
+
loyaltyProgramId: string;
|
|
3956
|
+
name: string;
|
|
3957
|
+
period: LoyaltyProgramPeriod | null;
|
|
3958
|
+
pointsRequired: number | null;
|
|
3959
|
+
tierPointMultiplier: number | null;
|
|
3960
|
+
translations: LoyaltyProgramTierTranslation[] | null;
|
|
3961
|
+
updatedAt: any | null;
|
|
3962
|
+
}
|
|
3963
|
+
export interface LoyaltyProgramTierTranslation {
|
|
3964
|
+
locale: string;
|
|
3965
|
+
name: string;
|
|
3966
|
+
}
|
|
3967
|
+
export declare enum LoyaltyProgramFilterTypeEnum {
|
|
3968
|
+
CATEGORY = "CATEGORY",
|
|
3969
|
+
DYNAMIC_CATEGORY = "DYNAMIC_CATEGORY",
|
|
3970
|
+
PRODUCT_AND_VARIANT = "PRODUCT_AND_VARIANT",
|
|
3971
|
+
PRODUCT_BRAND = "PRODUCT_BRAND",
|
|
3972
|
+
PRODUCT_TAG = "PRODUCT_TAG"
|
|
3973
|
+
}
|
|
3974
|
+
export declare enum LoyaltyProgramMethodSpendingTypeEnum {
|
|
3975
|
+
FIXED_AMOUNT = "FIXED_AMOUNT",
|
|
3976
|
+
FREE_PRODUCT = "FREE_PRODUCT",
|
|
3977
|
+
FREE_SHIPPING = "FREE_SHIPPING",
|
|
3978
|
+
RATIO = "RATIO"
|
|
3979
|
+
}
|
|
3980
|
+
export declare enum LoyaltyProgramOrderStatusToWinPointsEnum {
|
|
3981
|
+
ORDER_CREATED = "ORDER_CREATED",
|
|
3982
|
+
ORDER_DELIVERED = "ORDER_DELIVERED",
|
|
3983
|
+
PAYMENT_COMPLETED = "PAYMENT_COMPLETED"
|
|
3984
|
+
}
|
|
3985
|
+
export declare enum LoyaltyProgramPointEarningTypeEnum {
|
|
3986
|
+
DYNAMIC_ORDER_AMOUNT = "DYNAMIC_ORDER_AMOUNT",
|
|
3987
|
+
DYNAMIC_ORDER_QUANTITY = "DYNAMIC_ORDER_QUANTITY",
|
|
3988
|
+
STATIC = "STATIC"
|
|
3989
|
+
}
|
|
3990
|
+
export declare enum LoyaltyProgramPointHistoryTypeEnum {
|
|
3991
|
+
EARN = "EARN",
|
|
3992
|
+
SPEND = "SPEND"
|
|
3993
|
+
}
|
|
3994
|
+
export interface OrderLoyaltyLine {
|
|
3995
|
+
amount: number;
|
|
3996
|
+
id: string;
|
|
3997
|
+
loyaltyProgramCustomerId: string;
|
|
3998
|
+
loyaltyProgramId: string;
|
|
3999
|
+
loyaltySpendingMethodId: string;
|
|
4000
|
+
}
|
|
4001
|
+
export declare enum EarningMethodTypeEnum {
|
|
4002
|
+
BUY_PRODUCT = "BUY_PRODUCT",
|
|
4003
|
+
CUSTOMER_REGISTER = "CUSTOMER_REGISTER",
|
|
4004
|
+
CUSTOMER_REVIEW = "CUSTOMER_REVIEW",
|
|
4005
|
+
CUSTOMER_SEGMENT = "CUSTOMER_SEGMENT",
|
|
4006
|
+
ENABLE_SUBSCRIPTION = "ENABLE_SUBSCRIPTION",
|
|
4007
|
+
ORDER_CREATE = "ORDER_CREATE"
|
|
4008
|
+
}
|
|
4009
|
+
export declare enum PeriodTypeEnum {
|
|
4010
|
+
MONTH = "MONTH",
|
|
4011
|
+
WEEK = "WEEK",
|
|
4012
|
+
YEAR = "YEAR"
|
|
4013
|
+
}
|
|
4014
|
+
export interface LoyaltyProgramPointHistoryTypeEnumFilterInput {
|
|
4015
|
+
eq?: LoyaltyProgramPointHistoryTypeEnum | null;
|
|
4016
|
+
in?: LoyaltyProgramPointHistoryTypeEnum[] | null;
|
|
4017
|
+
ne?: LoyaltyProgramPointHistoryTypeEnum | null;
|
|
4018
|
+
nin?: LoyaltyProgramPointHistoryTypeEnum[] | null;
|
|
4019
|
+
}
|
|
4020
|
+
export declare enum StorefrontWidgetSettingsStatusEnum {
|
|
4021
|
+
ACTIVE = "ACTIVE",
|
|
4022
|
+
PASSIVE = "PASSIVE"
|
|
4023
|
+
}
|
|
4024
|
+
export interface StorefrontWidgetSettings {
|
|
4025
|
+
createdAt: any | null;
|
|
4026
|
+
deleted: boolean;
|
|
4027
|
+
id: string;
|
|
4028
|
+
status: StorefrontWidgetSettingsStatusEnum;
|
|
4029
|
+
storefrontRoutings: StorefrontWidgetSettingsRouting[];
|
|
4030
|
+
themeSettingsJson: any | null;
|
|
4031
|
+
updatedAt: any | null;
|
|
4032
|
+
}
|
|
4033
|
+
export interface StorefrontWidgetSettingsRouting {
|
|
4034
|
+
storefrontId: string;
|
|
4035
|
+
storefrontRoutingId: string;
|
|
3639
4036
|
}
|