@ikas/storefront-api 6.1.0-beta.23 → 6.1.0-beta.230

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.
Files changed (123) hide show
  1. package/build/__api/models/AddItemToCartInput.d.ts +2 -0
  2. package/build/__api/models/AddLoyaltyToCartInput.d.ts +12 -0
  3. package/build/__api/models/CartLoyaltyLine.d.ts +14 -0
  4. package/build/__api/models/CartV2.d.ts +3 -0
  5. package/build/__api/models/CheckoutSettings.d.ts +1 -0
  6. package/build/__api/models/CreatePayWithIkasSessionUrlResponse.d.ts +10 -0
  7. package/build/__api/models/CustomerReview.d.ts +6 -0
  8. package/build/__api/models/CustomerReviewProductModel.d.ts +15 -0
  9. package/build/__api/models/CustomerReviewReplyInfo.d.ts +10 -0
  10. package/build/__api/models/GetCustomerReviewImageUploadUrlResponse.d.ts +11 -0
  11. package/build/__api/models/HepsipayFrameInitResponse.d.ts +11 -0
  12. package/build/__api/models/ListOrderTransactionWithPricesResponse.d.ts +1 -0
  13. package/build/__api/models/LoyaltyCustomerInfo.d.ts +16 -0
  14. package/build/__api/models/LoyaltyProgram.d.ts +26 -0
  15. package/build/__api/models/LoyaltyProgramDiscountSettings.d.ts +11 -0
  16. package/build/__api/models/LoyaltyProgramEarningMethod.d.ts +31 -0
  17. package/build/__api/models/LoyaltyProgramEarningMethodOrderSettings.d.ts +12 -0
  18. package/build/__api/models/LoyaltyProgramEarningMethodProductSettings.d.ts +12 -0
  19. package/build/__api/models/LoyaltyProgramFilter.d.ts +11 -0
  20. package/build/__api/models/LoyaltyProgramMethodTranslation.d.ts +10 -0
  21. package/build/__api/models/LoyaltyProgramPeriod.d.ts +11 -0
  22. package/build/__api/models/LoyaltyProgramPointHistory.d.ts +19 -0
  23. package/build/__api/models/LoyaltyProgramPointHistoryTypeEnumFilterInput.d.ts +13 -0
  24. package/build/__api/models/LoyaltyProgramPointLimit.d.ts +10 -0
  25. package/build/__api/models/LoyaltyProgramSaleChannel.d.ts +11 -0
  26. package/build/__api/models/LoyaltyProgramSpendingMethod.d.ts +24 -0
  27. package/build/__api/models/LoyaltyProgramTier.d.ts +19 -0
  28. package/build/__api/models/LoyaltyProgramTierTranslation.d.ts +10 -0
  29. package/build/__api/models/OrderAdjustment.d.ts +3 -1
  30. package/build/__api/models/OrderLineItem.d.ts +5 -0
  31. package/build/__api/models/OrderLineItemCustomerSubscriptionPlan.d.ts +9 -0
  32. package/build/__api/models/OrderLineItemSubscriptionPlan.d.ts +12 -0
  33. package/build/__api/models/OrderLineItemSubscriptionPlanPeriod.d.ts +19 -0
  34. package/build/__api/models/OrderLoyaltyLine.d.ts +13 -0
  35. package/build/__api/models/ProductSearchResponse.d.ts +2 -0
  36. package/build/__api/models/SearchInput.d.ts +2 -0
  37. package/build/__api/models/SearchSuggestion.d.ts +12 -0
  38. package/build/__api/models/StorefrontWidgetSettings.d.ts +14 -0
  39. package/build/__api/models/StorefrontWidgetSettingsRouting.d.ts +10 -0
  40. package/build/__api/models/SubscriptionPlanDiscount.d.ts +11 -0
  41. package/build/__api/models/UpdatePaypalOrderAddressInput.d.ts +12 -0
  42. package/build/__api/models/UpdatePaypalOrderCustomerInput.d.ts +12 -0
  43. package/build/__api/models/UpdatePaypalOrderInput.d.ts +16 -0
  44. package/build/__api/mutations/addItemToCart.d.ts +13 -0
  45. package/build/__api/mutations/addItemToCart.js +1 -1
  46. package/build/__api/mutations/createPayWithIkasSessionUrl.d.ts +11 -0
  47. package/build/__api/mutations/createPayWithIkasSessionUrl.js +1 -0
  48. package/build/__api/mutations/createPaypalOrder.d.ts +2 -0
  49. package/build/__api/mutations/createPaypalOrder.js +1 -1
  50. package/build/__api/mutations/customerLogin.d.ts +6 -2
  51. package/build/__api/mutations/customerLogin.js +1 -1
  52. package/build/__api/mutations/getCustomerReviewImageUploadUrl.d.ts +13 -0
  53. package/build/__api/mutations/getPaypalClientId.d.ts +1 -1
  54. package/build/__api/mutations/getPaypalClientId.js +1 -1
  55. package/build/__api/mutations/hepsipayFrameInit.d.ts +13 -0
  56. package/build/__api/mutations/hepsipayFrameInit.js +1 -0
  57. package/build/__api/mutations/registerCustomer.d.ts +8 -4
  58. package/build/__api/mutations/registerCustomer.js +1 -1
  59. package/build/__api/mutations/removeLoyaltyPointsFromCart.d.ts +533 -0
  60. package/build/__api/mutations/removeLoyaltyPointsFromCart.js +1 -0
  61. package/build/__api/mutations/resendCustomerPhoneVerificationCode.d.ts +2 -5
  62. package/build/__api/mutations/resendCustomerPhoneVerificationCode.js +1 -1
  63. package/build/__api/mutations/updatePaypalOrder.d.ts +8 -0
  64. package/build/__api/mutations/updatePaypalOrder.js +1 -0
  65. package/build/__api/mutations/useLoyaltyPoints.d.ts +532 -0
  66. package/build/__api/mutations/useLoyaltyPoints.js +1 -0
  67. package/build/__api/mutations/validateCustomerPhoneVerificationCode.d.ts +1 -0
  68. package/build/__api/mutations/validateCustomerPhoneVerificationCode.js +1 -1
  69. package/build/__api/mutations/validateOTPCode.d.ts +97 -0
  70. package/build/__api/mutations/validateOTPCode.js +1 -0
  71. package/build/__api/queries/getAvailableStockLocations.d.ts +1 -0
  72. package/build/__api/queries/getAvailableStockLocations.js +1 -1
  73. package/build/__api/queries/getCart.d.ts +13 -0
  74. package/build/__api/queries/getCartById.d.ts +25 -1
  75. package/build/__api/queries/getCartById.js +1 -1
  76. package/build/__api/queries/getCheckoutByCartId.d.ts +13 -0
  77. package/build/__api/queries/getCheckoutById.d.ts +13 -0
  78. package/build/__api/queries/getCustomerOrders.d.ts +19 -0
  79. package/build/__api/queries/getCustomerOrders.js +1 -1
  80. package/build/__api/queries/getLoyaltyCustomerInfo.d.ts +32 -0
  81. package/build/__api/queries/getLoyaltyCustomerInfo.js +1 -0
  82. package/build/__api/queries/getLoyaltyProgram.d.ts +83 -0
  83. package/build/__api/queries/getLoyaltyProgram.js +1 -0
  84. package/build/__api/queries/getOrder.d.ts +19 -0
  85. package/build/__api/queries/getStoreCreditBalance.d.ts +25 -0
  86. package/build/__api/queries/getStoreCreditBalance.js +1 -0
  87. package/build/__api/queries/getStorefrontWidgetSettings.d.ts +14 -0
  88. package/build/__api/queries/getStorefrontWidgetSettings.js +1 -0
  89. package/build/__api/queries/listCheckoutSettings.d.ts +1 -0
  90. package/build/__api/queries/listCheckoutSettings.js +1 -1
  91. package/build/__api/queries/listCustomerReviewSummary.d.ts +1 -0
  92. package/build/__api/queries/listCustomerReviews.d.ts +12 -0
  93. package/build/__api/queries/listCustomerReviews.js +1 -1
  94. package/build/__api/queries/listEarningMethods.d.ts +35 -0
  95. package/build/__api/queries/listEarningMethods.js +1 -0
  96. package/build/__api/queries/listLoyaltyProgramPointHistory.d.ts +22 -0
  97. package/build/__api/queries/listLoyaltyProgramPointHistory.js +1 -0
  98. package/build/__api/queries/listLoyaltyProgramTiers.d.ts +20 -0
  99. package/build/__api/queries/listLoyaltyProgramTiers.js +1 -0
  100. package/build/__api/queries/listOrderTransactionsWithPrices.d.ts +1 -0
  101. package/build/__api/queries/listOrderTransactionsWithPrices.js +1 -1
  102. package/build/__api/queries/listSpendingMethodsByCartId.d.ts +28 -0
  103. package/build/__api/queries/listSpendingMethodsByCartId.js +1 -0
  104. package/build/__api/queries/searchProducts.d.ts +21 -0
  105. package/build/__api/queries/searchProducts.js +1 -1
  106. package/build/__api/types/index.d.ts +413 -12
  107. package/build/__api/types/index.js +1 -1
  108. package/build/api/cart/index.d.ts +7 -1
  109. package/build/api/cart/index.js +1 -1
  110. package/build/api/checkout/index.d.ts +7 -2
  111. package/build/api/checkout/index.js +1 -1
  112. package/build/api/customer/index.d.ts +37 -6
  113. package/build/api/customer/index.js +1 -1
  114. package/build/api/loyalty/index.d.ts +14 -0
  115. package/build/api/loyalty/index.js +1 -0
  116. package/build/api/product/index.d.ts +2 -1
  117. package/build/api/product/index.js +1 -1
  118. package/build/api/storefront/index.d.ts +7 -1
  119. package/build/index.d.ts +4 -2
  120. package/build/index.js +1 -1
  121. package/build/index2.js +1 -1
  122. package/package.json +7 -7
  123. 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;
@@ -1167,6 +1207,10 @@ export interface CreatePaypalOrderResponse {
1167
1207
  sessionToken: string;
1168
1208
  transactionId: string;
1169
1209
  }
1210
+ export interface CreatePayWithIkasSessionUrlResponse {
1211
+ expiresAt: number;
1212
+ payUrl: string;
1213
+ }
1170
1214
  export interface CreateStripePaymentIntentResponse {
1171
1215
  accountId: string;
1172
1216
  apiKey: string;
@@ -1335,6 +1379,13 @@ export interface CustomerFavoriteProduct {
1335
1379
  productId: string;
1336
1380
  updatedAt: any | null;
1337
1381
  }
1382
+ export interface CustomerLoginResponse {
1383
+ customer: Customer | null;
1384
+ flowId: string | null;
1385
+ otpSend: boolean | null;
1386
+ token: string;
1387
+ tokenExpiry: number;
1388
+ }
1338
1389
  export interface CustomerPriceListRule {
1339
1390
  filters: CustomerPriceListRuleFilter[] | null;
1340
1391
  shouldMatchAllFilters: boolean | null;
@@ -1345,11 +1396,6 @@ export interface CustomerPriceListRuleFilter {
1345
1396
  type: CustomerPriceListRuleFilterTypeEnum;
1346
1397
  valueList: string[];
1347
1398
  }
1348
- export interface CustomerLoginResponse {
1349
- customer: Customer | null;
1350
- token: string;
1351
- tokenExpiry: number;
1352
- }
1353
1399
  export interface CustomerRefreshTokenResponse {
1354
1400
  token: string;
1355
1401
  tokenExpiry: number;
@@ -1358,16 +1404,20 @@ export interface CustomerReview {
1358
1404
  comment: string | null;
1359
1405
  createdAt: any | null;
1360
1406
  customerId: string | null;
1361
- deleted: boolean | null;
1407
+ deleted: boolean;
1362
1408
  email: string | null;
1363
1409
  firstName: string | null;
1364
1410
  id: string;
1365
1411
  imageIds: string[] | null;
1412
+ isPrivateReply: boolean | null;
1366
1413
  lastName: string | null;
1414
+ locale: string | null;
1367
1415
  orderId: string | null;
1368
1416
  orderNumber: string | null;
1417
+ product: CustomerReviewProductModel | null;
1369
1418
  productId: string;
1370
1419
  reply: string | null;
1420
+ replyInfo: CustomerReviewReplyInfo | null;
1371
1421
  salesChannelId: string | null;
1372
1422
  star: number;
1373
1423
  status: CustomerReviewStatusEnum | null;
@@ -1375,6 +1425,18 @@ export interface CustomerReview {
1375
1425
  title: string | null;
1376
1426
  updatedAt: any | null;
1377
1427
  }
1428
+ export interface CustomerReviewProductModel {
1429
+ brandId: string | null;
1430
+ categoryIds: string[] | null;
1431
+ id: string | null;
1432
+ tagIds: string | null;
1433
+ type: ProductTypeEnum | null;
1434
+ vendorId: string | null;
1435
+ }
1436
+ export interface CustomerReviewReplyInfo {
1437
+ createdAt: any | null;
1438
+ staffId: string | null;
1439
+ }
1378
1440
  export interface CustomerReviewSFPaginationResponse {
1379
1441
  count: number;
1380
1442
  data: CustomerReview[];
@@ -1385,7 +1447,7 @@ export interface CustomerReviewSFPaginationResponse {
1385
1447
  export interface CustomerReviewSummary {
1386
1448
  averageStar: number;
1387
1449
  createdAt: any | null;
1388
- deleted: boolean | null;
1450
+ deleted: boolean;
1389
1451
  id: string;
1390
1452
  productId: string;
1391
1453
  stars: CustomerReviewSummaryStar[];
@@ -1468,6 +1530,11 @@ export interface GetAvailableStockLocationAddressCountry {
1468
1530
  export interface GetAvailableStockLocationsResponse {
1469
1531
  stockLocations: GetAvailableStockLocation[];
1470
1532
  }
1533
+ export interface GetCustomerReviewImageUploadUrlResponse {
1534
+ fields: any;
1535
+ imageId: string;
1536
+ uploadUrl: string;
1537
+ }
1471
1538
  export interface GetPaypalClientIdResponse {
1472
1539
  clientId: string;
1473
1540
  merchantClientId: string | null;
@@ -1496,6 +1563,28 @@ export interface GetY {
1496
1563
  discountRatio: number;
1497
1564
  filter: CampaignFilter;
1498
1565
  }
1566
+ export interface GiftCard {
1567
+ active: boolean;
1568
+ amount: number;
1569
+ code: string;
1570
+ createdAt: any | null;
1571
+ customerId: string | null;
1572
+ deleted: boolean;
1573
+ endDate: any | null;
1574
+ id: string;
1575
+ minimumRequiredCartAmount: number | null;
1576
+ salesChannels: GiftCardSalesChannel[] | null;
1577
+ startDate: any | null;
1578
+ type: GiftCardTypeEnum;
1579
+ updatedAt: any | null;
1580
+ usedAllAmount: boolean | null;
1581
+ usedAmount: number;
1582
+ }
1583
+ export interface GiftCardSalesChannel {
1584
+ salesChannelId: string;
1585
+ storefrontId: string | null;
1586
+ storefrontRoutingId: string | null;
1587
+ }
1499
1588
  export interface HTMLMetaData {
1500
1589
  canonicals: string[] | null;
1501
1590
  createdAt: any | null;
@@ -1556,6 +1645,7 @@ export interface ListOrderTransactionWithPricesRefundableTransaction {
1556
1645
  export interface ListOrderTransactionWithPricesResponse {
1557
1646
  chargedAmount: number;
1558
1647
  orderFinalPrice: number;
1648
+ pendingAmount: number;
1559
1649
  refundableTransactions: ListOrderTransactionWithPricesRefundableTransaction[];
1560
1650
  refundedAmount: number;
1561
1651
  remainingBalance: number;
@@ -1691,9 +1781,11 @@ export interface OrderAdjustment {
1691
1781
  campaignId: string | null;
1692
1782
  campaignType: CampaignTypeEnum | null;
1693
1783
  couponId: string | null;
1784
+ createdFor: CampaignCreatedForEnum | null;
1694
1785
  name: string;
1695
1786
  order: number;
1696
1787
  type: OrderAdjustmentEnum;
1788
+ usedLoyaltyPoints: number | null;
1697
1789
  }
1698
1790
  export interface OrderAdjustmentAppliedOrderLine {
1699
1791
  amount: number;
@@ -1726,6 +1818,7 @@ export interface OrderGiftCardLine {
1726
1818
  code: string;
1727
1819
  giftCardId: string;
1728
1820
  id: string;
1821
+ type: GiftCardTypeEnum | null;
1729
1822
  }
1730
1823
  export interface OrderGiftPackageLine {
1731
1824
  price: number;
@@ -1783,11 +1876,31 @@ export interface OrderLineItem {
1783
1876
  status: OrderLineItemStatusEnum;
1784
1877
  statusUpdatedAt: any | null;
1785
1878
  stockLocationId: string | null;
1879
+ subscriptionPlan: OrderLineItemSubscriptionPlan | null;
1786
1880
  taxValue: number | null;
1787
1881
  unitPrice: number | null;
1788
1882
  updatedAt: any | null;
1789
1883
  variant: OrderLineVariant;
1790
1884
  }
1885
+ export interface OrderLineItemCustomerSubscriptionPlan {
1886
+ id: string;
1887
+ }
1888
+ export interface OrderLineItemSubscriptionPlan {
1889
+ id: string;
1890
+ name: string;
1891
+ period: OrderLineItemSubscriptionPlanPeriod;
1892
+ }
1893
+ export interface OrderLineItemSubscriptionPlanPeriod {
1894
+ cutOffDay: number | null;
1895
+ discount: SubscriptionPlanDiscount | null;
1896
+ durationUnit: SubscriptionPlanDurationUnitTypeEnum;
1897
+ durationValue: number;
1898
+ id: string;
1899
+ maxOrders: number | null;
1900
+ paymentType: SubscriptionPlanPaymentTypeEnum;
1901
+ scheduledOrderDay: number | null;
1902
+ title: string;
1903
+ }
1791
1904
  export interface OrderLineOption {
1792
1905
  name: string;
1793
1906
  productOptionId: string;
@@ -2233,6 +2346,7 @@ export interface ProductSearchResponse {
2233
2346
  limit: number;
2234
2347
  page: number;
2235
2348
  results: SearchProduct[];
2349
+ suggestions: SearchSuggestion[] | null;
2236
2350
  totalCount: number;
2237
2351
  }
2238
2352
  export interface ProductTagTranslation {
@@ -2544,6 +2658,29 @@ export interface SearchProductStockLocation {
2544
2658
  stockCount: number;
2545
2659
  stockLocationId: string;
2546
2660
  }
2661
+ export interface SearchProductSubscriptionPlan {
2662
+ name: string;
2663
+ periods: SearchProductSubscriptionPlanPeriod[];
2664
+ status: SubscriptionPlanStatusEnum;
2665
+ subscriptionPlanId: string;
2666
+ translations: SubscriptionPlanTranslation[] | null;
2667
+ }
2668
+ export interface SearchProductSubscriptionPlanDiscount {
2669
+ amount: number;
2670
+ type: OrderAmountTypeEnum;
2671
+ }
2672
+ export interface SearchProductSubscriptionPlanPeriod {
2673
+ cutOffDay: number | null;
2674
+ discount: SearchProductSubscriptionPlanDiscount | null;
2675
+ durationUnit: SubscriptionPlanDurationUnitTypeEnum;
2676
+ durationValue: number;
2677
+ id: string;
2678
+ maxOrders: number | null;
2679
+ paymentType: SubscriptionPlanPaymentTypeEnum;
2680
+ scheduledOrderDay: number | null;
2681
+ status: SubscriptionPlanStatusEnum;
2682
+ title: string;
2683
+ }
2547
2684
  export interface SearchProductTag {
2548
2685
  id: string;
2549
2686
  name: string;
@@ -2554,6 +2691,12 @@ export interface SearchProductVariantType {
2554
2691
  variantType: SearchVariantType;
2555
2692
  variantValueIds: string[];
2556
2693
  }
2694
+ export interface SearchSuggestion {
2695
+ brandId: string | null;
2696
+ categoryId: string | null;
2697
+ id: string;
2698
+ term: string;
2699
+ }
2557
2700
  export interface SearchVariant {
2558
2701
  attributes: SearchProductAttributeValue[] | null;
2559
2702
  barcodeList: string[] | null;
@@ -2567,6 +2710,7 @@ export interface SearchVariant {
2567
2710
  sellIfOutOfStock: boolean | null;
2568
2711
  sku: string | null;
2569
2712
  stocks: SearchProductStockLocation[] | null;
2713
+ subscriptionPlan: SearchProductSubscriptionPlan | null;
2570
2714
  unit: VariantUnitModel | null;
2571
2715
  variantValues: SearchVariationValueRelation[] | null;
2572
2716
  weight: number | null;
@@ -2650,6 +2794,10 @@ export interface StockLocationAddressState {
2650
2794
  id: string | null;
2651
2795
  name: string | null;
2652
2796
  }
2797
+ export interface StoreCreditBalanceResponse {
2798
+ amount: number;
2799
+ storeCredits: GiftCard[];
2800
+ }
2653
2801
  export interface Storefront {
2654
2802
  analytics4Id: string | null;
2655
2803
  createdAt: any | null;
@@ -2890,6 +3038,15 @@ export interface StorefrontTransaction {
2890
3038
  type: TransactionTypeEnum;
2891
3039
  updatedAt: any | null;
2892
3040
  }
3041
+ export interface SubscriptionPlanDiscount {
3042
+ amount: number;
3043
+ type: OrderAmountTypeEnum;
3044
+ }
3045
+ export interface SubscriptionPlanTranslation {
3046
+ description: string | null;
3047
+ locale: string;
3048
+ title: string;
3049
+ }
2893
3050
  export interface Town {
2894
3051
  createdAt: any | null;
2895
3052
  deleted: boolean | null;
@@ -3066,6 +3223,8 @@ export interface AddItemToCartInput {
3066
3223
  priceListId?: string | null;
3067
3224
  salesChannelId: string;
3068
3225
  storefrontThemeId: string;
3226
+ subscriptionPlanId?: string | null;
3227
+ subscriptionPlanPeriodId?: string | null;
3069
3228
  }
3070
3229
  export interface AppliedProductInput {
3071
3230
  productId?: string | null;
@@ -3216,6 +3375,16 @@ export interface CustomerAttributeValueInput {
3216
3375
  customerAttributeOptionId?: string | null;
3217
3376
  value?: string | null;
3218
3377
  }
3378
+ export interface CustomerRegisterSubscriptionInput {
3379
+ email: boolean;
3380
+ phone: boolean;
3381
+ sms: boolean;
3382
+ }
3383
+ export interface CustomerAttributeValueInput {
3384
+ customerAttributeId?: string | null;
3385
+ customerAttributeOptionId?: string | null;
3386
+ value?: string | null;
3387
+ }
3219
3388
  export interface DateFilterInput {
3220
3389
  eq?: any | null;
3221
3390
  gt?: any | null;
@@ -3460,10 +3629,12 @@ export interface SearchDynamicCurrencySettings {
3460
3629
  }
3461
3630
  export interface SearchInput {
3462
3631
  barcodeList?: string[] | null;
3632
+ baseCategoryIdList?: string[] | null;
3463
3633
  brandId?: string | null;
3464
3634
  brandIdList?: string[] | null;
3465
3635
  categoryIdList?: string[] | null;
3466
3636
  dynamicCurrencySettings?: SearchDynamicCurrencySettings | null;
3637
+ enableSuggestions?: boolean | null;
3467
3638
  facetList?: SearchInputFacetListInput[] | null;
3468
3639
  filterList?: SearchInputFilterListInput[] | null;
3469
3640
  locale?: string | null;
@@ -3521,6 +3692,26 @@ export interface UpdateCartCampaignOfferInput {
3521
3692
  quantity?: number | null;
3522
3693
  variantId: string;
3523
3694
  }
3695
+ export interface UpdatePaypalOrderAddressInput {
3696
+ city?: string | null;
3697
+ country?: string | null;
3698
+ postalCode?: string | null;
3699
+ state?: string | null;
3700
+ }
3701
+ export interface UpdatePaypalOrderCustomerInput {
3702
+ email?: string | null;
3703
+ firstName?: string | null;
3704
+ id?: string | null;
3705
+ lastName?: string | null;
3706
+ }
3707
+ export interface UpdatePaypalOrderInput {
3708
+ address?: UpdatePaypalOrderAddressInput | null;
3709
+ cartId: string;
3710
+ customer?: UpdatePaypalOrderCustomerInput | null;
3711
+ shippingSettingsId?: string | null;
3712
+ shippingZoneRateId?: string | null;
3713
+ transactionId: string;
3714
+ }
3524
3715
  export declare enum StorefrontPopupDeviceTypeEnum {
3525
3716
  ALL = "ALL",
3526
3717
  DESKTOP = "DESKTOP",
@@ -3632,8 +3823,218 @@ export interface SaveCustomerFormDataInput {
3632
3823
  storefrontPopupId?: string | null;
3633
3824
  subscriptions?: CustomerRegisterSubscriptionInput | null;
3634
3825
  }
3635
- export declare enum CustomerGenderTypeEnum {
3636
- FEMALE = "FEMALE",
3637
- MALE = "MALE",
3638
- OTHER = "OTHER"
3826
+ export interface AddLoyaltyToCartInput {
3827
+ amount?: number | null;
3828
+ cartId: string;
3829
+ loyaltyProgramId: string;
3830
+ loyaltySpendingMethodId: string;
3831
+ }
3832
+ export interface CartLoyaltyLine {
3833
+ campaignType: CampaignTypeEnum | null;
3834
+ discountAmount: number;
3835
+ discountAmountType: OrderAmountTypeEnum;
3836
+ loyaltySpendingMethodId: string;
3837
+ pointUsed: number;
3838
+ }
3839
+ export interface LoyaltyCustomerInfo {
3840
+ cartLoyaltyLines: CartLoyaltyLine[] | null;
3841
+ customerTier: LoyaltyProgramTier | null;
3842
+ loyaltyProgramCustomerId: string;
3843
+ loyaltyProgramId: string;
3844
+ nextTierRequiredPoint: number | null;
3845
+ totalPoint: number;
3846
+ }
3847
+ export interface LoyaltyProgram {
3848
+ createdAt: any | null;
3849
+ deleted: boolean;
3850
+ earningMethods: LoyaltyProgramEarningMethod[] | null;
3851
+ id: string;
3852
+ isPassive: boolean | null;
3853
+ name: string;
3854
+ orderStatusToWinPoints: LoyaltyProgramOrderStatusToWinPointsEnum;
3855
+ previousOrderStartDate: any | null;
3856
+ refillPointsOnRefund: boolean;
3857
+ salesChannels: LoyaltyProgramSaleChannel[] | null;
3858
+ spendingMethods: LoyaltyProgramSpendingMethod[] | null;
3859
+ tiers: LoyaltyProgramTier[] | null;
3860
+ tokenName: string | null;
3861
+ updatedAt: any | null;
3862
+ validityPeriod: LoyaltyProgramPeriod | null;
3863
+ }
3864
+ export interface LoyaltyProgramDiscountSettings {
3865
+ discountAmount: number | null;
3866
+ freeProductId: string | null;
3867
+ point: number;
3868
+ }
3869
+ export interface LoyaltyProgramEarningMethod {
3870
+ amountPerPointsEarned: number | null;
3871
+ createdAt: any | null;
3872
+ deleted: boolean;
3873
+ description: string | null;
3874
+ earnedPointLimit: LoyaltyProgramPointLimit | null;
3875
+ id: string;
3876
+ isActive: boolean;
3877
+ lastValidityDate: any | null;
3878
+ loyaltyProgramId: string;
3879
+ methodType: EarningMethodTypeEnum;
3880
+ orderSettings: LoyaltyProgramEarningMethodOrderSettings | null;
3881
+ pointEarningType: LoyaltyProgramPointEarningTypeEnum;
3882
+ pointsEarned: number;
3883
+ productSettings: LoyaltyProgramEarningMethodProductSettings | null;
3884
+ quantityPerPointsEarned: number | null;
3885
+ segmentId: string | null;
3886
+ tierIds: string[] | null;
3887
+ translations: LoyaltyProgramMethodTranslation[] | null;
3888
+ updatedAt: any | null;
3889
+ validityPeriod: LoyaltyProgramPeriod | null;
3890
+ }
3891
+ export interface LoyaltyProgramEarningMethodOrderSettings {
3892
+ maxOrderAmount: number | null;
3893
+ minOrderAmount: number;
3894
+ productFilters: LoyaltyProgramFilter[] | null;
3895
+ }
3896
+ export interface LoyaltyProgramEarningMethodProductSettings {
3897
+ maxProductQuantity: number | null;
3898
+ minProductQuantity: number | null;
3899
+ productFilters: LoyaltyProgramFilter[] | null;
3900
+ }
3901
+ export interface LoyaltyProgramFilter {
3902
+ idList: string[];
3903
+ type: LoyaltyProgramFilterTypeEnum;
3904
+ }
3905
+ export interface LoyaltyProgramMethodTranslation {
3906
+ description: string;
3907
+ locale: string;
3908
+ }
3909
+ export interface LoyaltyProgramPeriod {
3910
+ period: string | null;
3911
+ periodType: PeriodTypeEnum | null;
3912
+ }
3913
+ export interface LoyaltyProgramPointHistory {
3914
+ amount: number;
3915
+ createdAt: any | null;
3916
+ customerId: string;
3917
+ deleted: boolean;
3918
+ expireDate: any | null;
3919
+ id: string;
3920
+ loyaltyProgramCustomerId: string;
3921
+ loyaltyProgramEarningMethodId: string | null;
3922
+ loyaltyProgramId: string;
3923
+ loyaltyProgramSpendingMethodId: string | null;
3924
+ orderId: string | null;
3925
+ type: LoyaltyProgramPointHistoryTypeEnum;
3926
+ updatedAt: any | null;
3927
+ }
3928
+ export interface LoyaltyProgramPointLimit {
3929
+ maxPointLimit: number | null;
3930
+ minPointLimit: number | null;
3931
+ }
3932
+ export interface LoyaltyProgramSaleChannel {
3933
+ routingIds: string[] | null;
3934
+ salesChannelId: string;
3935
+ storefrontId: string | null;
3936
+ }
3937
+ export interface LoyaltyProgramSpendingMethod {
3938
+ createdAt: any | null;
3939
+ deleted: boolean;
3940
+ description: string | null;
3941
+ discountSettings: LoyaltyProgramDiscountSettings | null;
3942
+ id: string;
3943
+ isActive: boolean;
3944
+ isAvailable: boolean | null;
3945
+ isDynamic: boolean;
3946
+ loyaltyProgramId: string;
3947
+ pointUsageLimit: LoyaltyProgramPointLimit | null;
3948
+ productFilters: LoyaltyProgramFilter[] | null;
3949
+ translations: LoyaltyProgramMethodTranslation[] | null;
3950
+ type: LoyaltyProgramMethodSpendingTypeEnum;
3951
+ updatedAt: any | null;
3952
+ }
3953
+ export interface LoyaltyProgramTier {
3954
+ createdAt: any | null;
3955
+ customerSegmentId: string | null;
3956
+ deleted: boolean;
3957
+ id: string;
3958
+ isActive: boolean;
3959
+ loyaltyProgramId: string;
3960
+ name: string;
3961
+ period: LoyaltyProgramPeriod | null;
3962
+ pointsRequired: number | null;
3963
+ tierPointMultiplier: number | null;
3964
+ translations: LoyaltyProgramTierTranslation[] | null;
3965
+ updatedAt: any | null;
3966
+ }
3967
+ export interface LoyaltyProgramTierTranslation {
3968
+ locale: string;
3969
+ name: string;
3970
+ }
3971
+ export declare enum LoyaltyProgramFilterTypeEnum {
3972
+ CATEGORY = "CATEGORY",
3973
+ DYNAMIC_CATEGORY = "DYNAMIC_CATEGORY",
3974
+ PRODUCT_AND_VARIANT = "PRODUCT_AND_VARIANT",
3975
+ PRODUCT_BRAND = "PRODUCT_BRAND",
3976
+ PRODUCT_TAG = "PRODUCT_TAG"
3977
+ }
3978
+ export declare enum LoyaltyProgramMethodSpendingTypeEnum {
3979
+ FIXED_AMOUNT = "FIXED_AMOUNT",
3980
+ FREE_PRODUCT = "FREE_PRODUCT",
3981
+ FREE_SHIPPING = "FREE_SHIPPING",
3982
+ RATIO = "RATIO"
3983
+ }
3984
+ export declare enum LoyaltyProgramOrderStatusToWinPointsEnum {
3985
+ ORDER_CREATED = "ORDER_CREATED",
3986
+ ORDER_DELIVERED = "ORDER_DELIVERED",
3987
+ PAYMENT_COMPLETED = "PAYMENT_COMPLETED"
3988
+ }
3989
+ export declare enum LoyaltyProgramPointEarningTypeEnum {
3990
+ DYNAMIC_ORDER_AMOUNT = "DYNAMIC_ORDER_AMOUNT",
3991
+ DYNAMIC_ORDER_QUANTITY = "DYNAMIC_ORDER_QUANTITY",
3992
+ STATIC = "STATIC"
3993
+ }
3994
+ export declare enum LoyaltyProgramPointHistoryTypeEnum {
3995
+ EARN = "EARN",
3996
+ SPEND = "SPEND"
3997
+ }
3998
+ export interface OrderLoyaltyLine {
3999
+ amount: number;
4000
+ id: string;
4001
+ loyaltyProgramCustomerId: string;
4002
+ loyaltyProgramId: string;
4003
+ loyaltySpendingMethodId: string;
4004
+ }
4005
+ export declare enum EarningMethodTypeEnum {
4006
+ BUY_PRODUCT = "BUY_PRODUCT",
4007
+ CUSTOMER_REGISTER = "CUSTOMER_REGISTER",
4008
+ CUSTOMER_REVIEW = "CUSTOMER_REVIEW",
4009
+ CUSTOMER_SEGMENT = "CUSTOMER_SEGMENT",
4010
+ ENABLE_SUBSCRIPTION = "ENABLE_SUBSCRIPTION",
4011
+ ORDER_CREATE = "ORDER_CREATE"
4012
+ }
4013
+ export declare enum PeriodTypeEnum {
4014
+ MONTH = "MONTH",
4015
+ WEEK = "WEEK",
4016
+ YEAR = "YEAR"
4017
+ }
4018
+ export interface LoyaltyProgramPointHistoryTypeEnumFilterInput {
4019
+ eq?: LoyaltyProgramPointHistoryTypeEnum | null;
4020
+ in?: LoyaltyProgramPointHistoryTypeEnum[] | null;
4021
+ ne?: LoyaltyProgramPointHistoryTypeEnum | null;
4022
+ nin?: LoyaltyProgramPointHistoryTypeEnum[] | null;
4023
+ }
4024
+ export declare enum StorefrontWidgetSettingsStatusEnum {
4025
+ ACTIVE = "ACTIVE",
4026
+ PASSIVE = "PASSIVE"
4027
+ }
4028
+ export interface StorefrontWidgetSettings {
4029
+ createdAt: any | null;
4030
+ deleted: boolean;
4031
+ id: string;
4032
+ status: StorefrontWidgetSettingsStatusEnum;
4033
+ storefrontRoutings: StorefrontWidgetSettingsRouting[];
4034
+ themeSettingsJson: any | null;
4035
+ updatedAt: any | null;
4036
+ }
4037
+ export interface StorefrontWidgetSettingsRouting {
4038
+ storefrontId: string;
4039
+ storefrontRoutingId: string;
3639
4040
  }