@ikas/storefront-api 6.1.0-beta.31 → 6.1.0-beta.310

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 (140) 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/AddressFieldRestrictions.d.ts +14 -0
  4. package/build/__api/models/CartLoyaltyLine.d.ts +15 -0
  5. package/build/__api/models/CartV2.d.ts +3 -0
  6. package/build/__api/models/CheckoutSettings.d.ts +3 -0
  7. package/build/__api/models/CreateIyzicoCheckoutFormResponse.d.ts +10 -0
  8. package/build/__api/models/CreatePayWithIkasSessionUrlResponse.d.ts +10 -0
  9. package/build/__api/models/CreateStripeExpressCheckoutSessionResponse.d.ts +15 -0
  10. package/build/__api/models/CustomerReview.d.ts +6 -0
  11. package/build/__api/models/CustomerReviewProductModel.d.ts +15 -0
  12. package/build/__api/models/CustomerReviewReplyInfo.d.ts +10 -0
  13. package/build/__api/models/GetCustomerReviewImageUploadUrlResponse.d.ts +11 -0
  14. package/build/__api/models/HepsipayFrameInitResponse.d.ts +11 -0
  15. package/build/__api/models/ListOrderTransactionWithPricesResponse.d.ts +1 -0
  16. package/build/__api/models/LoyaltyCustomerInfo.d.ts +16 -0
  17. package/build/__api/models/LoyaltyProgram.d.ts +26 -0
  18. package/build/__api/models/LoyaltyProgramDiscountSettings.d.ts +12 -0
  19. package/build/__api/models/LoyaltyProgramEarningMethod.d.ts +31 -0
  20. package/build/__api/models/LoyaltyProgramEarningMethodOrderSettings.d.ts +12 -0
  21. package/build/__api/models/LoyaltyProgramEarningMethodProductSettings.d.ts +12 -0
  22. package/build/__api/models/LoyaltyProgramFilter.d.ts +11 -0
  23. package/build/__api/models/LoyaltyProgramMethodTranslation.d.ts +10 -0
  24. package/build/__api/models/LoyaltyProgramPeriod.d.ts +11 -0
  25. package/build/__api/models/LoyaltyProgramPointHistory.d.ts +21 -0
  26. package/build/__api/models/LoyaltyProgramPointHistoryTypeEnumFilterInput.d.ts +13 -0
  27. package/build/__api/models/LoyaltyProgramPointLimit.d.ts +10 -0
  28. package/build/__api/models/LoyaltyProgramSaleChannel.d.ts +11 -0
  29. package/build/__api/models/LoyaltyProgramSpendingMethod.d.ts +24 -0
  30. package/build/__api/models/LoyaltyProgramTier.d.ts +19 -0
  31. package/build/__api/models/LoyaltyProgramTierTranslation.d.ts +10 -0
  32. package/build/__api/models/OrderAdjustment.d.ts +3 -1
  33. package/build/__api/models/OrderLineItem.d.ts +5 -0
  34. package/build/__api/models/OrderLineItemCustomerSubscriptionPlan.d.ts +9 -0
  35. package/build/__api/models/OrderLineItemSubscriptionPlan.d.ts +12 -0
  36. package/build/__api/models/OrderLineItemSubscriptionPlanPeriod.d.ts +19 -0
  37. package/build/__api/models/OrderLoyaltyLine.d.ts +14 -0
  38. package/build/__api/models/ProductSearchResponse.d.ts +2 -0
  39. package/build/__api/models/SearchInput.d.ts +2 -0
  40. package/build/__api/models/SearchSuggestion.d.ts +12 -0
  41. package/build/__api/models/StorefrontWidgetSettings.d.ts +14 -0
  42. package/build/__api/models/StorefrontWidgetSettingsRouting.d.ts +10 -0
  43. package/build/__api/models/StripeExpressCheckoutAddressInput.d.ts +12 -0
  44. package/build/__api/models/StripeExpressCheckoutCustomerInput.d.ts +12 -0
  45. package/build/__api/models/StripeExpressCheckoutSessionContextResponse.d.ts +15 -0
  46. package/build/__api/models/SubscriptionPlanDiscount.d.ts +11 -0
  47. package/build/__api/models/UpdatePaypalOrderAddressInput.d.ts +12 -0
  48. package/build/__api/models/UpdatePaypalOrderCustomerInput.d.ts +12 -0
  49. package/build/__api/models/UpdatePaypalOrderInput.d.ts +16 -0
  50. package/build/__api/models/UpdateStripeExpressCheckoutSessionInput.d.ts +17 -0
  51. package/build/__api/mutations/addItemToCart.d.ts +13 -0
  52. package/build/__api/mutations/addItemToCart.js +1 -1
  53. package/build/__api/mutations/createIyzicoCheckoutForm.d.ts +11 -0
  54. package/build/__api/mutations/createIyzicoCheckoutForm.js +1 -0
  55. package/build/__api/mutations/createPayWithIkasSessionUrl.d.ts +11 -0
  56. package/build/__api/mutations/createPayWithIkasSessionUrl.js +1 -0
  57. package/build/__api/mutations/createPaypalOrder.d.ts +2 -0
  58. package/build/__api/mutations/createPaypalOrder.js +1 -1
  59. package/build/__api/mutations/createStripeExpressCheckoutSession.d.ts +16 -0
  60. package/build/__api/mutations/createStripeExpressCheckoutSession.js +1 -0
  61. package/build/__api/mutations/customerDeactivate.d.ts +1 -1
  62. package/build/__api/mutations/customerDeactivate.js +1 -1
  63. package/build/__api/mutations/customerLogin.d.ts +6 -2
  64. package/build/__api/mutations/customerLogin.js +1 -1
  65. package/build/__api/mutations/getCustomerReviewImageUploadUrl.d.ts +13 -0
  66. package/build/__api/mutations/getPaypalClientId.d.ts +1 -1
  67. package/build/__api/mutations/getPaypalClientId.js +1 -1
  68. package/build/__api/mutations/hepsipayFrameInit.d.ts +13 -0
  69. package/build/__api/mutations/hepsipayFrameInit.js +1 -0
  70. package/build/__api/mutations/registerCustomer.d.ts +8 -4
  71. package/build/__api/mutations/registerCustomer.js +1 -1
  72. package/build/__api/mutations/removeLoyaltyPointsFromCart.d.ts +535 -0
  73. package/build/__api/mutations/removeLoyaltyPointsFromCart.js +1 -0
  74. package/build/__api/mutations/resendCustomerPhoneVerificationCode.d.ts +2 -5
  75. package/build/__api/mutations/resendCustomerPhoneVerificationCode.js +1 -1
  76. package/build/__api/mutations/updatePaypalOrder.d.ts +8 -0
  77. package/build/__api/mutations/updatePaypalOrder.js +1 -0
  78. package/build/__api/mutations/updateStripeExpressCheckoutSession.d.ts +16 -0
  79. package/build/__api/mutations/updateStripeExpressCheckoutSession.js +1 -0
  80. package/build/__api/mutations/useLoyaltyPoints.d.ts +534 -0
  81. package/build/__api/mutations/useLoyaltyPoints.js +1 -0
  82. package/build/__api/mutations/validateCustomerPhoneVerificationCode.d.ts +1 -0
  83. package/build/__api/mutations/validateCustomerPhoneVerificationCode.js +1 -1
  84. package/build/__api/mutations/validateOTPCode.d.ts +97 -0
  85. package/build/__api/mutations/validateOTPCode.js +1 -0
  86. package/build/__api/queries/getAvailableStockLocations.d.ts +1 -0
  87. package/build/__api/queries/getAvailableStockLocations.js +1 -1
  88. package/build/__api/queries/getCart.d.ts +13 -0
  89. package/build/__api/queries/getCartById.d.ts +23 -0
  90. package/build/__api/queries/getCartById.js +1 -1
  91. package/build/__api/queries/getCheckoutByCartId.d.ts +13 -0
  92. package/build/__api/queries/getCheckoutById.d.ts +13 -0
  93. package/build/__api/queries/getCustomerOrders.d.ts +19 -0
  94. package/build/__api/queries/getCustomerOrders.js +1 -1
  95. package/build/__api/queries/getLoyaltyCustomerInfo.d.ts +33 -0
  96. package/build/__api/queries/getLoyaltyCustomerInfo.js +1 -0
  97. package/build/__api/queries/getLoyaltyProgram.d.ts +84 -0
  98. package/build/__api/queries/getLoyaltyProgram.js +1 -0
  99. package/build/__api/queries/getOrder.d.ts +19 -0
  100. package/build/__api/queries/getOrderInvoicePdfUrl.d.ts +7 -0
  101. package/build/__api/queries/getOrderInvoicePdfUrl.js +1 -0
  102. package/build/__api/queries/getStoreCreditBalance.d.ts +25 -0
  103. package/build/__api/queries/getStoreCreditBalance.js +1 -0
  104. package/build/__api/queries/getStorefrontWidgetSettings.d.ts +14 -0
  105. package/build/__api/queries/getStorefrontWidgetSettings.js +1 -0
  106. package/build/__api/queries/listCheckoutSettings.d.ts +7 -0
  107. package/build/__api/queries/listCheckoutSettings.js +1 -1
  108. package/build/__api/queries/listCustomerReviewSummary.d.ts +1 -0
  109. package/build/__api/queries/listCustomerReviews.d.ts +12 -0
  110. package/build/__api/queries/listCustomerReviews.js +1 -1
  111. package/build/__api/queries/listEarningMethods.d.ts +35 -0
  112. package/build/__api/queries/listEarningMethods.js +1 -0
  113. package/build/__api/queries/listLoyaltyProgramPointHistory.d.ts +25 -0
  114. package/build/__api/queries/listLoyaltyProgramPointHistory.js +1 -0
  115. package/build/__api/queries/listLoyaltyProgramTiers.d.ts +20 -0
  116. package/build/__api/queries/listLoyaltyProgramTiers.js +1 -0
  117. package/build/__api/queries/listOrderTransactionsWithPrices.d.ts +1 -0
  118. package/build/__api/queries/listOrderTransactionsWithPrices.js +1 -1
  119. package/build/__api/queries/listSpendingMethodsByCartId.d.ts +29 -0
  120. package/build/__api/queries/listSpendingMethodsByCartId.js +1 -0
  121. package/build/__api/queries/searchProducts.d.ts +21 -0
  122. package/build/__api/queries/searchProducts.js +1 -1
  123. package/build/__api/types/index.d.ts +476 -12
  124. package/build/__api/types/index.js +1 -1
  125. package/build/api/cart/index.d.ts +7 -1
  126. package/build/api/cart/index.js +1 -1
  127. package/build/api/checkout/index.d.ts +15 -2
  128. package/build/api/checkout/index.js +1 -1
  129. package/build/api/customer/index.d.ts +37 -6
  130. package/build/api/customer/index.js +1 -1
  131. package/build/api/loyalty/index.d.ts +14 -0
  132. package/build/api/loyalty/index.js +1 -0
  133. package/build/api/product/index.d.ts +2 -1
  134. package/build/api/product/index.js +1 -1
  135. package/build/api/storefront/index.d.ts +7 -1
  136. package/build/index.d.ts +3 -1
  137. package/build/index.js +1 -1
  138. package/build/index2.js +1 -1
  139. package/package.json +7 -7
  140. 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",
@@ -634,6 +666,14 @@ export interface AdditionalPrice {
634
666
  name: string;
635
667
  type: PaymentGatewayAdditionalPriceTypeEnum;
636
668
  }
669
+ export interface AddressFieldRestrictions {
670
+ addressLine1: string | null;
671
+ addressLine2: string | null;
672
+ companyName: string | null;
673
+ firstName: string | null;
674
+ lastName: string | null;
675
+ taxOffice: string | null;
676
+ }
637
677
  export interface ApplicableProductFilterValue {
638
678
  colorCode: string | null;
639
679
  id: string;
@@ -764,6 +804,11 @@ export interface BuyXThenGetY {
764
804
  getY: GetY;
765
805
  maxUsagePerOrder: number | null;
766
806
  }
807
+ export interface HepsipayFrameInitResponse {
808
+ frameToken: string | null;
809
+ frameUrl: string | null;
810
+ transactionId: string;
811
+ }
767
812
  export interface Campaign {
768
813
  applicableCustomerGroupIds: string[] | null;
769
814
  applicableCustomerIds: string[] | null;
@@ -928,6 +973,7 @@ export interface CartV2 {
928
973
  customerId: string | null;
929
974
  deleted: boolean | null;
930
975
  dueDate: any | null;
976
+ edited: boolean | null;
931
977
  giftCardLines: OrderGiftCardLine[] | null;
932
978
  giftPackageLines: OrderGiftPackageLine[] | null;
933
979
  giftPackageNote: string | null;
@@ -935,6 +981,7 @@ export interface CartV2 {
935
981
  id: string;
936
982
  isGiftPackage: boolean | null;
937
983
  itemCount: number | null;
984
+ loyaltyLines: OrderLoyaltyLine[] | null;
938
985
  merchantId: string;
939
986
  note: string | null;
940
987
  orderAdjustments: OrderAdjustment[] | null;
@@ -1073,6 +1120,7 @@ export interface CheckoutOption {
1073
1120
  required: boolean;
1074
1121
  }
1075
1122
  export interface CheckoutSettings {
1123
+ addressFieldRestrictions: AddressFieldRestrictions | null;
1076
1124
  corporateInvoiceRequirement: CorporateInvoiceRequirementEnum | null;
1077
1125
  couponCodeRequirement: CouponCodeRequirementEnum | null;
1078
1126
  createdAt: any | null;
@@ -1088,6 +1136,7 @@ export interface CheckoutSettings {
1088
1136
  options: CheckoutOption[] | null;
1089
1137
  phoneRequirement: CheckoutRequirementEnum;
1090
1138
  postalCodeRequirement: CheckoutRequirementEnum | null;
1139
+ showBillingAddressOnShippingStep: boolean | null;
1091
1140
  showCheckoutNote: boolean | null;
1092
1141
  showCompanyInfoInShippingAddress: boolean | null;
1093
1142
  showTermsAndConditionsCheckbox: boolean;
@@ -1154,6 +1203,10 @@ export interface CreateAdyenSessionResponse {
1154
1203
  sessionData: string | null;
1155
1204
  sessionId: string;
1156
1205
  }
1206
+ export interface CreateIyzicoCheckoutFormResponse {
1207
+ checkoutFormContent: string;
1208
+ paymentPageUrl: string;
1209
+ }
1157
1210
  export interface CreateKlarnaTokenResponse {
1158
1211
  authorizeUrl: string | null;
1159
1212
  clientToken: string | null;
@@ -1167,6 +1220,19 @@ export interface CreatePaypalOrderResponse {
1167
1220
  sessionToken: string;
1168
1221
  transactionId: string;
1169
1222
  }
1223
+ export interface CreatePayWithIkasSessionUrlResponse {
1224
+ expiresAt: number;
1225
+ payUrl: string;
1226
+ }
1227
+ export interface CreateStripeExpressCheckoutSessionResponse {
1228
+ accountId: string;
1229
+ apiKey: string;
1230
+ callbackUrl: string;
1231
+ clientSecret: string;
1232
+ failUrl: string;
1233
+ sessionId: string;
1234
+ transactionId: string;
1235
+ }
1170
1236
  export interface CreateStripePaymentIntentResponse {
1171
1237
  accountId: string;
1172
1238
  apiKey: string;
@@ -1335,6 +1401,13 @@ export interface CustomerFavoriteProduct {
1335
1401
  productId: string;
1336
1402
  updatedAt: any | null;
1337
1403
  }
1404
+ export interface CustomerLoginResponse {
1405
+ customer: Customer | null;
1406
+ flowId: string | null;
1407
+ otpSend: boolean | null;
1408
+ token: string;
1409
+ tokenExpiry: number;
1410
+ }
1338
1411
  export interface CustomerPriceListRule {
1339
1412
  filters: CustomerPriceListRuleFilter[] | null;
1340
1413
  shouldMatchAllFilters: boolean | null;
@@ -1345,11 +1418,6 @@ export interface CustomerPriceListRuleFilter {
1345
1418
  type: CustomerPriceListRuleFilterTypeEnum;
1346
1419
  valueList: string[];
1347
1420
  }
1348
- export interface CustomerLoginResponse {
1349
- customer: Customer | null;
1350
- token: string;
1351
- tokenExpiry: number;
1352
- }
1353
1421
  export interface CustomerRefreshTokenResponse {
1354
1422
  token: string;
1355
1423
  tokenExpiry: number;
@@ -1358,16 +1426,20 @@ export interface CustomerReview {
1358
1426
  comment: string | null;
1359
1427
  createdAt: any | null;
1360
1428
  customerId: string | null;
1361
- deleted: boolean | null;
1429
+ deleted: boolean;
1362
1430
  email: string | null;
1363
1431
  firstName: string | null;
1364
1432
  id: string;
1365
1433
  imageIds: string[] | null;
1434
+ isPrivateReply: boolean | null;
1366
1435
  lastName: string | null;
1436
+ locale: string | null;
1367
1437
  orderId: string | null;
1368
1438
  orderNumber: string | null;
1439
+ product: CustomerReviewProductModel | null;
1369
1440
  productId: string;
1370
1441
  reply: string | null;
1442
+ replyInfo: CustomerReviewReplyInfo | null;
1371
1443
  salesChannelId: string | null;
1372
1444
  star: number;
1373
1445
  status: CustomerReviewStatusEnum | null;
@@ -1375,6 +1447,18 @@ export interface CustomerReview {
1375
1447
  title: string | null;
1376
1448
  updatedAt: any | null;
1377
1449
  }
1450
+ export interface CustomerReviewProductModel {
1451
+ brandId: string | null;
1452
+ categoryIds: string[] | null;
1453
+ id: string | null;
1454
+ tagIds: string | null;
1455
+ type: ProductTypeEnum | null;
1456
+ vendorId: string | null;
1457
+ }
1458
+ export interface CustomerReviewReplyInfo {
1459
+ createdAt: any | null;
1460
+ staffId: string | null;
1461
+ }
1378
1462
  export interface CustomerReviewSFPaginationResponse {
1379
1463
  count: number;
1380
1464
  data: CustomerReview[];
@@ -1385,7 +1469,7 @@ export interface CustomerReviewSFPaginationResponse {
1385
1469
  export interface CustomerReviewSummary {
1386
1470
  averageStar: number;
1387
1471
  createdAt: any | null;
1388
- deleted: boolean | null;
1472
+ deleted: boolean;
1389
1473
  id: string;
1390
1474
  productId: string;
1391
1475
  stars: CustomerReviewSummaryStar[];
@@ -1468,6 +1552,11 @@ export interface GetAvailableStockLocationAddressCountry {
1468
1552
  export interface GetAvailableStockLocationsResponse {
1469
1553
  stockLocations: GetAvailableStockLocation[];
1470
1554
  }
1555
+ export interface GetCustomerReviewImageUploadUrlResponse {
1556
+ fields: any;
1557
+ imageId: string;
1558
+ uploadUrl: string;
1559
+ }
1471
1560
  export interface GetPaypalClientIdResponse {
1472
1561
  clientId: string;
1473
1562
  merchantClientId: string | null;
@@ -1496,6 +1585,28 @@ export interface GetY {
1496
1585
  discountRatio: number;
1497
1586
  filter: CampaignFilter;
1498
1587
  }
1588
+ export interface GiftCard {
1589
+ active: boolean;
1590
+ amount: number;
1591
+ code: string;
1592
+ createdAt: any | null;
1593
+ customerId: string | null;
1594
+ deleted: boolean;
1595
+ endDate: any | null;
1596
+ id: string;
1597
+ minimumRequiredCartAmount: number | null;
1598
+ salesChannels: GiftCardSalesChannel[] | null;
1599
+ startDate: any | null;
1600
+ type: GiftCardTypeEnum;
1601
+ updatedAt: any | null;
1602
+ usedAllAmount: boolean | null;
1603
+ usedAmount: number;
1604
+ }
1605
+ export interface GiftCardSalesChannel {
1606
+ salesChannelId: string;
1607
+ storefrontId: string | null;
1608
+ storefrontRoutingId: string | null;
1609
+ }
1499
1610
  export interface HTMLMetaData {
1500
1611
  canonicals: string[] | null;
1501
1612
  createdAt: any | null;
@@ -1556,6 +1667,7 @@ export interface ListOrderTransactionWithPricesRefundableTransaction {
1556
1667
  export interface ListOrderTransactionWithPricesResponse {
1557
1668
  chargedAmount: number;
1558
1669
  orderFinalPrice: number;
1670
+ pendingAmount: number;
1559
1671
  refundableTransactions: ListOrderTransactionWithPricesRefundableTransaction[];
1560
1672
  refundedAmount: number;
1561
1673
  remainingBalance: number;
@@ -1691,9 +1803,11 @@ export interface OrderAdjustment {
1691
1803
  campaignId: string | null;
1692
1804
  campaignType: CampaignTypeEnum | null;
1693
1805
  couponId: string | null;
1806
+ createdFor: CampaignCreatedForEnum | null;
1694
1807
  name: string;
1695
1808
  order: number;
1696
1809
  type: OrderAdjustmentEnum;
1810
+ usedLoyaltyPoints: number | null;
1697
1811
  }
1698
1812
  export interface OrderAdjustmentAppliedOrderLine {
1699
1813
  amount: number;
@@ -1726,6 +1840,7 @@ export interface OrderGiftCardLine {
1726
1840
  code: string;
1727
1841
  giftCardId: string;
1728
1842
  id: string;
1843
+ type: GiftCardTypeEnum | null;
1729
1844
  }
1730
1845
  export interface OrderGiftPackageLine {
1731
1846
  price: number;
@@ -1783,11 +1898,31 @@ export interface OrderLineItem {
1783
1898
  status: OrderLineItemStatusEnum;
1784
1899
  statusUpdatedAt: any | null;
1785
1900
  stockLocationId: string | null;
1901
+ subscriptionPlan: OrderLineItemSubscriptionPlan | null;
1786
1902
  taxValue: number | null;
1787
1903
  unitPrice: number | null;
1788
1904
  updatedAt: any | null;
1789
1905
  variant: OrderLineVariant;
1790
1906
  }
1907
+ export interface OrderLineItemCustomerSubscriptionPlan {
1908
+ id: string;
1909
+ }
1910
+ export interface OrderLineItemSubscriptionPlan {
1911
+ id: string;
1912
+ name: string;
1913
+ period: OrderLineItemSubscriptionPlanPeriod;
1914
+ }
1915
+ export interface OrderLineItemSubscriptionPlanPeriod {
1916
+ cutOffDay: number | null;
1917
+ discount: SubscriptionPlanDiscount | null;
1918
+ durationUnit: SubscriptionPlanDurationUnitTypeEnum;
1919
+ durationValue: number;
1920
+ id: string;
1921
+ maxOrders: number | null;
1922
+ paymentType: SubscriptionPlanPaymentTypeEnum;
1923
+ scheduledOrderDay: number | null;
1924
+ title: string;
1925
+ }
1791
1926
  export interface OrderLineOption {
1792
1927
  name: string;
1793
1928
  productOptionId: string;
@@ -2233,6 +2368,7 @@ export interface ProductSearchResponse {
2233
2368
  limit: number;
2234
2369
  page: number;
2235
2370
  results: SearchProduct[];
2371
+ suggestions: SearchSuggestion[] | null;
2236
2372
  totalCount: number;
2237
2373
  }
2238
2374
  export interface ProductTagTranslation {
@@ -2544,6 +2680,29 @@ export interface SearchProductStockLocation {
2544
2680
  stockCount: number;
2545
2681
  stockLocationId: string;
2546
2682
  }
2683
+ export interface SearchProductSubscriptionPlan {
2684
+ name: string;
2685
+ periods: SearchProductSubscriptionPlanPeriod[];
2686
+ status: SubscriptionPlanStatusEnum;
2687
+ subscriptionPlanId: string;
2688
+ translations: SubscriptionPlanTranslation[] | null;
2689
+ }
2690
+ export interface SearchProductSubscriptionPlanDiscount {
2691
+ amount: number;
2692
+ type: OrderAmountTypeEnum;
2693
+ }
2694
+ export interface SearchProductSubscriptionPlanPeriod {
2695
+ cutOffDay: number | null;
2696
+ discount: SearchProductSubscriptionPlanDiscount | null;
2697
+ durationUnit: SubscriptionPlanDurationUnitTypeEnum;
2698
+ durationValue: number;
2699
+ id: string;
2700
+ maxOrders: number | null;
2701
+ paymentType: SubscriptionPlanPaymentTypeEnum;
2702
+ scheduledOrderDay: number | null;
2703
+ status: SubscriptionPlanStatusEnum;
2704
+ title: string;
2705
+ }
2547
2706
  export interface SearchProductTag {
2548
2707
  id: string;
2549
2708
  name: string;
@@ -2554,6 +2713,12 @@ export interface SearchProductVariantType {
2554
2713
  variantType: SearchVariantType;
2555
2714
  variantValueIds: string[];
2556
2715
  }
2716
+ export interface SearchSuggestion {
2717
+ brandId: string | null;
2718
+ categoryId: string | null;
2719
+ id: string;
2720
+ term: string;
2721
+ }
2557
2722
  export interface SearchVariant {
2558
2723
  attributes: SearchProductAttributeValue[] | null;
2559
2724
  barcodeList: string[] | null;
@@ -2567,6 +2732,7 @@ export interface SearchVariant {
2567
2732
  sellIfOutOfStock: boolean | null;
2568
2733
  sku: string | null;
2569
2734
  stocks: SearchProductStockLocation[] | null;
2735
+ subscriptionPlan: SearchProductSubscriptionPlan | null;
2570
2736
  unit: VariantUnitModel | null;
2571
2737
  variantValues: SearchVariationValueRelation[] | null;
2572
2738
  weight: number | null;
@@ -2650,6 +2816,10 @@ export interface StockLocationAddressState {
2650
2816
  id: string | null;
2651
2817
  name: string | null;
2652
2818
  }
2819
+ export interface StoreCreditBalanceResponse {
2820
+ amount: number;
2821
+ storeCredits: GiftCard[];
2822
+ }
2653
2823
  export interface Storefront {
2654
2824
  analytics4Id: string | null;
2655
2825
  createdAt: any | null;
@@ -2890,6 +3060,15 @@ export interface StorefrontTransaction {
2890
3060
  type: TransactionTypeEnum;
2891
3061
  updatedAt: any | null;
2892
3062
  }
3063
+ export interface SubscriptionPlanDiscount {
3064
+ amount: number;
3065
+ type: OrderAmountTypeEnum;
3066
+ }
3067
+ export interface SubscriptionPlanTranslation {
3068
+ description: string | null;
3069
+ locale: string;
3070
+ title: string;
3071
+ }
2893
3072
  export interface Town {
2894
3073
  createdAt: any | null;
2895
3074
  deleted: boolean | null;
@@ -3066,6 +3245,8 @@ export interface AddItemToCartInput {
3066
3245
  priceListId?: string | null;
3067
3246
  salesChannelId: string;
3068
3247
  storefrontThemeId: string;
3248
+ subscriptionPlanId?: string | null;
3249
+ subscriptionPlanPeriodId?: string | null;
3069
3250
  }
3070
3251
  export interface AppliedProductInput {
3071
3252
  productId?: string | null;
@@ -3216,6 +3397,16 @@ export interface CustomerAttributeValueInput {
3216
3397
  customerAttributeOptionId?: string | null;
3217
3398
  value?: string | null;
3218
3399
  }
3400
+ export interface CustomerRegisterSubscriptionInput {
3401
+ email: boolean;
3402
+ phone: boolean;
3403
+ sms: boolean;
3404
+ }
3405
+ export interface CustomerAttributeValueInput {
3406
+ customerAttributeId?: string | null;
3407
+ customerAttributeOptionId?: string | null;
3408
+ value?: string | null;
3409
+ }
3219
3410
  export interface DateFilterInput {
3220
3411
  eq?: any | null;
3221
3412
  gt?: any | null;
@@ -3229,6 +3420,10 @@ export interface DateFilterInput {
3229
3420
  export interface GetOrderLineFile {
3230
3421
  url: string;
3231
3422
  }
3423
+ export interface GetOrderInvoicePdfUrlInput {
3424
+ invoiceId: string;
3425
+ orderId: string;
3426
+ }
3232
3427
  export interface GetProductCampaignsInput {
3233
3428
  customerGroupIds?: string[] | null;
3234
3429
  salesChannelId: string;
@@ -3460,10 +3655,12 @@ export interface SearchDynamicCurrencySettings {
3460
3655
  }
3461
3656
  export interface SearchInput {
3462
3657
  barcodeList?: string[] | null;
3658
+ baseCategoryIdList?: string[] | null;
3463
3659
  brandId?: string | null;
3464
3660
  brandIdList?: string[] | null;
3465
3661
  categoryIdList?: string[] | null;
3466
3662
  dynamicCurrencySettings?: SearchDynamicCurrencySettings | null;
3663
+ enableSuggestions?: boolean | null;
3467
3664
  facetList?: SearchInputFacetListInput[] | null;
3468
3665
  filterList?: SearchInputFilterListInput[] | null;
3469
3666
  locale?: string | null;
@@ -3505,6 +3702,18 @@ export interface StringFilterInput {
3505
3702
  ne?: string | null;
3506
3703
  nin?: string[] | null;
3507
3704
  }
3705
+ export interface StripeExpressCheckoutAddressInput {
3706
+ city?: string | null;
3707
+ country?: string | null;
3708
+ postalCode?: string | null;
3709
+ state?: string | null;
3710
+ }
3711
+ export interface StripeExpressCheckoutCustomerInput {
3712
+ email?: string | null;
3713
+ firstName?: string | null;
3714
+ id?: string | null;
3715
+ lastName?: string | null;
3716
+ }
3508
3717
  export interface SubscribeToMarketingNotificationsInput {
3509
3718
  captchaToken?: string | null;
3510
3719
  email: string;
@@ -3521,6 +3730,35 @@ export interface UpdateCartCampaignOfferInput {
3521
3730
  quantity?: number | null;
3522
3731
  variantId: string;
3523
3732
  }
3733
+ export interface UpdatePaypalOrderAddressInput {
3734
+ city?: string | null;
3735
+ country?: string | null;
3736
+ postalCode?: string | null;
3737
+ state?: string | null;
3738
+ }
3739
+ export interface UpdatePaypalOrderCustomerInput {
3740
+ email?: string | null;
3741
+ firstName?: string | null;
3742
+ id?: string | null;
3743
+ lastName?: string | null;
3744
+ }
3745
+ export interface UpdatePaypalOrderInput {
3746
+ address?: UpdatePaypalOrderAddressInput | null;
3747
+ cartId: string;
3748
+ customer?: UpdatePaypalOrderCustomerInput | null;
3749
+ shippingSettingsId?: string | null;
3750
+ shippingZoneRateId?: string | null;
3751
+ transactionId: string;
3752
+ }
3753
+ export interface UpdateStripeExpressCheckoutSessionInput {
3754
+ address?: StripeExpressCheckoutAddressInput | null;
3755
+ cartId: string;
3756
+ customer?: StripeExpressCheckoutCustomerInput | null;
3757
+ sessionId: string;
3758
+ shippingSettingsId?: string | null;
3759
+ shippingZoneRateId?: string | null;
3760
+ transactionId: string;
3761
+ }
3524
3762
  export declare enum StorefrontPopupDeviceTypeEnum {
3525
3763
  ALL = "ALL",
3526
3764
  DESKTOP = "DESKTOP",
@@ -3632,8 +3870,234 @@ export interface SaveCustomerFormDataInput {
3632
3870
  storefrontPopupId?: string | null;
3633
3871
  subscriptions?: CustomerRegisterSubscriptionInput | null;
3634
3872
  }
3635
- export declare enum CustomerGenderTypeEnum {
3636
- FEMALE = "FEMALE",
3637
- MALE = "MALE",
3638
- OTHER = "OTHER"
3873
+ export interface AddLoyaltyToCartInput {
3874
+ amount?: number | null;
3875
+ cartId: string;
3876
+ loyaltyProgramId: string;
3877
+ loyaltySpendingMethodId: string;
3878
+ }
3879
+ export interface CartLoyaltyLine {
3880
+ campaignType: CampaignTypeEnum | null;
3881
+ discountAmount: number;
3882
+ discountAmountType: OrderAmountTypeEnum;
3883
+ discountPercentage: number | null;
3884
+ loyaltySpendingMethodId: string;
3885
+ pointUsed: number;
3886
+ }
3887
+ export interface LoyaltyCustomerInfo {
3888
+ cartLoyaltyLines: CartLoyaltyLine[] | null;
3889
+ customerTier: LoyaltyProgramTier | null;
3890
+ loyaltyProgramCustomerId: string;
3891
+ loyaltyProgramId: string;
3892
+ nextTierRequiredPoint: number | null;
3893
+ totalPoint: number;
3894
+ }
3895
+ export interface LoyaltyProgram {
3896
+ createdAt: any | null;
3897
+ deleted: boolean;
3898
+ earningMethods: LoyaltyProgramEarningMethod[] | null;
3899
+ id: string;
3900
+ isPassive: boolean | null;
3901
+ name: string;
3902
+ orderStatusToWinPoints: LoyaltyProgramOrderStatusToWinPointsEnum;
3903
+ previousOrderStartDate: any | null;
3904
+ refillPointsOnRefund: boolean;
3905
+ salesChannels: LoyaltyProgramSaleChannel[] | null;
3906
+ spendingMethods: LoyaltyProgramSpendingMethod[] | null;
3907
+ tiers: LoyaltyProgramTier[] | null;
3908
+ tokenName: string | null;
3909
+ updatedAt: any | null;
3910
+ validityPeriod: LoyaltyProgramPeriod | null;
3911
+ }
3912
+ export interface LoyaltyProgramDiscountSettings {
3913
+ discountAmount: number | null;
3914
+ freeProductId: string | null;
3915
+ freeProductVariantId: string | null;
3916
+ point: number;
3917
+ }
3918
+ export interface LoyaltyProgramEarningMethod {
3919
+ amountPerPointsEarned: number | null;
3920
+ createdAt: any | null;
3921
+ deleted: boolean;
3922
+ description: string | null;
3923
+ earnedPointLimit: LoyaltyProgramPointLimit | null;
3924
+ id: string;
3925
+ isActive: boolean;
3926
+ lastValidityDate: any | null;
3927
+ loyaltyProgramId: string;
3928
+ methodType: EarningMethodTypeEnum;
3929
+ orderSettings: LoyaltyProgramEarningMethodOrderSettings | null;
3930
+ pointEarningType: LoyaltyProgramPointEarningTypeEnum;
3931
+ pointsEarned: number;
3932
+ productSettings: LoyaltyProgramEarningMethodProductSettings | null;
3933
+ quantityPerPointsEarned: number | null;
3934
+ segmentId: string | null;
3935
+ tierIds: string[] | null;
3936
+ translations: LoyaltyProgramMethodTranslation[] | null;
3937
+ updatedAt: any | null;
3938
+ validityPeriod: LoyaltyProgramPeriod | null;
3939
+ }
3940
+ export interface LoyaltyProgramEarningMethodOrderSettings {
3941
+ maxOrderAmount: number | null;
3942
+ minOrderAmount: number;
3943
+ productFilters: LoyaltyProgramFilter[] | null;
3944
+ }
3945
+ export interface LoyaltyProgramEarningMethodProductSettings {
3946
+ maxProductQuantity: number | null;
3947
+ minProductQuantity: number | null;
3948
+ productFilters: LoyaltyProgramFilter[] | null;
3949
+ }
3950
+ export interface LoyaltyProgramFilter {
3951
+ idList: string[];
3952
+ type: LoyaltyProgramFilterTypeEnum;
3953
+ }
3954
+ export interface LoyaltyProgramMethodTranslation {
3955
+ description: string;
3956
+ locale: string;
3957
+ }
3958
+ export interface LoyaltyProgramPeriod {
3959
+ period: string | null;
3960
+ periodType: PeriodTypeEnum | null;
3961
+ }
3962
+ export interface LoyaltyProgramPointHistory {
3963
+ amount: number;
3964
+ createdAt: any | null;
3965
+ customerId: string;
3966
+ customerReviewId: string | null;
3967
+ deleted: boolean;
3968
+ expireDate: any | null;
3969
+ id: string;
3970
+ loyaltyProgramCustomerId: string;
3971
+ loyaltyProgramEarningMethodId: string | null;
3972
+ loyaltyProgramId: string;
3973
+ loyaltyProgramSpendingMethodId: string | null;
3974
+ orderId: string | null;
3975
+ productVariantId: string | null;
3976
+ type: LoyaltyProgramPointHistoryTypeEnum;
3977
+ updatedAt: any | null;
3978
+ }
3979
+ export interface LoyaltyProgramPointLimit {
3980
+ maxPointLimit: number | null;
3981
+ minPointLimit: number | null;
3982
+ }
3983
+ export interface LoyaltyProgramSaleChannel {
3984
+ routingIds: string[] | null;
3985
+ salesChannelId: string;
3986
+ storefrontId: string | null;
3987
+ }
3988
+ export interface LoyaltyProgramSpendingMethod {
3989
+ createdAt: any | null;
3990
+ deleted: boolean;
3991
+ description: string | null;
3992
+ discountSettings: LoyaltyProgramDiscountSettings | null;
3993
+ id: string;
3994
+ isActive: boolean;
3995
+ isAvailable: boolean | null;
3996
+ isDynamic: boolean;
3997
+ loyaltyProgramId: string;
3998
+ pointUsageLimit: LoyaltyProgramPointLimit | null;
3999
+ productFilters: LoyaltyProgramFilter[] | null;
4000
+ translations: LoyaltyProgramMethodTranslation[] | null;
4001
+ type: LoyaltyProgramMethodSpendingTypeEnum;
4002
+ updatedAt: any | null;
4003
+ }
4004
+ export interface LoyaltyProgramTier {
4005
+ createdAt: any | null;
4006
+ customerSegmentId: string | null;
4007
+ deleted: boolean;
4008
+ id: string;
4009
+ isActive: boolean;
4010
+ loyaltyProgramId: string;
4011
+ name: string;
4012
+ period: LoyaltyProgramPeriod | null;
4013
+ pointsRequired: number | null;
4014
+ tierPointMultiplier: number | null;
4015
+ translations: LoyaltyProgramTierTranslation[] | null;
4016
+ updatedAt: any | null;
4017
+ }
4018
+ export interface LoyaltyProgramTierTranslation {
4019
+ locale: string;
4020
+ name: string;
4021
+ }
4022
+ export declare enum LoyaltyProgramFilterTypeEnum {
4023
+ CATEGORY = "CATEGORY",
4024
+ DYNAMIC_CATEGORY = "DYNAMIC_CATEGORY",
4025
+ PRODUCT_AND_VARIANT = "PRODUCT_AND_VARIANT",
4026
+ PRODUCT_BRAND = "PRODUCT_BRAND",
4027
+ PRODUCT_TAG = "PRODUCT_TAG"
4028
+ }
4029
+ export declare enum LoyaltyProgramMethodSpendingTypeEnum {
4030
+ FIXED_AMOUNT = "FIXED_AMOUNT",
4031
+ FREE_PRODUCT = "FREE_PRODUCT",
4032
+ FREE_SHIPPING = "FREE_SHIPPING",
4033
+ RATIO = "RATIO"
4034
+ }
4035
+ export declare enum LoyaltyProgramOrderStatusToWinPointsEnum {
4036
+ ORDER_CREATED = "ORDER_CREATED",
4037
+ ORDER_DELIVERED = "ORDER_DELIVERED",
4038
+ PAYMENT_COMPLETED = "PAYMENT_COMPLETED"
4039
+ }
4040
+ export declare enum LoyaltyProgramPointEarningTypeEnum {
4041
+ DYNAMIC_ORDER_AMOUNT = "DYNAMIC_ORDER_AMOUNT",
4042
+ DYNAMIC_ORDER_QUANTITY = "DYNAMIC_ORDER_QUANTITY",
4043
+ STATIC = "STATIC"
4044
+ }
4045
+ export declare enum LoyaltyProgramPointHistoryTypeEnum {
4046
+ EARN = "EARN",
4047
+ SPEND = "SPEND",
4048
+ REFUND = "REFUND",
4049
+ REFILL = "REFILL"
4050
+ }
4051
+ export interface OrderLoyaltyLine {
4052
+ amount: number;
4053
+ id: string;
4054
+ loyaltyProgramCustomerId: string;
4055
+ loyaltyProgramId: string;
4056
+ loyaltyProgramSpendingMethodType: string | null;
4057
+ loyaltySpendingMethodId: string;
4058
+ }
4059
+ export declare enum EarningMethodTypeEnum {
4060
+ BUY_PRODUCT = "BUY_PRODUCT",
4061
+ CUSTOMER_REGISTER = "CUSTOMER_REGISTER",
4062
+ CUSTOMER_REVIEW = "CUSTOMER_REVIEW",
4063
+ CUSTOMER_SEGMENT = "CUSTOMER_SEGMENT",
4064
+ ENABLE_SUBSCRIPTION = "ENABLE_SUBSCRIPTION",
4065
+ ORDER_CREATE = "ORDER_CREATE"
4066
+ }
4067
+ export declare enum PeriodTypeEnum {
4068
+ MONTH = "MONTH",
4069
+ WEEK = "WEEK",
4070
+ YEAR = "YEAR"
4071
+ }
4072
+ export interface LoyaltyProgramPointHistoryTypeEnumFilterInput {
4073
+ eq?: LoyaltyProgramPointHistoryTypeEnum | null;
4074
+ in?: LoyaltyProgramPointHistoryTypeEnum[] | null;
4075
+ ne?: LoyaltyProgramPointHistoryTypeEnum | null;
4076
+ nin?: LoyaltyProgramPointHistoryTypeEnum[] | null;
4077
+ }
4078
+ export declare enum StorefrontWidgetSettingsStatusEnum {
4079
+ ACTIVE = "ACTIVE",
4080
+ PASSIVE = "PASSIVE"
4081
+ }
4082
+ export interface StorefrontWidgetSettings {
4083
+ createdAt: any | null;
4084
+ deleted: boolean;
4085
+ id: string;
4086
+ status: StorefrontWidgetSettingsStatusEnum;
4087
+ storefrontRoutings: StorefrontWidgetSettingsRouting[];
4088
+ themeSettingsJson: any | null;
4089
+ updatedAt: any | null;
4090
+ }
4091
+ export interface StorefrontWidgetSettingsRouting {
4092
+ storefrontId: string;
4093
+ storefrontRoutingId: string;
4094
+ }
4095
+ export interface StripeExpressCheckoutSessionContextResponse {
4096
+ amountTotal: number | null;
4097
+ currency: string | null;
4098
+ lineItemsJson: string | null;
4099
+ paymentStatus: string | null;
4100
+ sessionId: string;
4101
+ shippingOptionsJson: string | null;
4102
+ transactionId: string;
3639
4103
  }