@ikas/storefront-api 6.1.0-beta.21 → 6.1.0-beta.210

package/build/__api/types/index.d.ts

@@ -167,6 +167,11 @@ export declare enum CustomerEmailSubscriptionStatusesEnum {
     PENDING_CONFIRMATION = "PENDING_CONFIRMATION",
     SUBSCRIBED = "SUBSCRIBED"
 }
+export declare enum CustomerGenderTypeEnum {
+    FEMALE = "FEMALE",
+    MALE = "MALE",
+    OTHER = "OTHER"
+}
 export declare enum CustomerPriceListRuleFilterTypeEnum {
     CATEGORY = "CATEGORY",
     PRODUCT = "PRODUCT",
@@ -198,6 +203,10 @@ export declare enum GetSuggestedProductsMethodEnum {
     SAMPLING = "SAMPLING",
     VIEWED_TOGETHER = "VIEWED_TOGETHER"
 }
+export declare enum GiftCardTypeEnum {
+    GIFT_CARD = "GIFT_CARD",
+    STORE_CREDIT = "STORE_CREDIT"
+}
 export declare enum HTMLMetaDataTargetTypeEnum {
     BRAND = "BRAND",
     CATEGORY = "CATEGORY",
@@ -406,6 +415,13 @@ export declare enum ProductSearchShowStockOptionEnum {
     SHOW_ALL = "SHOW_ALL",
     SHOW_OUT_OF_STOCK_AT_END = "SHOW_OUT_OF_STOCK_AT_END"
 }
+export declare enum ProductTypeEnum {
+    BUNDLE = "BUNDLE",
+    DIGITAL = "DIGITAL",
+    MEMBERSHIP = "MEMBERSHIP",
+    PHYSICAL = "PHYSICAL",
+    SUBSCRIPTION = "SUBSCRIPTION"
+}
 export declare enum ProductUnitTypeEnum {
     CENTILITER = "CENTILITER",
     CENTIMETER = "CENTIMETER",
@@ -515,6 +531,20 @@ export declare enum StorefrontTypeEnum {
     B2B_STOREFRONT = "B2B_STOREFRONT",
     STOREFRONT = "STOREFRONT"
 }
+export declare enum SubscriptionPlanDurationUnitTypeEnum {
+    DAY = "DAY",
+    MONTH = "MONTH",
+    WEEK = "WEEK",
+    YEAR = "YEAR"
+}
+export declare enum SubscriptionPlanPaymentTypeEnum {
+    POST_PAID = "POST_PAID",
+    PRE_PAID = "PRE_PAID"
+}
+export declare enum SubscriptionPlanStatusEnum {
+    ACTIVE = "ACTIVE",
+    PASSIVE = "PASSIVE"
+}
 export declare enum TemplateEnum {
     ABANDONED_CHECKOUT = "ABANDONED_CHECKOUT",
     CONTACT_FORM_MERCHANT = "CONTACT_FORM_MERCHANT",
@@ -764,6 +794,11 @@ export interface BuyXThenGetY {
     getY: GetY;
     maxUsagePerOrder: number | null;
 }
+export interface HepsipayFrameInitResponse {
+    frameToken: string | null;
+    frameUrl: string | null;
+    transactionId: string;
+}
 export interface Campaign {
     applicableCustomerGroupIds: string[] | null;
     applicableCustomerIds: string[] | null;
@@ -928,6 +963,7 @@ export interface CartV2 {
     customerId: string | null;
     deleted: boolean | null;
     dueDate: any | null;
+    edited: boolean | null;
     giftCardLines: OrderGiftCardLine[] | null;
     giftPackageLines: OrderGiftPackageLine[] | null;
     giftPackageNote: string | null;
@@ -1088,6 +1124,7 @@ export interface CheckoutSettings {
     options: CheckoutOption[] | null;
     phoneRequirement: CheckoutRequirementEnum;
     postalCodeRequirement: CheckoutRequirementEnum | null;
+    showBillingAddressOnShippingStep: boolean | null;
     showCheckoutNote: boolean | null;
     showCompanyInfoInShippingAddress: boolean | null;
     showTermsAndConditionsCheckbox: boolean;
@@ -1335,6 +1372,13 @@ export interface CustomerFavoriteProduct {
     productId: string;
     updatedAt: any | null;
 }
+export interface CustomerLoginResponse {
+    customer: Customer | null;
+    flowId: string | null;
+    otpSend: boolean | null;
+    token: string;
+    tokenExpiry: number;
+}
 export interface CustomerPriceListRule {
     filters: CustomerPriceListRuleFilter[] | null;
     shouldMatchAllFilters: boolean | null;
@@ -1345,11 +1389,6 @@ export interface CustomerPriceListRuleFilter {
     type: CustomerPriceListRuleFilterTypeEnum;
     valueList: string[];
 }
-export interface CustomerLoginResponse {
-    customer: Customer | null;
-    token: string;
-    tokenExpiry: number;
-}
 export interface CustomerRefreshTokenResponse {
     token: string;
     tokenExpiry: number;
@@ -1358,16 +1397,20 @@ export interface CustomerReview {
     comment: string | null;
     createdAt: any | null;
     customerId: string | null;
-    deleted: boolean | null;
+    deleted: boolean;
     email: string | null;
     firstName: string | null;
     id: string;
     imageIds: string[] | null;
+    isPrivateReply: boolean | null;
     lastName: string | null;
+    locale: string | null;
     orderId: string | null;
     orderNumber: string | null;
+    product: CustomerReviewProductModel | null;
     productId: string;
     reply: string | null;
+    replyInfo: CustomerReviewReplyInfo | null;
     salesChannelId: string | null;
     star: number;
     status: CustomerReviewStatusEnum | null;
@@ -1375,6 +1418,18 @@ export interface CustomerReview {
     title: string | null;
     updatedAt: any | null;
 }
+export interface CustomerReviewProductModel {
+    brandId: string | null;
+    categoryIds: string[] | null;
+    id: string | null;
+    tagIds: string | null;
+    type: ProductTypeEnum | null;
+    vendorId: string | null;
+}
+export interface CustomerReviewReplyInfo {
+    createdAt: any | null;
+    staffId: string | null;
+}
 export interface CustomerReviewSFPaginationResponse {
     count: number;
     data: CustomerReview[];
@@ -1385,7 +1440,7 @@ export interface CustomerReviewSFPaginationResponse {
 export interface CustomerReviewSummary {
     averageStar: number;
     createdAt: any | null;
-    deleted: boolean | null;
+    deleted: boolean;
     id: string;
     productId: string;
     stars: CustomerReviewSummaryStar[];
@@ -1468,6 +1523,11 @@ export interface GetAvailableStockLocationAddressCountry {
 export interface GetAvailableStockLocationsResponse {
     stockLocations: GetAvailableStockLocation[];
 }
+export interface GetCustomerReviewImageUploadUrlResponse {
+    fields: any;
+    imageId: string;
+    uploadUrl: string;
+}
 export interface GetPaypalClientIdResponse {
     clientId: string;
     merchantClientId: string | null;
@@ -1496,6 +1556,28 @@ export interface GetY {
     discountRatio: number;
     filter: CampaignFilter;
 }
+export interface GiftCard {
+    active: boolean;
+    amount: number;
+    code: string;
+    createdAt: any | null;
+    customerId: string | null;
+    deleted: boolean;
+    endDate: any | null;
+    id: string;
+    minimumRequiredCartAmount: number | null;
+    salesChannels: GiftCardSalesChannel[] | null;
+    startDate: any | null;
+    type: GiftCardTypeEnum;
+    updatedAt: any | null;
+    usedAllAmount: boolean | null;
+    usedAmount: number;
+}
+export interface GiftCardSalesChannel {
+    salesChannelId: string;
+    storefrontId: string | null;
+    storefrontRoutingId: string | null;
+}
 export interface HTMLMetaData {
     canonicals: string[] | null;
     createdAt: any | null;
@@ -1556,6 +1638,7 @@ export interface ListOrderTransactionWithPricesRefundableTransaction {
 export interface ListOrderTransactionWithPricesResponse {
     chargedAmount: number;
     orderFinalPrice: number;
+    pendingAmount: number;
     refundableTransactions: ListOrderTransactionWithPricesRefundableTransaction[];
     refundedAmount: number;
     remainingBalance: number;
@@ -1726,6 +1809,7 @@ export interface OrderGiftCardLine {
     code: string;
     giftCardId: string;
     id: string;
+    type: GiftCardTypeEnum | null;
 }
 export interface OrderGiftPackageLine {
     price: number;
@@ -1783,11 +1867,31 @@ export interface OrderLineItem {
     status: OrderLineItemStatusEnum;
     statusUpdatedAt: any | null;
     stockLocationId: string | null;
+    subscriptionPlan: OrderLineItemSubscriptionPlan | null;
     taxValue: number | null;
     unitPrice: number | null;
     updatedAt: any | null;
     variant: OrderLineVariant;
 }
+export interface OrderLineItemCustomerSubscriptionPlan {
+    id: string;
+}
+export interface OrderLineItemSubscriptionPlan {
+    id: string;
+    name: string;
+    period: OrderLineItemSubscriptionPlanPeriod;
+}
+export interface OrderLineItemSubscriptionPlanPeriod {
+    cutOffDay: number | null;
+    discount: SubscriptionPlanDiscount | null;
+    durationUnit: SubscriptionPlanDurationUnitTypeEnum;
+    durationValue: number;
+    id: string;
+    maxOrders: number | null;
+    paymentType: SubscriptionPlanPaymentTypeEnum;
+    scheduledOrderDay: number | null;
+    title: string;
+}
 export interface OrderLineOption {
     name: string;
     productOptionId: string;
@@ -2233,6 +2337,7 @@ export interface ProductSearchResponse {
     limit: number;
     page: number;
     results: SearchProduct[];
+    suggestions: SearchSuggestion[] | null;
     totalCount: number;
 }
 export interface ProductTagTranslation {
@@ -2544,6 +2649,29 @@ export interface SearchProductStockLocation {
     stockCount: number;
     stockLocationId: string;
 }
+export interface SearchProductSubscriptionPlan {
+    name: string;
+    periods: SearchProductSubscriptionPlanPeriod[];
+    status: SubscriptionPlanStatusEnum;
+    subscriptionPlanId: string;
+    translations: SubscriptionPlanTranslation[] | null;
+}
+export interface SearchProductSubscriptionPlanDiscount {
+    amount: number;
+    type: OrderAmountTypeEnum;
+}
+export interface SearchProductSubscriptionPlanPeriod {
+    cutOffDay: number | null;
+    discount: SearchProductSubscriptionPlanDiscount | null;
+    durationUnit: SubscriptionPlanDurationUnitTypeEnum;
+    durationValue: number;
+    id: string;
+    maxOrders: number | null;
+    paymentType: SubscriptionPlanPaymentTypeEnum;
+    scheduledOrderDay: number | null;
+    status: SubscriptionPlanStatusEnum;
+    title: string;
+}
 export interface SearchProductTag {
     id: string;
     name: string;
@@ -2554,6 +2682,12 @@ export interface SearchProductVariantType {
     variantType: SearchVariantType;
     variantValueIds: string[];
 }
+export interface SearchSuggestion {
+    brandId: string | null;
+    categoryId: string | null;
+    id: string;
+    term: string;
+}
 export interface SearchVariant {
     attributes: SearchProductAttributeValue[] | null;
     barcodeList: string[] | null;
@@ -2567,6 +2701,7 @@ export interface SearchVariant {
     sellIfOutOfStock: boolean | null;
     sku: string | null;
     stocks: SearchProductStockLocation[] | null;
+    subscriptionPlan: SearchProductSubscriptionPlan | null;
     unit: VariantUnitModel | null;
     variantValues: SearchVariationValueRelation[] | null;
     weight: number | null;
@@ -2650,6 +2785,10 @@ export interface StockLocationAddressState {
     id: string | null;
     name: string | null;
 }
+export interface StoreCreditBalanceResponse {
+    amount: number;
+    storeCredits: GiftCard[];
+}
 export interface Storefront {
     analytics4Id: string | null;
     createdAt: any | null;
@@ -2890,6 +3029,15 @@ export interface StorefrontTransaction {
     type: TransactionTypeEnum;
     updatedAt: any | null;
 }
+export interface SubscriptionPlanDiscount {
+    amount: number;
+    type: OrderAmountTypeEnum;
+}
+export interface SubscriptionPlanTranslation {
+    description: string | null;
+    locale: string;
+    title: string;
+}
 export interface Town {
     createdAt: any | null;
     deleted: boolean | null;
@@ -3066,6 +3214,8 @@ export interface AddItemToCartInput {
     priceListId?: string | null;
     salesChannelId: string;
     storefrontThemeId: string;
+    subscriptionPlanId?: string | null;
+    subscriptionPlanPeriodId?: string | null;
 }
 export interface AppliedProductInput {
     productId?: string | null;
@@ -3216,6 +3366,16 @@ export interface CustomerAttributeValueInput {
     customerAttributeOptionId?: string | null;
     value?: string | null;
 }
+export interface CustomerRegisterSubscriptionInput {
+    email: boolean;
+    phone: boolean;
+    sms: boolean;
+}
+export interface CustomerAttributeValueInput {
+    customerAttributeId?: string | null;
+    customerAttributeOptionId?: string | null;
+    value?: string | null;
+}
 export interface DateFilterInput {
     eq?: any | null;
     gt?: any | null;
@@ -3460,10 +3620,12 @@ export interface SearchDynamicCurrencySettings {
 }
 export interface SearchInput {
     barcodeList?: string[] | null;
+    baseCategoryIdList?: string[] | null;
     brandId?: string | null;
     brandIdList?: string[] | null;
     categoryIdList?: string[] | null;
     dynamicCurrencySettings?: SearchDynamicCurrencySettings | null;
+    enableSuggestions?: boolean | null;
     facetList?: SearchInputFacetListInput[] | null;
     filterList?: SearchInputFilterListInput[] | null;
     locale?: string | null;
@@ -3521,6 +3683,26 @@ export interface UpdateCartCampaignOfferInput {
     quantity?: number | null;
     variantId: string;
 }
+export interface UpdatePaypalOrderAddressInput {
+    city?: string | null;
+    country?: string | null;
+    postalCode?: string | null;
+    state?: string | null;
+}
+export interface UpdatePaypalOrderCustomerInput {
+    email?: string | null;
+    firstName?: string | null;
+    id?: string | null;
+    lastName?: string | null;
+}
+export interface UpdatePaypalOrderInput {
+    address?: UpdatePaypalOrderAddressInput | null;
+    cartId: string;
+    customer?: UpdatePaypalOrderCustomerInput | null;
+    shippingSettingsId?: string | null;
+    shippingZoneRateId?: string | null;
+    transactionId: string;
+}
 export declare enum StorefrontPopupDeviceTypeEnum {
     ALL = "ALL",
     DESKTOP = "DESKTOP",
@@ -3632,8 +3814,209 @@ export interface SaveCustomerFormDataInput {
     storefrontPopupId?: string | null;
     subscriptions?: CustomerRegisterSubscriptionInput | null;
 }
-export declare enum CustomerGenderTypeEnum {
-    FEMALE = "FEMALE",
-    MALE = "MALE",
-    OTHER = "OTHER"
+export interface AddLoyaltyToCartInput {
+    amount?: number | null;
+    cartId: string;
+    loyaltyProgramId: string;
+    loyaltySpendingMethodId: string;
+}
+export interface LoyaltyCustomerInfo {
+    customerTierId: LoyaltyProgramTier | null;
+    loyaltyProgramCustomerId: string;
+    loyaltyProgramId: string;
+    totalPoint: number;
+}
+export interface LoyaltyProgram {
+    createdAt: any | null;
+    deleted: boolean;
+    earningMethods: LoyaltyProgramEarningMethod[] | null;
+    id: string;
+    isPassive: boolean | null;
+    name: string;
+    orderStatusToWinPoints: LoyaltyProgramOrderStatusToWinPointsEnum;
+    previousOrderStartDate: any | null;
+    refillPointsOnRefund: boolean;
+    salesChannels: LoyaltyProgramSaleChannel[] | null;
+    spendingMethods: LoyaltyProgramSpendingMethod[] | null;
+    tiers: LoyaltyProgramTier[] | null;
+    tokenName: string | null;
+    updatedAt: any | null;
+    validityPeriod: LoyaltyProgramPeriod | null;
+}
+export interface LoyaltyProgramDiscountSettings {
+    discountAmount: number | null;
+    freeProductId: string | null;
+    point: number;
+}
+export interface LoyaltyProgramEarningMethod {
+    amountPerPointsEarned: number | null;
+    createdAt: any | null;
+    deleted: boolean;
+    description: string | null;
+    earnedPointLimit: LoyaltyProgramPointLimit | null;
+    id: string;
+    isActive: boolean;
+    lastValidityDate: any | null;
+    loyaltyProgramId: string;
+    methodType: EarningMethodTypeEnum;
+    orderSettings: LoyaltyProgramEarningMethodOrderSettings | null;
+    pointEarningType: LoyaltyProgramPointEarningTypeEnum;
+    pointsEarned: number;
+    productSettings: LoyaltyProgramEarningMethodProductSettings | null;
+    quantityPerPointsEarned: number | null;
+    segmentId: string | null;
+    tierIds: string[] | null;
+    translations: LoyaltyProgramMethodTranslation[] | null;
+    updatedAt: any | null;
+    validityPeriod: LoyaltyProgramPeriod | null;
+}
+export interface LoyaltyProgramEarningMethodOrderSettings {
+    maxOrderAmount: number | null;
+    minOrderAmount: number;
+    productFilters: LoyaltyProgramFilter[] | null;
+}
+export interface LoyaltyProgramEarningMethodProductSettings {
+    maxProductQuantity: number | null;
+    minProductQuantity: number | null;
+    productFilters: LoyaltyProgramFilter[] | null;
+}
+export interface LoyaltyProgramFilter {
+    idList: string[];
+    type: LoyaltyProgramFilterTypeEnum;
+}
+export interface LoyaltyProgramMethodTranslation {
+    description: string;
+    locale: string;
+}
+export interface LoyaltyProgramPeriod {
+    period: string | null;
+    periodType: PeriodTypeEnum | null;
+}
+export interface LoyaltyProgramPointHistory {
+    amount: number;
+    createdAt: any | null;
+    customerId: string;
+    deleted: boolean;
+    expireDate: any | null;
+    id: string;
+    loyaltyProgramCustomerId: string;
+    loyaltyProgramEarningMethodId: string | null;
+    loyaltyProgramId: string;
+    loyaltyProgramSpendingMethodId: string | null;
+    orderId: string | null;
+    type: LoyaltyProgramPointHistoryTypeEnum;
+    updatedAt: any | null;
+}
+export interface LoyaltyProgramPointLimit {
+    maxPointLimit: number | null;
+    minPointLimit: number | null;
+}
+export interface LoyaltyProgramSaleChannel {
+    routingIds: string[] | null;
+    salesChannelId: string;
+    storefrontId: string | null;
+}
+export interface LoyaltyProgramSpendingMethod {
+    createdAt: any | null;
+    deleted: boolean;
+    description: string | null;
+    discountSettings: LoyaltyProgramDiscountSettings | null;
+    id: string;
+    isActive: boolean;
+    isAvailable: boolean | null;
+    isDynamic: boolean;
+    loyaltyProgramId: string;
+    pointUsageLimit: LoyaltyProgramPointLimit | null;
+    productFilters: LoyaltyProgramFilter[] | null;
+    translations: LoyaltyProgramMethodTranslation[] | null;
+    type: LoyaltyProgramMethodSpendingTypeEnum;
+    updatedAt: any | null;
+}
+export interface LoyaltyProgramTier {
+    createdAt: any | null;
+    customerSegmentId: string | null;
+    deleted: boolean;
+    id: string;
+    isActive: boolean;
+    loyaltyProgramId: string;
+    name: string;
+    period: LoyaltyProgramPeriod | null;
+    pointsRequired: number | null;
+    tierPointMultiplier: number | null;
+    translations: LoyaltyProgramTierTranslation[] | null;
+    updatedAt: any | null;
+}
+export interface LoyaltyProgramTierTranslation {
+    locale: string;
+    name: string;
+}
+export declare enum LoyaltyProgramFilterTypeEnum {
+    CATEGORY = "CATEGORY",
+    DYNAMIC_CATEGORY = "DYNAMIC_CATEGORY",
+    PRODUCT_AND_VARIANT = "PRODUCT_AND_VARIANT",
+    PRODUCT_BRAND = "PRODUCT_BRAND",
+    PRODUCT_TAG = "PRODUCT_TAG"
+}
+export declare enum LoyaltyProgramMethodSpendingTypeEnum {
+    FIXED_AMOUNT = "FIXED_AMOUNT",
+    FREE_PRODUCT = "FREE_PRODUCT",
+    FREE_SHIPPING = "FREE_SHIPPING",
+    RATIO = "RATIO"
+}
+export declare enum LoyaltyProgramOrderStatusToWinPointsEnum {
+    ORDER_CREATED = "ORDER_CREATED",
+    ORDER_DELIVERED = "ORDER_DELIVERED",
+    PAYMENT_COMPLETED = "PAYMENT_COMPLETED"
+}
+export declare enum LoyaltyProgramPointEarningTypeEnum {
+    DYNAMIC_ORDER_AMOUNT = "DYNAMIC_ORDER_AMOUNT",
+    DYNAMIC_ORDER_QUANTITY = "DYNAMIC_ORDER_QUANTITY",
+    STATIC = "STATIC"
+}
+export declare enum LoyaltyProgramPointHistoryTypeEnum {
+    EARN = "EARN",
+    SPEND = "SPEND"
+}
+export interface OrderLoyaltyLine {
+    amount: number;
+    id: string;
+    loyaltyProgramCustomerId: string;
+    loyaltyProgramId: string;
+    loyaltySpendingMethodId: string;
+}
+export declare enum EarningMethodTypeEnum {
+    BUY_PRODUCT = "BUY_PRODUCT",
+    CUSTOMER_REGISTER = "CUSTOMER_REGISTER",
+    CUSTOMER_REVIEW = "CUSTOMER_REVIEW",
+    CUSTOMER_SEGMENT = "CUSTOMER_SEGMENT",
+    ENABLE_SUBSCRIPTION = "ENABLE_SUBSCRIPTION",
+    ORDER_CREATE = "ORDER_CREATE"
+}
+export declare enum PeriodTypeEnum {
+    MONTH = "MONTH",
+    WEEK = "WEEK",
+    YEAR = "YEAR"
+}
+export interface LoyaltyProgramPointHistoryTypeEnumFilterInput {
+    eq?: LoyaltyProgramPointHistoryTypeEnum | null;
+    in?: LoyaltyProgramPointHistoryTypeEnum[] | null;
+    ne?: LoyaltyProgramPointHistoryTypeEnum | null;
+    nin?: LoyaltyProgramPointHistoryTypeEnum[] | null;
+}
+export declare enum StorefrontWidgetSettingsStatusEnum {
+    ACTIVE = "ACTIVE",
+    PASSIVE = "PASSIVE"
+}
+export interface StorefrontWidgetSettings {
+    createdAt: any | null;
+    deleted: boolean;
+    id: string;
+    status: StorefrontWidgetSettingsStatusEnum;
+    storefrontRoutings: StorefrontWidgetSettingsRouting[];
+    themeSettingsJson: any | null;
+    updatedAt: any | null;
+}
+export interface StorefrontWidgetSettingsRouting {
+    storefrontId: string;
+    storefrontRoutingId: string;
 }