@wix/ecom 1.0.744 → 1.0.746

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.
@@ -373,6 +373,11 @@ interface GetShippingRatesRequest {
373
373
  deliveryPreferences?: DeliveryPreferences;
374
374
  /** Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order. */
375
375
  purchaseFlowId?: string | null;
376
+ /**
377
+ * Reference to an external resource ID. Used to link the purchase flow to a specific entity in an external system.
378
+ * Used for integration and tracking across different platforms.
379
+ */
380
+ externalReferences?: ExternalReference$2[];
376
381
  }
377
382
  interface ProductItem {
378
383
  /** Item name. */
@@ -540,11 +545,23 @@ declare enum WeightUnit$2 {
540
545
  interface DeliveryPreferences {
541
546
  preferredCode?: string | null;
542
547
  }
548
+ interface ExternalReference$2 {
549
+ /**
550
+ * ID of the app associated with the purchase flow.
551
+ * For example, the Wix Pay Links app ID.
552
+ */
553
+ appId?: string;
554
+ /**
555
+ * Reference to an external resource ID. Used to link the purchase flow to a specific entity in an external system.
556
+ * For example, a Wix Pay Link ID.
557
+ */
558
+ resourceId?: string | null;
559
+ }
543
560
  interface GetShippingRatesResponse {
544
561
  /** Available shipping rates. These define the shipping rate options that are displayed to site visitors on the cart and checkout pages. */
545
- shippingRates?: ShippingOption[];
562
+ shippingRates?: ShippingOption$1[];
546
563
  }
547
- interface ShippingOption {
564
+ interface ShippingOption$1 {
548
565
  /** Unique code that acts as an ID for a shipping rate. For example, `"usps_std_overnight"`. */
549
566
  code?: string;
550
567
  /** Shipping rate title. For example, `"USPS Standard Overnight Delivery"`, `"Standard"`, or `"First-Class Package International"`. */
@@ -595,13 +612,13 @@ interface ShippingPrice$1 {
595
612
  }
596
613
  interface AdditionalCharge {
597
614
  /** Additional charge type. */
598
- type?: ChargeType$1;
615
+ type?: ChargeType$2;
599
616
  /** Details of the additional charge. For example, `"Handling fee of $5 applied for gift wrapping"`. */
600
617
  details?: string | null;
601
618
  /** Cost of additional charge. For example, `12.5`. */
602
619
  price?: string;
603
620
  }
604
- declare enum ChargeType$1 {
621
+ declare enum ChargeType$2 {
605
622
  HANDLING_FEE = "HANDLING_FEE"
606
623
  }
607
624
  interface PartialOption {
@@ -609,9 +626,9 @@ interface PartialOption {
609
626
  lineItemIds?: string[];
610
627
  }
611
628
  interface MissingPostalCodeError {
612
- error?: ApplicationError;
629
+ error?: ApplicationError$1;
613
630
  }
614
- interface ApplicationError {
631
+ interface ApplicationError$1 {
615
632
  /** Error code. */
616
633
  code?: string;
617
634
  /** Description of the error. */
@@ -620,20 +637,20 @@ interface ApplicationError {
620
637
  data?: Record<string, any> | null;
621
638
  }
622
639
  interface InvalidPostalCodeError {
623
- error?: ApplicationError;
640
+ error?: ApplicationError$1;
624
641
  }
625
642
  interface InvalidAddressError {
626
- fields?: FieldViolation[];
643
+ fields?: FieldViolation$1[];
627
644
  }
628
- interface FieldViolation {
645
+ interface FieldViolation$1 {
629
646
  field?: string;
630
647
  description?: string;
631
- violatedRule?: RuleType;
648
+ violatedRule?: RuleType$1;
632
649
  /** applicable when violated_rule=OTHER */
633
650
  ruleName?: string | null;
634
651
  data?: Record<string, any> | null;
635
652
  }
636
- declare enum RuleType {
653
+ declare enum RuleType$1 {
637
654
  VALIDATION = "VALIDATION",
638
655
  OTHER = "OTHER",
639
656
  MAX = "MAX",
@@ -654,7 +671,7 @@ declare enum RuleType {
654
671
  ONE_OF_ALIGNMENT = "ONE_OF_ALIGNMENT"
655
672
  }
656
673
  interface GenericShippingRatesError {
657
- errors?: ApplicationError[];
674
+ errors?: ApplicationError$1[];
658
675
  }
659
676
  interface GetDashboardTablesRequest {
660
677
  /** Delivery profile id. */
@@ -894,11 +911,9 @@ declare const provideHandlers$a: ReturnType<typeof createServicePluginModule$5<_
894
911
 
895
912
  type context$5_AdditionalCharge = AdditionalCharge;
896
913
  type context$5_AddressStreetOneOf = AddressStreetOneOf;
897
- type context$5_ApplicationError = ApplicationError;
898
914
  type context$5_Column = Column;
899
915
  type context$5_DashboardTable = DashboardTable;
900
916
  type context$5_DeliveryPreferences = DeliveryPreferences;
901
- type context$5_FieldViolation = FieldViolation;
902
917
  type context$5_GenericShippingRatesError = GenericShippingRatesError;
903
918
  type context$5_GenericShippingRatesWixError = GenericShippingRatesWixError;
904
919
  declare const context$5_GenericShippingRatesWixError: typeof GenericShippingRatesWixError;
@@ -919,16 +934,13 @@ type context$5_PartialOption = PartialOption;
919
934
  type context$5_ProductItem = ProductItem;
920
935
  type context$5_RegionDashboardTables = RegionDashboardTables;
921
936
  type context$5_Row = Row;
922
- type context$5_RuleType = RuleType;
923
- declare const context$5_RuleType: typeof RuleType;
924
- type context$5_ShippingOption = ShippingOption;
925
937
  type context$5_ShippingRatesConfig = ShippingRatesConfig;
926
938
  type context$5_StandardDetails = StandardDetails;
927
939
  type context$5_Subdivision = Subdivision;
928
940
  type context$5_SubdivisionType = SubdivisionType;
929
941
  declare const context$5_SubdivisionType: typeof SubdivisionType;
930
942
  declare namespace context$5 {
931
- export { type context$5_AdditionalCharge as AdditionalCharge, type Address$3 as Address, type AddressLocation$3 as AddressLocation, type context$5_AddressStreetOneOf as AddressStreetOneOf, type context$5_ApplicationError as ApplicationError, type CatalogReference$5 as CatalogReference, ChargeType$1 as ChargeType, type context$5_Column as Column, type Context$5 as Context, type context$5_DashboardTable as DashboardTable, type DeliveryLogistics$2 as DeliveryLogistics, type context$5_DeliveryPreferences as DeliveryPreferences, type DeliveryTimeSlot$1 as DeliveryTimeSlot, type context$5_FieldViolation as FieldViolation, type FullAddressContactDetails$3 as FullAddressContactDetails, type context$5_GenericShippingRatesError as GenericShippingRatesError, context$5_GenericShippingRatesWixError as GenericShippingRatesWixError, type context$5_GetDashboardTablesRequest as GetDashboardTablesRequest, type context$5_GetDashboardTablesResponse as GetDashboardTablesResponse, type context$5_GetShippingRatesRequest as GetShippingRatesRequest, type context$5_GetShippingRatesResponse as GetShippingRatesResponse, type IdentificationData$5 as IdentificationData, type IdentificationDataIdOneOf$5 as IdentificationDataIdOneOf, IdentityType$5 as IdentityType, type context$5_InvalidAddressError as InvalidAddressError, context$5_InvalidAddressWixError as InvalidAddressWixError, type context$5_InvalidPostalCodeError as InvalidPostalCodeError, context$5_InvalidPostalCodeWixError as InvalidPostalCodeWixError, type context$5_MissingPostalCodeError as MissingPostalCodeError, context$5_MissingPostalCodeWixError as MissingPostalCodeWixError, type context$5_PartialOption as PartialOption, type PhysicalProperties$3 as PhysicalProperties, type PickupDetails$2 as PickupDetails, PickupMethod$2 as PickupMethod, type context$5_ProductItem as ProductItem, type context$5_RegionDashboardTables as RegionDashboardTables, type context$5_Row as Row, context$5_RuleType as RuleType, type context$5_ShippingOption as ShippingOption, type ShippingPrice$1 as ShippingPrice, type context$5_ShippingRatesConfig as ShippingRatesConfig, type context$5_StandardDetails as StandardDetails, type StreetAddress$3 as StreetAddress, type context$5_Subdivision as Subdivision, context$5_SubdivisionType as SubdivisionType, type VatId$3 as VatId, VatType$3 as VatType, WeightUnit$2 as WeightUnit, type _publicProvideHandlersType$5 as _publicProvideHandlersType, provideHandlers$a as provideHandlers, provideHandlers$b as publicProvideHandlers };
943
+ export { type context$5_AdditionalCharge as AdditionalCharge, type Address$3 as Address, type AddressLocation$3 as AddressLocation, type context$5_AddressStreetOneOf as AddressStreetOneOf, type ApplicationError$1 as ApplicationError, type CatalogReference$5 as CatalogReference, ChargeType$2 as ChargeType, type context$5_Column as Column, type Context$5 as Context, type context$5_DashboardTable as DashboardTable, type DeliveryLogistics$2 as DeliveryLogistics, type context$5_DeliveryPreferences as DeliveryPreferences, type DeliveryTimeSlot$1 as DeliveryTimeSlot, type ExternalReference$2 as ExternalReference, type FieldViolation$1 as FieldViolation, type FullAddressContactDetails$3 as FullAddressContactDetails, type context$5_GenericShippingRatesError as GenericShippingRatesError, context$5_GenericShippingRatesWixError as GenericShippingRatesWixError, type context$5_GetDashboardTablesRequest as GetDashboardTablesRequest, type context$5_GetDashboardTablesResponse as GetDashboardTablesResponse, type context$5_GetShippingRatesRequest as GetShippingRatesRequest, type context$5_GetShippingRatesResponse as GetShippingRatesResponse, type IdentificationData$5 as IdentificationData, type IdentificationDataIdOneOf$5 as IdentificationDataIdOneOf, IdentityType$5 as IdentityType, type context$5_InvalidAddressError as InvalidAddressError, context$5_InvalidAddressWixError as InvalidAddressWixError, type context$5_InvalidPostalCodeError as InvalidPostalCodeError, context$5_InvalidPostalCodeWixError as InvalidPostalCodeWixError, type context$5_MissingPostalCodeError as MissingPostalCodeError, context$5_MissingPostalCodeWixError as MissingPostalCodeWixError, type context$5_PartialOption as PartialOption, type PhysicalProperties$3 as PhysicalProperties, type PickupDetails$2 as PickupDetails, PickupMethod$2 as PickupMethod, type context$5_ProductItem as ProductItem, type context$5_RegionDashboardTables as RegionDashboardTables, type context$5_Row as Row, RuleType$1 as RuleType, type ShippingOption$1 as ShippingOption, type ShippingPrice$1 as ShippingPrice, type context$5_ShippingRatesConfig as ShippingRatesConfig, type context$5_StandardDetails as StandardDetails, type StreetAddress$3 as StreetAddress, type context$5_Subdivision as Subdivision, context$5_SubdivisionType as SubdivisionType, type VatId$3 as VatId, VatType$3 as VatType, WeightUnit$2 as WeightUnit, type _publicProvideHandlersType$5 as _publicProvideHandlersType, provideHandlers$a as provideHandlers, provideHandlers$b as publicProvideHandlers };
932
944
  }
933
945
 
934
946
  interface CalculateAdditionalFeesRequest {
@@ -937,7 +949,7 @@ interface CalculateAdditionalFeesRequest {
937
949
  *
938
950
  * Max: 300 items
939
951
  */
940
- lineItems?: LineItem$3[];
952
+ lineItems?: LineItem$4[];
941
953
  /** Shipping address. */
942
954
  shippingAddress?: Address$2;
943
955
  /** Information about the buyer, such as contact details. */
@@ -949,7 +961,7 @@ interface CalculateAdditionalFeesRequest {
949
961
  /** Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order. */
950
962
  purchaseFlowId?: string | null;
951
963
  }
952
- interface LineItem$3 {
964
+ interface LineItem$4 {
953
965
  /** Line item ID. */
954
966
  _id?: string;
955
967
  /**
@@ -1125,9 +1137,9 @@ interface DiscountRuleName$2 {
1125
1137
  }
1126
1138
  interface ShippingInformation$1 {
1127
1139
  /** Selected carrier shipping option. */
1128
- selectedCarrierServiceOption?: SelectedCarrierServiceOption$1;
1140
+ selectedCarrierServiceOption?: SelectedCarrierServiceOption$2;
1129
1141
  }
1130
- interface SelectedCarrierServiceOption$1 {
1142
+ interface SelectedCarrierServiceOption$2 {
1131
1143
  /** Unique identifier of selected option. For example, `"usps_std_overnight"`. */
1132
1144
  code?: string;
1133
1145
  /**
@@ -1145,9 +1157,9 @@ interface SelectedCarrierServiceOption$1 {
1145
1157
  * Shipping costs.
1146
1158
  * @readonly
1147
1159
  */
1148
- cost?: SelectedCarrierServiceOptionPrices$1;
1160
+ cost?: SelectedCarrierServiceOptionPrices$2;
1149
1161
  /** Other charges. */
1150
- otherCharges?: SelectedCarrierServiceOptionOtherCharge[];
1162
+ otherCharges?: SelectedCarrierServiceOptionOtherCharge$1[];
1151
1163
  }
1152
1164
  interface DeliveryLogistics$1 {
1153
1165
  /** Expected delivery time. For example, "3-5 business days". */
@@ -1173,15 +1185,15 @@ declare enum PickupMethod$1 {
1173
1185
  STORE_PICKUP = "STORE_PICKUP",
1174
1186
  PICKUP_POINT = "PICKUP_POINT"
1175
1187
  }
1176
- interface SelectedCarrierServiceOptionPrices$1 {
1188
+ interface SelectedCarrierServiceOptionPrices$2 {
1177
1189
  /** Price. */
1178
1190
  price?: string;
1179
1191
  /** Total shipping discount. */
1180
1192
  totalDiscount?: string | null;
1181
1193
  }
1182
- interface SelectedCarrierServiceOptionOtherCharge {
1194
+ interface SelectedCarrierServiceOptionOtherCharge$1 {
1183
1195
  /** Type of charge. */
1184
- type?: ChargeType;
1196
+ type?: ChargeType$1;
1185
1197
  /**
1186
1198
  * Details of the charge.
1187
1199
  *
@@ -1193,9 +1205,9 @@ interface SelectedCarrierServiceOptionOtherCharge {
1193
1205
  *
1194
1206
  * `cost` is `price` minus `totalDiscount`.
1195
1207
  */
1196
- cost?: SelectedCarrierServiceOptionPrices$1;
1208
+ cost?: SelectedCarrierServiceOptionPrices$2;
1197
1209
  }
1198
- declare enum ChargeType {
1210
+ declare enum ChargeType$1 {
1199
1211
  HANDLING_FEE = "HANDLING_FEE",
1200
1212
  INSURANCE = "INSURANCE"
1201
1213
  }
@@ -1333,12 +1345,9 @@ declare const provideHandlers$8: ReturnType<typeof createServicePluginModule$4<_
1333
1345
  type context$4_AdditionalFeesSPIConfig = AdditionalFeesSPIConfig;
1334
1346
  type context$4_CalculateAdditionalFeesRequest = CalculateAdditionalFeesRequest;
1335
1347
  type context$4_CalculateAdditionalFeesResponse = CalculateAdditionalFeesResponse;
1336
- type context$4_ChargeType = ChargeType;
1337
- declare const context$4_ChargeType: typeof ChargeType;
1338
- type context$4_SelectedCarrierServiceOptionOtherCharge = SelectedCarrierServiceOptionOtherCharge;
1339
1348
  type context$4_TaxDetails = TaxDetails;
1340
1349
  declare namespace context$4 {
1341
- export { type AdditionalFee$1 as AdditionalFee, type context$4_AdditionalFeesSPIConfig as AdditionalFeesSPIConfig, type Address$2 as Address, type AddressLocation$2 as AddressLocation, type AppliedDiscount$2 as AppliedDiscount, type AppliedDiscountDiscountSourceOneOf$2 as AppliedDiscountDiscountSourceOneOf, type BuyerDetails$1 as BuyerDetails, type context$4_CalculateAdditionalFeesRequest as CalculateAdditionalFeesRequest, type context$4_CalculateAdditionalFeesResponse as CalculateAdditionalFeesResponse, type CatalogReference$4 as CatalogReference, context$4_ChargeType as ChargeType, type Context$4 as Context, type Coupon$2 as Coupon, type DeliveryLogistics$1 as DeliveryLogistics, type DiscountRule$2 as DiscountRule, type DiscountRuleName$2 as DiscountRuleName, DiscountType$2 as DiscountType, type FullAddressContactDetails$2 as FullAddressContactDetails, type IdentificationData$4 as IdentificationData, type IdentificationDataIdOneOf$4 as IdentificationDataIdOneOf, IdentityType$4 as IdentityType, type LineItem$3 as LineItem, type MerchantDiscount$2 as MerchantDiscount, type PhysicalProperties$2 as PhysicalProperties, type PickupDetails$1 as PickupDetails, PickupMethod$1 as PickupMethod, type SelectedCarrierServiceOption$1 as SelectedCarrierServiceOption, type context$4_SelectedCarrierServiceOptionOtherCharge as SelectedCarrierServiceOptionOtherCharge, type SelectedCarrierServiceOptionPrices$1 as SelectedCarrierServiceOptionPrices, type ShippingInformation$1 as ShippingInformation, type StreetAddress$2 as StreetAddress, type context$4_TaxDetails as TaxDetails, type VatId$2 as VatId, VatType$2 as VatType, type _publicProvideHandlersType$4 as _publicProvideHandlersType, provideHandlers$8 as provideHandlers, provideHandlers$9 as publicProvideHandlers };
1350
+ export { type AdditionalFee$1 as AdditionalFee, type context$4_AdditionalFeesSPIConfig as AdditionalFeesSPIConfig, type Address$2 as Address, type AddressLocation$2 as AddressLocation, type AppliedDiscount$2 as AppliedDiscount, type AppliedDiscountDiscountSourceOneOf$2 as AppliedDiscountDiscountSourceOneOf, type BuyerDetails$1 as BuyerDetails, type context$4_CalculateAdditionalFeesRequest as CalculateAdditionalFeesRequest, type context$4_CalculateAdditionalFeesResponse as CalculateAdditionalFeesResponse, type CatalogReference$4 as CatalogReference, ChargeType$1 as ChargeType, type Context$4 as Context, type Coupon$2 as Coupon, type DeliveryLogistics$1 as DeliveryLogistics, type DiscountRule$2 as DiscountRule, type DiscountRuleName$2 as DiscountRuleName, DiscountType$2 as DiscountType, type FullAddressContactDetails$2 as FullAddressContactDetails, type IdentificationData$4 as IdentificationData, type IdentificationDataIdOneOf$4 as IdentificationDataIdOneOf, IdentityType$4 as IdentityType, type LineItem$4 as LineItem, type MerchantDiscount$2 as MerchantDiscount, type PhysicalProperties$2 as PhysicalProperties, type PickupDetails$1 as PickupDetails, PickupMethod$1 as PickupMethod, type SelectedCarrierServiceOption$2 as SelectedCarrierServiceOption, type SelectedCarrierServiceOptionOtherCharge$1 as SelectedCarrierServiceOptionOtherCharge, type SelectedCarrierServiceOptionPrices$2 as SelectedCarrierServiceOptionPrices, type ShippingInformation$1 as ShippingInformation, type StreetAddress$2 as StreetAddress, type context$4_TaxDetails as TaxDetails, type VatId$2 as VatId, VatType$2 as VatType, type _publicProvideHandlersType$4 as _publicProvideHandlersType, provideHandlers$8 as provideHandlers, provideHandlers$9 as publicProvideHandlers };
1342
1351
  }
1343
1352
 
1344
1353
  interface CustomTrigger {
@@ -1359,13 +1368,13 @@ interface ListTriggersResponseCustomTrigger {
1359
1368
  }
1360
1369
  interface GetEligibleTriggersRequest {
1361
1370
  /** List of line items in the cart/checkout. */
1362
- lineItems?: LineItem$2[];
1371
+ lineItems?: LineItem$3[];
1363
1372
  /** List of triggers to be checked for discount eligibility. */
1364
1373
  triggers?: TriggerToFilterBy[];
1365
1374
  /** Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order. */
1366
1375
  purchaseFlowId?: string | null;
1367
1376
  }
1368
- interface LineItem$2 {
1377
+ interface LineItem$3 {
1369
1378
  /** Line item ID. */
1370
1379
  _id?: string;
1371
1380
  /** Item quantity in this line item. */
@@ -1518,12 +1527,12 @@ type context$3_ListTriggersResponse = ListTriggersResponse;
1518
1527
  type context$3_ListTriggersResponseCustomTrigger = ListTriggersResponseCustomTrigger;
1519
1528
  type context$3_TriggerToFilterBy = TriggerToFilterBy;
1520
1529
  declare namespace context$3 {
1521
- export { type CatalogReference$3 as CatalogReference, type Context$3 as Context, type context$3_CustomTrigger as CustomTrigger, type context$3_CustomTriggerConfig as CustomTriggerConfig, type context$3_EligibleTrigger as EligibleTrigger, type context$3_GetEligibleTriggersRequest as GetEligibleTriggersRequest, type context$3_GetEligibleTriggersResponse as GetEligibleTriggersResponse, type IdentificationData$3 as IdentificationData, type IdentificationDataIdOneOf$3 as IdentificationDataIdOneOf, IdentityType$3 as IdentityType, type LineItem$2 as LineItem, type context$3_ListTriggersRequest as ListTriggersRequest, type context$3_ListTriggersResponse as ListTriggersResponse, type context$3_ListTriggersResponseCustomTrigger as ListTriggersResponseCustomTrigger, type context$3_TriggerToFilterBy as TriggerToFilterBy, type _publicProvideHandlersType$3 as _publicProvideHandlersType, provideHandlers$6 as provideHandlers, provideHandlers$7 as publicProvideHandlers };
1530
+ export { type CatalogReference$3 as CatalogReference, type Context$3 as Context, type context$3_CustomTrigger as CustomTrigger, type context$3_CustomTriggerConfig as CustomTriggerConfig, type context$3_EligibleTrigger as EligibleTrigger, type context$3_GetEligibleTriggersRequest as GetEligibleTriggersRequest, type context$3_GetEligibleTriggersResponse as GetEligibleTriggersResponse, type IdentificationData$3 as IdentificationData, type IdentificationDataIdOneOf$3 as IdentificationDataIdOneOf, IdentityType$3 as IdentityType, type LineItem$3 as LineItem, type context$3_ListTriggersRequest as ListTriggersRequest, type context$3_ListTriggersResponse as ListTriggersResponse, type context$3_ListTriggersResponseCustomTrigger as ListTriggersResponseCustomTrigger, type context$3_TriggerToFilterBy as TriggerToFilterBy, type _publicProvideHandlersType$3 as _publicProvideHandlersType, provideHandlers$6 as provideHandlers, provideHandlers$7 as publicProvideHandlers };
1522
1531
  }
1523
1532
 
1524
1533
  interface GetEligibleDiscountsRequest {
1525
1534
  /** Line items */
1526
- lineItems?: LineItem$1[];
1535
+ lineItems?: LineItem$2[];
1527
1536
  /** Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order. */
1528
1537
  purchaseFlowId?: string | null;
1529
1538
  /** Number of coupons is limited to 1 due to limitations in Checkout. */
@@ -1531,7 +1540,7 @@ interface GetEligibleDiscountsRequest {
1531
1540
  /** Buyer email */
1532
1541
  buyerEmail?: string | null;
1533
1542
  }
1534
- interface LineItem$1 {
1543
+ interface LineItem$2 {
1535
1544
  /** Line item ID. */
1536
1545
  _id?: string;
1537
1546
  /** Line item quantity. */
@@ -1760,7 +1769,7 @@ declare const context$2_TargetType: typeof TargetType;
1760
1769
  type context$2_Type = Type;
1761
1770
  declare const context$2_Type: typeof Type;
1762
1771
  declare namespace context$2 {
1763
- export { type context$2_BaseDiscounts as BaseDiscounts, type CatalogReference$2 as CatalogReference, type Context$2 as Context, type context$2_CouponOptions as CouponOptions, type context$2_Discount as Discount, type context$2_DiscountDiscountScopesOneOf as DiscountDiscountScopesOneOf, type context$2_DiscountDiscountTypeOneOf as DiscountDiscountTypeOneOf, type context$2_DiscountName as DiscountName, type context$2_DiscountRate as DiscountRate, type context$2_DiscountRateRateOneOf as DiscountRateRateOneOf, context$2_DiscountSource as DiscountSource, type context$2_DiscountsSPIConfig as DiscountsSPIConfig, type context$2_GetEligibleDiscountsRequest as GetEligibleDiscountsRequest, type context$2_GetEligibleDiscountsResponse as GetEligibleDiscountsResponse, type IdentificationData$2 as IdentificationData, type IdentificationDataIdOneOf$2 as IdentificationDataIdOneOf, IdentityType$2 as IdentityType, type LineItem$1 as LineItem, type context$2_LineItemRate as LineItemRate, type context$2_LineItemsDiscounts as LineItemsDiscounts, context$2_TargetType as TargetType, context$2_Type as Type, type _publicProvideHandlersType$2 as _publicProvideHandlersType, provideHandlers$4 as provideHandlers, provideHandlers$5 as publicProvideHandlers };
1772
+ export { type context$2_BaseDiscounts as BaseDiscounts, type CatalogReference$2 as CatalogReference, type Context$2 as Context, type context$2_CouponOptions as CouponOptions, type context$2_Discount as Discount, type context$2_DiscountDiscountScopesOneOf as DiscountDiscountScopesOneOf, type context$2_DiscountDiscountTypeOneOf as DiscountDiscountTypeOneOf, type context$2_DiscountName as DiscountName, type context$2_DiscountRate as DiscountRate, type context$2_DiscountRateRateOneOf as DiscountRateRateOneOf, context$2_DiscountSource as DiscountSource, type context$2_DiscountsSPIConfig as DiscountsSPIConfig, type context$2_GetEligibleDiscountsRequest as GetEligibleDiscountsRequest, type context$2_GetEligibleDiscountsResponse as GetEligibleDiscountsResponse, type IdentificationData$2 as IdentificationData, type IdentificationDataIdOneOf$2 as IdentificationDataIdOneOf, IdentityType$2 as IdentityType, type LineItem$2 as LineItem, type context$2_LineItemRate as LineItemRate, type context$2_LineItemsDiscounts as LineItemsDiscounts, context$2_TargetType as TargetType, context$2_Type as Type, type _publicProvideHandlersType$2 as _publicProvideHandlersType, provideHandlers$4 as provideHandlers, provideHandlers$5 as publicProvideHandlers };
1764
1773
  }
1765
1774
 
1766
1775
  interface GetPaymentSettingsRequest {
@@ -1794,7 +1803,7 @@ interface Order {
1794
1803
  */
1795
1804
  lineItems?: OrderLineItem[];
1796
1805
  /** Buyer information. */
1797
- buyerInfo?: BuyerInfo;
1806
+ buyerInfo?: V1BuyerInfo;
1798
1807
  /**
1799
1808
  * Order payment status.
1800
1809
  * + `NOT_PAID` - This can be an order made online, but not yet paid. In such cases `order.status` will be `INITIALIZED`.
@@ -1833,7 +1842,7 @@ interface Order {
1833
1842
  */
1834
1843
  priceSummary?: PriceSummary$1;
1835
1844
  /** Billing address and contact details. */
1836
- billingInfo?: AddressWithContact$1;
1845
+ billingInfo?: ApiAddressWithContact;
1837
1846
  /** Shipping info and selected shipping option details. */
1838
1847
  shippingInfo?: V1ShippingInformation;
1839
1848
  /** [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer. */
@@ -1857,7 +1866,7 @@ interface Order {
1857
1866
  * @replacedBy tax_info
1858
1867
  * @targetRemovalDate 2024-09-30
1859
1868
  */
1860
- taxSummary?: TaxSummary;
1869
+ taxSummary?: ApiTaxSummary;
1861
1870
  /** Tax information. */
1862
1871
  taxInfo?: OrderTaxInfo;
1863
1872
  /** Applied discounts. */
@@ -1873,7 +1882,7 @@ interface Order {
1873
1882
  * ID of the order's initiator.
1874
1883
  * @readonly
1875
1884
  */
1876
- createdBy?: CreatedBy;
1885
+ createdBy?: V1CreatedBy;
1877
1886
  /** Information about the sales channel that submitted this order. */
1878
1887
  channelInfo?: ChannelInfo;
1879
1888
  /** Whether a human has seen the order. Set when an order is clicked on in the dashboard. */
@@ -1904,7 +1913,7 @@ interface Order {
1904
1913
  * + The chosen shipping option is pickup point or store pickup.
1905
1914
  * + No shipping option is selected.
1906
1915
  */
1907
- recipientInfo?: AddressWithContact$1;
1916
+ recipientInfo?: ApiAddressWithContact;
1908
1917
  }
1909
1918
  interface OrderLineItem {
1910
1919
  /** Line item ID. */
@@ -1986,7 +1995,7 @@ interface OrderLineItem {
1986
1995
  * @replacedBy tax_info
1987
1996
  * @targetRemovalDate 2024-09-30
1988
1997
  */
1989
- taxDetails?: ItemTaxFullDetails$1;
1998
+ taxDetails?: ApiItemTaxFullDetails;
1990
1999
  /** Represents all the relevant tax details for a specific line item. */
1991
2000
  taxInfo?: LineItemTaxInfo;
1992
2001
  /** Digital file identifier, relevant only for items with type DIGITAL. */
@@ -2145,7 +2154,7 @@ declare enum PaymentOptionType {
2145
2154
  /** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
2146
2155
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
2147
2156
  }
2148
- interface ItemTaxFullDetails$1 {
2157
+ interface ApiItemTaxFullDetails {
2149
2158
  /** Taxable amount of this line item. */
2150
2159
  taxableAmount?: Price;
2151
2160
  /** Tax rate percentage, as a decimal numeral between 0 and 1. For example, `"0.13"`. */
@@ -2264,7 +2273,7 @@ interface LocationAndQuantity {
2264
2273
  quantity?: number;
2265
2274
  }
2266
2275
  /** Buyer Info */
2267
- interface BuyerInfo extends BuyerInfoIdOneOf {
2276
+ interface V1BuyerInfo extends V1BuyerInfoIdOneOf {
2268
2277
  /** Visitor ID (if site visitor is not a member). */
2269
2278
  visitorId?: string;
2270
2279
  /** Member ID (if site visitor is a site member). */
@@ -2275,7 +2284,7 @@ interface BuyerInfo extends BuyerInfoIdOneOf {
2275
2284
  email?: string | null;
2276
2285
  }
2277
2286
  /** @oneof */
2278
- interface BuyerInfoIdOneOf {
2287
+ interface V1BuyerInfoIdOneOf {
2279
2288
  /** Visitor ID (if site visitor is not a member). */
2280
2289
  visitorId?: string;
2281
2290
  /** Member ID (if site visitor is a site member). */
@@ -2330,7 +2339,7 @@ interface PriceSummary$1 {
2330
2339
  totalAdditionalFees?: Price;
2331
2340
  }
2332
2341
  /** Billing Info and shipping details */
2333
- interface AddressWithContact$1 {
2342
+ interface ApiAddressWithContact {
2334
2343
  /** Address. */
2335
2344
  address?: Address$1;
2336
2345
  /** Contact details. */
@@ -2417,7 +2426,7 @@ interface V1ShippingInformation {
2417
2426
  }
2418
2427
  interface DeliveryLogistics extends DeliveryLogisticsAddressOneOf {
2419
2428
  /** Shipping address and contact details. */
2420
- shippingDestination?: AddressWithContact$1;
2429
+ shippingDestination?: ApiAddressWithContact;
2421
2430
  /** Pickup details. */
2422
2431
  pickupDetails?: PickupDetails;
2423
2432
  /** Expected delivery time in free text. For example, `"3-5 business days"`. */
@@ -2435,7 +2444,7 @@ interface DeliveryLogistics extends DeliveryLogisticsAddressOneOf {
2435
2444
  /** @oneof */
2436
2445
  interface DeliveryLogisticsAddressOneOf {
2437
2446
  /** Shipping address and contact details. */
2438
- shippingDestination?: AddressWithContact$1;
2447
+ shippingDestination?: ApiAddressWithContact;
2439
2448
  /** Pickup details. */
2440
2449
  pickupDetails?: PickupDetails;
2441
2450
  }
@@ -2487,7 +2496,7 @@ interface ShippingPrice {
2487
2496
  */
2488
2497
  totalPriceAfterTax?: Price;
2489
2498
  /** Tax details. */
2490
- taxDetails?: ItemTaxFullDetails$1;
2499
+ taxDetails?: ApiItemTaxFullDetails;
2491
2500
  /**
2492
2501
  * Shipping discount before tax.
2493
2502
  * @readonly
@@ -2503,7 +2512,7 @@ declare enum OrderStatus {
2503
2512
  APPROVED = "APPROVED",
2504
2513
  CANCELED = "CANCELED"
2505
2514
  }
2506
- interface TaxSummary {
2515
+ interface ApiTaxSummary {
2507
2516
  /**
2508
2517
  * Total tax.
2509
2518
  * @readonly
@@ -2939,7 +2948,7 @@ declare enum AttributionSource {
2939
2948
  UNSPECIFIED = "UNSPECIFIED",
2940
2949
  FACEBOOK_ADS = "FACEBOOK_ADS"
2941
2950
  }
2942
- interface CreatedBy extends CreatedByStringOneOf {
2951
+ interface V1CreatedBy extends V1CreatedByStringOneOf {
2943
2952
  /**
2944
2953
  * User ID - when the order was created by a Wix user on behalf of a buyer.
2945
2954
  * For example, via POS (point of service).
@@ -2953,7 +2962,7 @@ interface CreatedBy extends CreatedByStringOneOf {
2953
2962
  appId?: string;
2954
2963
  }
2955
2964
  /** @oneof */
2956
- interface CreatedByStringOneOf {
2965
+ interface V1CreatedByStringOneOf {
2957
2966
  /**
2958
2967
  * User ID - when the order was created by a Wix user on behalf of a buyer.
2959
2968
  * For example, via POS (point of service).
@@ -3053,7 +3062,7 @@ interface AdditionalFee {
3053
3062
  /** Additional fee's price. */
3054
3063
  price?: Price;
3055
3064
  /** Tax details. */
3056
- taxDetails?: ItemTaxFullDetails$1;
3065
+ taxDetails?: ApiItemTaxFullDetails;
3057
3066
  /** SPI implementer's `appId`. */
3058
3067
  providerAppId?: string | null;
3059
3068
  /** Additional fee's price before tax. */
@@ -3129,88 +3138,1335 @@ interface PaymentSettings {
3129
3138
  */
3130
3139
  requires3dSecure?: boolean | null;
3131
3140
  }
3132
- interface PaymentSettingsSPIConfig {
3141
+ interface GetPaymentSettingsForCheckoutRequest {
3142
+ /** Checkout. */
3143
+ checkout?: Checkout;
3144
+ }
3145
+ interface Checkout {
3133
3146
  /**
3134
- * *Required.** Base URI where the endpoints are called. Wix eCommerce appends the endpoint path to the base URI.
3135
- * For example, to call the Get Payment Settings endpoint at `https://my-payment-settings.com/v1/payment-settings`,
3136
- * the base URI you provide here is `https://my-payment-settings.com/`.
3147
+ * Checkout ID.
3148
+ * @readonly
3137
3149
  */
3138
- deploymentUri?: string;
3150
+ _id?: string | null;
3139
3151
  /**
3140
- * The value to set for `paymentSettings.requires3dSecure` if the service plugin call fails.
3152
+ * Line items.
3141
3153
  *
3142
- * Default: `false`
3154
+ * Max: 300 items
3155
+ * @readonly
3143
3156
  */
3144
- fallbackValueForRequires3dSecure?: boolean;
3145
- }
3146
- /**
3147
- * this message is not directly used by any service,
3148
- * it exists to describe the expected parameters that SHOULD be provided to invoked Velo methods as part of open-platform.
3149
- * e.g. SPIs, event-handlers, etc..
3150
- * NOTE: this context object MUST be provided as the last argument in each Velo method signature.
3151
- *
3152
- * Example:
3153
- * ```typescript
3154
- * export function wixStores_onOrderCanceled({ event, metadata }: OrderCanceledEvent) {
3155
- * ...
3156
- * }
3157
- * ```
3158
- */
3159
- interface Context$1 {
3160
- /** A unique identifier of the request. You may print this ID to your logs to help with future debugging and easier correlation with Wix's logs. */
3161
- requestId?: string | null;
3162
- /** [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 3-letter currency code. */
3163
- currency?: string | null;
3164
- /** An object that describes the identity that triggered this request. */
3165
- identity?: IdentificationData$1;
3166
- /** A string representing a language and region in the format of `"xx-XX"`. First 2 letters represent the language code according to ISO 639-1. This is followed by a dash "-", and then a by 2 capital letters representing the region according to ISO 3166-2. For example, `"en-US"`. */
3167
- languages?: string[];
3168
- /** The service provider app's instance ID. */
3169
- instanceId?: string | null;
3170
- }
3171
- declare enum IdentityType$1 {
3172
- UNKNOWN = "UNKNOWN",
3173
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
3174
- MEMBER = "MEMBER",
3175
- WIX_USER = "WIX_USER",
3176
- APP = "APP"
3177
- }
3178
- interface IdentificationData$1 extends IdentificationDataIdOneOf$1 {
3179
- /** ID of a site visitor that has not logged in to the site. */
3180
- anonymousVisitorId?: string;
3181
- /** ID of a site visitor that has logged in to the site. */
3182
- memberId?: string;
3183
- /** ID of a Wix user (site owner, contributor, etc.). */
3184
- wixUserId?: string;
3185
- /** ID of an app. */
3186
- appId?: string;
3187
- /** @readonly */
3188
- identityType?: IdentityType$1;
3189
- }
3190
- /** @oneof */
3191
- interface IdentificationDataIdOneOf$1 {
3192
- /** ID of a site visitor that has not logged in to the site. */
3193
- anonymousVisitorId?: string;
3194
- /** ID of a site visitor that has logged in to the site. */
3195
- memberId?: string;
3196
- /** ID of a Wix user (site owner, contributor, etc.). */
3197
- wixUserId?: string;
3198
- /** ID of an app. */
3199
- appId?: string;
3200
- }
3201
-
3202
- interface GetPaymentSettingsEnvelope {
3203
- request: GetPaymentSettingsRequest;
3204
- metadata: Context$1;
3205
- }
3206
- declare const provideHandlers$3: ServicePluginDefinition<{
3157
+ lineItems?: LineItem$1[];
3158
+ /** Billing information. */
3159
+ billingInfo?: AddressWithContact$1;
3160
+ /** Shipping information. */
3161
+ shippingInfo?: ShippingInfo$1;
3162
+ /** [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer. */
3163
+ buyerNote?: string | null;
3164
+ /** Buyer information. */
3165
+ buyerInfo?: BuyerInfo;
3166
+ /**
3167
+ * All converted prices are displayed in this currency in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
3168
+ * @readonly
3169
+ */
3170
+ conversionCurrency?: string;
3171
+ /**
3172
+ * Calculated price summary for the checkout.
3173
+ * @readonly
3174
+ */
3175
+ priceSummary?: V1PriceSummary;
3207
3176
  /**
3177
+ * Errors when calculating totals.
3178
+ * @readonly
3179
+ */
3180
+ calculationErrors?: CalculationErrors;
3181
+ /**
3182
+ * Applied gift card details.
3208
3183
  *
3209
- * This method retrieves payment settings from your app.
3184
+ * >**Note:** Gift cards are supported through the Wix UI, though the service plugin is not currently available. Learn more about [Wix Gift Cards](https://support.wix.com/en/article/wix-stores-setting-up-wix-gift-cards).
3185
+ * @readonly
3186
+ */
3187
+ giftCard?: GiftCard$1;
3188
+ /**
3189
+ * Applied discounts.
3190
+ * @readonly
3191
+ */
3192
+ appliedDiscounts?: V1AppliedDiscount[];
3193
+ /** Custom fields. */
3194
+ customFields?: CustomField$1[];
3195
+ /**
3196
+ * Weight measurement unit - defaults to site's weight unit.
3197
+ * @readonly
3198
+ */
3199
+ weightUnit?: WeightUnit$1;
3200
+ /**
3201
+ * Tax summary.
3202
+ * @readonly
3203
+ */
3204
+ taxSummary?: TaxSummary;
3205
+ /**
3206
+ * The currency used when submitting the order.
3207
+ * @readonly
3208
+ */
3209
+ currency?: string;
3210
+ /**
3211
+ * Sales channel that submitted the order.
3212
+ * + `"UNSPECIFIED"`: Unspecified sales channel. This value is not supported.
3213
+ * + `"WEB"`: A web client.
3214
+ * + `"POS"`: [Point of sale solutions](https://support.wix.com/en/wix-mobile-pos-2196395)
3215
+ * + `"EBAY"`: [eBay](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-ebay-shop)
3216
+ * + `"AMAZON"`: [Amazon](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop)
3217
+ * + `"WISH"`: [Wish](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-a-wish-shop)
3218
+ * + `"WIX_INVOICES"`: Wix Invoices app in [your dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Finvoices/settings/general-settings)
3219
+ * + `"WIX_APP_STORE"`: [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview)
3220
+ * + `"BACKOFFICE_MERCHANT"`: Wix merchant backoffice
3221
+ * + `"OTHER_PLATFORM"`: Other sales platform.
3222
+ * @readonly
3223
+ */
3224
+ channelType?: ChannelType;
3225
+ /**
3226
+ * Site language in which original values are shown.
3227
+ * @readonly
3228
+ */
3229
+ siteLanguage?: string;
3230
+ /**
3231
+ * Language for communication with the buyer. Defaults to the site language.
3232
+ * For a site that supports multiple languages, this is the language the buyer selected.
3233
+ * @readonly
3234
+ */
3235
+ buyerLanguage?: string;
3236
+ /**
3237
+ * Whether an order was successfully created from this checkout.
3238
+ * For an order to be successful, it must be successfully paid for (unless the total is 0).
3239
+ * @readonly
3240
+ */
3241
+ completed?: boolean;
3242
+ /**
3243
+ * Whether tax is included in line item prices.
3244
+ * @readonly
3245
+ */
3246
+ taxIncludedInPrice?: boolean;
3247
+ /**
3248
+ * ID of the checkout's initiator.
3249
+ * @readonly
3250
+ */
3251
+ createdBy?: CreatedBy;
3252
+ /**
3253
+ * Date and time the checkout was created.
3254
+ * @readonly
3255
+ */
3256
+ _createdDate?: Date;
3257
+ /**
3258
+ * Date and time the checkout was updated.
3259
+ * @readonly
3260
+ */
3261
+ _updatedDate?: Date;
3262
+ /**
3263
+ * Minimal amount to pay in order to place the order.
3264
+ * @readonly
3265
+ */
3266
+ payNow?: V1PriceSummary;
3267
+ /**
3268
+ * Remaining amount for the order to be fully paid.
3269
+ * @readonly
3270
+ */
3271
+ payLater?: V1PriceSummary;
3272
+ /** Memberships to apply when creating the order. */
3273
+ membershipOptions?: MembershipOptions;
3274
+ /** Additional Fees. */
3275
+ additionalFees?: V1AdditionalFee[];
3276
+ /** Cart ID that this checkout was created from. Empty if this checkout wasn't created from a cart. */
3277
+ cartId?: string | null;
3278
+ /**
3279
+ * List of validation violations raised by the [Validations service plugin](https://dev.wix.com/api/rest/wix-ecommerce/validations-integration-spi/introduction).
3280
+ * @readonly
3281
+ */
3282
+ violations?: Violation$1[];
3283
+ /**
3284
+ * Custom field data for the checkout object.
3210
3285
  *
3211
- * Wix calls this method during the payment process. For example, when a customer inserts credit card details and places an order.
3212
- * This method retrieves the payment settings to apply, and Wix passes on the settings to the payment provider. */
3213
- getPaymentSettings(payload: GetPaymentSettingsEnvelope): GetPaymentSettingsResponse | Promise<GetPaymentSettingsResponse>;
3286
+ * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the Wix Dev Center before they can be accessed with API calls.
3287
+ */
3288
+ extendedFields?: ExtendedFields$1;
3289
+ /**
3290
+ * Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
3291
+ * @readonly
3292
+ */
3293
+ purchaseFlowId?: string | null;
3294
+ /**
3295
+ * Additional settings for customization of the checkout process.
3296
+ *
3297
+ * > **Notes:**
3298
+ * > * Custom settings can only be set when [creating a checkout](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/checkout/create-checkout).
3299
+ * > * To access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions". Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
3300
+ */
3301
+ customSettings?: CustomSettings;
3302
+ /**
3303
+ * Reference IDs for the app and component providing custom checkout page content.
3304
+ *
3305
+ * To access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
3306
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
3307
+ */
3308
+ customContentReference?: CustomContentReference;
3309
+ }
3310
+ interface LineItem$1 {
3311
+ /**
3312
+ * Line item ID.
3313
+ * @readonly
3314
+ */
3315
+ _id?: string | null;
3316
+ /**
3317
+ * Item quantity.
3318
+ *
3319
+ * Min: `"1"`
3320
+ * Max: `"100000"`
3321
+ */
3322
+ quantity?: number;
3323
+ /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */
3324
+ catalogReference?: CatalogReference$1;
3325
+ /**
3326
+ * Item name.
3327
+ * + Stores - `product.name`
3328
+ * + Bookings - `service.info.name`
3329
+ * + Events - `ticket.name`
3330
+ * @readonly
3331
+ */
3332
+ productName?: ProductName$1;
3333
+ /**
3334
+ * URL to the item's page on the site.
3335
+ * @readonly
3336
+ */
3337
+ url?: string;
3338
+ /**
3339
+ * Item price **after** catalog-defined discount and line item discounts.
3340
+ * @readonly
3341
+ */
3342
+ price?: MultiCurrencyPrice$1;
3343
+ /**
3344
+ * Total line item price **after** catalog-defined discount and line item discounts.
3345
+ * @readonly
3346
+ */
3347
+ lineItemPrice?: MultiCurrencyPrice$1;
3348
+ /**
3349
+ * Item price **before** catalog-defined discount. Defaults to `price` when not provided.
3350
+ * @readonly
3351
+ */
3352
+ fullPrice?: MultiCurrencyPrice$1;
3353
+ /**
3354
+ * Item price **before** line item discounts and **after** catalog-defined discount. Defaults to `price` when not provided.
3355
+ * @readonly
3356
+ */
3357
+ priceBeforeDiscounts?: MultiCurrencyPrice$1;
3358
+ /**
3359
+ * Total price after all discounts and tax.
3360
+ * @readonly
3361
+ */
3362
+ totalPriceAfterTax?: MultiCurrencyPrice$1;
3363
+ /**
3364
+ * Total price after discounts, and before tax.
3365
+ * @readonly
3366
+ */
3367
+ totalPriceBeforeTax?: MultiCurrencyPrice$1;
3368
+ /**
3369
+ * Tax details for this line item.
3370
+ * @readonly
3371
+ */
3372
+ taxDetails?: ItemTaxFullDetails$1;
3373
+ /**
3374
+ * Discount for this line item's entire quantity.
3375
+ * @readonly
3376
+ */
3377
+ discount?: MultiCurrencyPrice$1;
3378
+ /**
3379
+ * Line item description lines. Used for display purposes for the cart, checkout and order.
3380
+ * @readonly
3381
+ */
3382
+ descriptionLines?: DescriptionLine[];
3383
+ /**
3384
+ * Line item image details.
3385
+ * @readonly
3386
+ */
3387
+ media?: string;
3388
+ /**
3389
+ * Item availability details.
3390
+ * @readonly
3391
+ */
3392
+ availability?: ItemAvailabilityInfo;
3393
+ /**
3394
+ * Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability.
3395
+ * @readonly
3396
+ */
3397
+ physicalProperties?: PhysicalProperties$1;
3398
+ /**
3399
+ * Item type. Either a preset type or custom.
3400
+ * @readonly
3401
+ */
3402
+ itemType?: ItemType$1;
3403
+ /**
3404
+ * Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
3405
+ * + `FULL_PAYMENT_ONLINE`: The entire payment for this item happens as part of the checkout.
3406
+ * + `FULL_PAYMENT_OFFLINE`: The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
3407
+ * + `MEMBERSHIP`: Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is `0`.
3408
+ * + `DEPOSIT_ONLINE`: Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is defined by `lineItem.deposit`.
3409
+ * + `MEMBERSHIP_OFFLINE`: Payment for this item can only be performed by using a membership and must be manually redeemed in the dashboard by the site owner. When this option is used, `lineItem.price.amount` is `0`.
3410
+ * @readonly
3411
+ */
3412
+ paymentOption?: PaymentOptionType;
3413
+ /**
3414
+ * Service properties. When relevant, this contains information such as date and number of participants.
3415
+ * @readonly
3416
+ */
3417
+ serviceProperties?: ServiceProperties;
3418
+ /**
3419
+ * In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
3420
+ * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
3421
+ * + In most cases, this field has the same value as `catalogReference.catalogItemId`.
3422
+ * + Used in membership validation.
3423
+ * @readonly
3424
+ */
3425
+ rootCatalogItemId?: string | null;
3426
+ /**
3427
+ * Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67".
3428
+ * @readonly
3429
+ */
3430
+ priceDescription?: PriceDescription;
3431
+ /**
3432
+ * Partial payment to be paid upfront during the checkout. Eligible for catalog items with `lineItem.paymentOption` type `DEPOSIT_ONLINE` only.
3433
+ * @readonly
3434
+ */
3435
+ depositAmount?: MultiCurrencyPrice$1;
3436
+ /**
3437
+ * Whether the line item is a custom line item. Custom line items don't trigger the Catalog service plugin.
3438
+ * @readonly
3439
+ */
3440
+ customLineItem?: boolean;
3441
+ /**
3442
+ * Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page.
3443
+ * @readonly
3444
+ */
3445
+ consentRequiredPaymentPolicy?: string | null;
3446
+ /**
3447
+ * Overriding values for catalog item properties.
3448
+ *
3449
+ * To override catalog fields, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
3450
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
3451
+ */
3452
+ catalogOverrideFields?: CatalogOverrideFields;
3453
+ /**
3454
+ * Whether to save the payment method on the order.
3455
+ *
3456
+ * Default: `false`
3457
+ * @readonly
3458
+ */
3459
+ savePaymentMethod?: boolean;
3460
+ }
3461
+ interface MultiCurrencyPrice$1 {
3462
+ /** Amount. */
3463
+ amount?: string;
3464
+ /**
3465
+ * Converted amount.
3466
+ * @readonly
3467
+ */
3468
+ convertedAmount?: string;
3469
+ /**
3470
+ * Amount formatted with currency symbol.
3471
+ * @readonly
3472
+ */
3473
+ formattedAmount?: string;
3474
+ /**
3475
+ * Converted amount formatted with currency symbol.
3476
+ * @readonly
3477
+ */
3478
+ formattedConvertedAmount?: string;
3479
+ }
3480
+ interface ItemTaxFullDetails$1 {
3481
+ /** Amount for which tax is calculated. */
3482
+ taxableAmount?: MultiCurrencyPrice$1;
3483
+ /** Tax rate %, as a decimal point between 0 and 1. */
3484
+ taxRate?: string;
3485
+ /** Calculated tax, based on `taxable_amount` and `tax_rate`. */
3486
+ totalTax?: MultiCurrencyPrice$1;
3487
+ /**
3488
+ * If breakdown exists, the sum of rates in the breakdown must equal `tax_rate`. Deprecated - use 'tax_breakdown' instead.
3489
+ * @readonly
3490
+ * @deprecated
3491
+ */
3492
+ rateBreakdown?: TaxRateBreakdown[];
3493
+ }
3494
+ interface TaxRateBreakdown {
3495
+ /** Name of tax against which the calculation was performed. */
3496
+ name?: string;
3497
+ /** Rate at which this tax detail was calculated. */
3498
+ rate?: string;
3499
+ /** Amount of tax for this tax detail. */
3500
+ tax?: MultiCurrencyPrice$1;
3501
+ }
3502
+ /**
3503
+ * TaxBreakdown represents tax information for a line item.
3504
+ * It holds the tax amount and the tax rate for each tax authority that apply on the line item.
3505
+ */
3506
+ interface TaxBreakdown$1 {
3507
+ /** The name of the jurisdiction to which this tax detail applies. For example, "New York" or "Quebec". */
3508
+ jurisdiction?: string | null;
3509
+ /** The amount of this line item price that was considered nontaxable. (Decimal value) */
3510
+ nonTaxableAmount?: MultiCurrencyPrice$1;
3511
+ /** The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.0000 signifies 200% tax. (Decimal value) */
3512
+ rate?: string | null;
3513
+ /** The amount of tax estimated for this line item. (Decimal value) */
3514
+ taxAmount?: MultiCurrencyPrice$1;
3515
+ /** The taxable amount of this line item. */
3516
+ taxableAmount?: MultiCurrencyPrice$1;
3517
+ /** The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc. */
3518
+ taxType?: string | null;
3519
+ /**
3520
+ * The name of the tax against which this tax amount was calculated. For example, "NY State Sales Tax", "Quebec GST", etc.
3521
+ * This name should be explicit enough to allow the merchant to understand what tax was calculated.
3522
+ */
3523
+ taxName?: string | null;
3524
+ /** The type of the jurisdiction in which this tax detail applies. */
3525
+ jurisdictionType?: V1JurisdictionType;
3526
+ }
3527
+ /** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
3528
+ declare enum V1JurisdictionType {
3529
+ UNDEFINED = "UNDEFINED",
3530
+ COUNTRY = "COUNTRY",
3531
+ STATE = "STATE",
3532
+ COUNTY = "COUNTY",
3533
+ CITY = "CITY",
3534
+ SPECIAL = "SPECIAL"
3535
+ }
3536
+ interface ItemAvailabilityInfo {
3537
+ /**
3538
+ * Item availability status.
3539
+ * + `"NOT_FOUND"`: Item does not exist
3540
+ * + `"NOT_AVAILABLE"`: Item not in stock
3541
+ * + `"PARTIALLY_AVAILABLE"`: Available quantity is less than requested
3542
+ */
3543
+ status?: ItemAvailabilityStatus;
3544
+ /** Quantity available. */
3545
+ quantityAvailable?: number | null;
3546
+ }
3547
+ declare enum ItemAvailabilityStatus {
3548
+ AVAILABLE = "AVAILABLE",
3549
+ NOT_FOUND = "NOT_FOUND",
3550
+ /** Not in stock */
3551
+ NOT_AVAILABLE = "NOT_AVAILABLE",
3552
+ /** Available quantity is less than requested */
3553
+ PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
3554
+ }
3555
+ interface Scope {
3556
+ /** Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans) */
3557
+ namespace?: string;
3558
+ /** Coupon scope's applied group (e.g., event or ticket in Wix Events) */
3559
+ group?: Group;
3560
+ }
3561
+ interface Group {
3562
+ /** Coupon scope's group (e.g., product or collection in Wix Stores). See [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values). */
3563
+ name?: string;
3564
+ /** Item ID (when the coupon scope is limited to just one item). */
3565
+ entityId?: string | null;
3566
+ }
3567
+ interface SubscriptionOptionInfo$1 {
3568
+ /** Subscription option settings. */
3569
+ subscriptionSettings?: V1SubscriptionSettings;
3570
+ /** Subscription option title. */
3571
+ title?: Title$1;
3572
+ /** Subscription option description. */
3573
+ description?: Description$1;
3574
+ }
3575
+ interface V1SubscriptionSettings {
3576
+ /** Frequency of recurring payment. */
3577
+ frequency?: SubscriptionFrequency$1;
3578
+ /**
3579
+ * Interval of recurring payment.
3580
+ *
3581
+ * Default: `1`.
3582
+ */
3583
+ interval?: number | null;
3584
+ /** Whether subscription is renewed automatically at the end of each period. */
3585
+ autoRenewal?: boolean;
3586
+ /** Number of billing cycles before subscription ends. Ignored if `autoRenewal` is `true`. */
3587
+ billingCycles?: number | null;
3588
+ }
3589
+ interface Title$1 {
3590
+ /** Subscription option name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
3591
+ original?: string;
3592
+ /**
3593
+ * Subscription option name translated into the buyer's language.
3594
+ *
3595
+ * Default: Same as `original`.
3596
+ */
3597
+ translated?: string | null;
3598
+ }
3599
+ interface Description$1 {
3600
+ /** Subscription option description. */
3601
+ original?: string;
3602
+ /** Translated subscription option description. */
3603
+ translated?: string | null;
3604
+ }
3605
+ interface SecuredMedia {
3606
+ /** Media ID in Wix Media Manager. */
3607
+ _id?: string;
3608
+ /** Original filename. */
3609
+ fileName?: string;
3610
+ /** File type. */
3611
+ fileType?: FileType;
3612
+ }
3613
+ declare enum FileType {
3614
+ UNSPECIFIED = "UNSPECIFIED",
3615
+ SECURE_PICTURE = "SECURE_PICTURE",
3616
+ SECURE_VIDEO = "SECURE_VIDEO",
3617
+ SECURE_DOCUMENT = "SECURE_DOCUMENT",
3618
+ SECURE_MUSIC = "SECURE_MUSIC",
3619
+ SECURE_ARCHIVE = "SECURE_ARCHIVE"
3620
+ }
3621
+ interface ServiceProperties {
3622
+ /**
3623
+ * Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
3624
+ * For example, the start time of a class.
3625
+ */
3626
+ scheduledDate?: Date;
3627
+ /** The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room. */
3628
+ numberOfParticipants?: number | null;
3629
+ }
3630
+ interface CatalogOverrideFields {
3631
+ /** Item name. */
3632
+ productName?: ProductName$1;
3633
+ /** Item price **after** discounts. */
3634
+ price?: string | null;
3635
+ /** Item price **before** discounts. */
3636
+ fullPrice?: string | null;
3637
+ /** Item description lines. Used when displaying the line item to customers. */
3638
+ descriptionLines?: DescriptionLine[];
3639
+ /** Physical properties of the item. */
3640
+ physicalProperties?: PhysicalProperties$1;
3641
+ /** Item image. */
3642
+ image?: string;
3643
+ }
3644
+ interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
3645
+ /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
3646
+ addressType?: TaxableAddressType;
3647
+ }
3648
+ /** @oneof */
3649
+ interface TaxableAddressTaxableAddressDataOneOf {
3650
+ /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
3651
+ addressType?: TaxableAddressType;
3652
+ }
3653
+ declare enum TaxableAddressType {
3654
+ UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
3655
+ BUSINESS = "BUSINESS",
3656
+ BILLING = "BILLING",
3657
+ SHIPPING = "SHIPPING"
3658
+ }
3659
+ /** Billing Info and shipping details */
3660
+ interface AddressWithContact$1 {
3661
+ /** Address. */
3662
+ address?: Address$1;
3663
+ /** Contact details. */
3664
+ contactDetails?: FullAddressContactDetails$1;
3665
+ }
3666
+ interface ShippingInfo$1 {
3667
+ /** Shipping address and contact details. */
3668
+ shippingDestination?: AddressWithContact$1;
3669
+ /** Selected option out of the options allowed for the `region`. */
3670
+ selectedCarrierServiceOption?: SelectedCarrierServiceOption$1;
3671
+ /**
3672
+ * Shipping region. Based on the address provided.
3673
+ * @readonly
3674
+ */
3675
+ region?: V1ShippingRegion;
3676
+ /**
3677
+ * All carrier options for this shipping rule.
3678
+ * @readonly
3679
+ */
3680
+ carrierServiceOptions?: CarrierServiceOption[];
3681
+ }
3682
+ interface SelectedCarrierServiceOption$1 {
3683
+ /** Unique identifier of selected option. For example, "usps_std_overnight". */
3684
+ code?: string;
3685
+ /**
3686
+ * Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).
3687
+ * For example, "Standard" or "First-Class Package International".
3688
+ * @readonly
3689
+ */
3690
+ title?: string;
3691
+ /**
3692
+ * Delivery logistics.
3693
+ * @readonly
3694
+ */
3695
+ logistics?: V1DeliveryLogistics;
3696
+ /**
3697
+ * Shipping costs.
3698
+ * @readonly
3699
+ */
3700
+ cost?: SelectedCarrierServiceOptionPrices$1;
3701
+ /**
3702
+ * Were we able to find the requested shipping option, or otherwise we fallback to the default one (the first)
3703
+ * @readonly
3704
+ */
3705
+ requestedShippingOption?: boolean;
3706
+ /** Other charges */
3707
+ otherCharges?: SelectedCarrierServiceOptionOtherCharge[];
3708
+ /** This carrier's unique ID */
3709
+ carrierId?: string | null;
3710
+ }
3711
+ interface V1DeliveryLogistics {
3712
+ /** Expected delivery time, in free text. For example, "3-5 business days". */
3713
+ deliveryTime?: string | null;
3714
+ /** Instructions for caller, e.g for pickup: "Please deliver during opening hours, and please don't park in disabled parking spot". */
3715
+ instructions?: string | null;
3716
+ /** Pickup details. */
3717
+ pickupDetails?: V1PickupDetails;
3718
+ }
3719
+ interface V1PickupDetails {
3720
+ /** Pickup address. */
3721
+ address?: Address$1;
3722
+ /**
3723
+ * Whether the pickup address is that of a business - this may effect tax calculation.
3724
+ * @deprecated
3725
+ */
3726
+ businessLocation?: boolean;
3727
+ /** Pickup method */
3728
+ pickupMethod?: PickupDetailsPickupMethod;
3729
+ }
3730
+ declare enum PickupDetailsPickupMethod {
3731
+ UNKNOWN_METHOD = "UNKNOWN_METHOD",
3732
+ STORE_PICKUP = "STORE_PICKUP",
3733
+ PICKUP_POINT = "PICKUP_POINT"
3734
+ }
3735
+ interface V1DeliveryTimeSlot {
3736
+ /** starting time of the delivery time slot */
3737
+ from?: Date;
3738
+ /** ending time of the delivery time slot */
3739
+ to?: Date;
3740
+ }
3741
+ interface SelectedCarrierServiceOptionPrices$1 {
3742
+ /** Total shipping price, after discount and after tax. */
3743
+ totalPriceAfterTax?: MultiCurrencyPrice$1;
3744
+ /** Total price of shipping after discounts (when relevant), and before tax. */
3745
+ totalPriceBeforeTax?: MultiCurrencyPrice$1;
3746
+ /** Tax details. */
3747
+ taxDetails?: ItemTaxFullDetails$1;
3748
+ /** Shipping discount before tax. */
3749
+ totalDiscount?: MultiCurrencyPrice$1;
3750
+ /** Shipping price before discount and before tax. */
3751
+ price?: MultiCurrencyPrice$1;
3752
+ }
3753
+ interface SelectedCarrierServiceOptionOtherCharge {
3754
+ /** Type of additional cost. */
3755
+ type?: ChargeType;
3756
+ /** Details of the charge, such as 'Full Coverage Insurance of up to 80% of value of shipment'. */
3757
+ details?: string | null;
3758
+ /** Price of added charge. */
3759
+ cost?: SelectedCarrierServiceOptionPrices$1;
3760
+ }
3761
+ declare enum ChargeType {
3762
+ HANDLING_FEE = "HANDLING_FEE",
3763
+ INSURANCE = "INSURANCE"
3764
+ }
3765
+ interface V1ShippingRegion {
3766
+ /**
3767
+ * Shipping region ID.
3768
+ * @readonly
3769
+ */
3770
+ _id?: string;
3771
+ /** Shipping region name. */
3772
+ name?: string;
3773
+ }
3774
+ interface CarrierServiceOption {
3775
+ /** Carrier ID. */
3776
+ carrierId?: string;
3777
+ /** Shipping options offered by this carrier for this request. */
3778
+ shippingOptions?: ShippingOption[];
3779
+ }
3780
+ interface ShippingOption {
3781
+ /**
3782
+ * Unique code of provided shipping option like "usps_std_overnight".
3783
+ * For legacy calculators this would be the UUID of the option.
3784
+ */
3785
+ code?: string;
3786
+ /**
3787
+ * Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).
3788
+ * For example, "Standard" or "First-Class Package International".
3789
+ */
3790
+ title?: string;
3791
+ /** Delivery logistics. */
3792
+ logistics?: V1DeliveryLogistics;
3793
+ /** Sipping price information. */
3794
+ cost?: V1ShippingPrice;
3795
+ }
3796
+ interface V1ShippingPrice {
3797
+ /** Shipping price. */
3798
+ price?: MultiCurrencyPrice$1;
3799
+ /** Other costs such as insurance, handling & packaging for fragile items, etc. */
3800
+ otherCharges?: OtherCharge[];
3801
+ }
3802
+ interface OtherCharge {
3803
+ /** Type of additional cost. */
3804
+ type?: ChargeType;
3805
+ /** Price of added cost. */
3806
+ price?: MultiCurrencyPrice$1;
3807
+ }
3808
+ interface BuyerInfo extends BuyerInfoIdOneOf {
3809
+ /**
3810
+ * Visitor ID (if site visitor is **not** a member).
3811
+ * @readonly
3812
+ */
3813
+ visitorId?: string;
3814
+ /**
3815
+ * Member ID (if site visitor is a site member).
3816
+ * @readonly
3817
+ */
3818
+ memberId?: string;
3819
+ /**
3820
+ * Contact ID. Auto-created if one does not yet exist. For more information, see [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/introduction).
3821
+ * @readonly
3822
+ */
3823
+ contactId?: string | null;
3824
+ /** Buyer email address. */
3825
+ email?: string | null;
3826
+ }
3827
+ /** @oneof */
3828
+ interface BuyerInfoIdOneOf {
3829
+ /**
3830
+ * Visitor ID (if site visitor is **not** a member).
3831
+ * @readonly
3832
+ */
3833
+ visitorId?: string;
3834
+ /**
3835
+ * Member ID (if site visitor is a site member).
3836
+ * @readonly
3837
+ */
3838
+ memberId?: string;
3839
+ }
3840
+ interface V1PriceSummary {
3841
+ /** Subtotal of all line items, before discounts and before tax. */
3842
+ subtotal?: MultiCurrencyPrice$1;
3843
+ /** Total shipping price, before discounts and before tax. */
3844
+ shipping?: MultiCurrencyPrice$1;
3845
+ /** Total tax. */
3846
+ tax?: MultiCurrencyPrice$1;
3847
+ /** Total calculated discount value. */
3848
+ discount?: MultiCurrencyPrice$1;
3849
+ /** Total price after discounts, gift cards, and tax. */
3850
+ total?: MultiCurrencyPrice$1;
3851
+ /** Total additional fees price before tax. */
3852
+ additionalFees?: MultiCurrencyPrice$1;
3853
+ }
3854
+ interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
3855
+ /** General shipping calculation error. */
3856
+ generalShippingCalculationError?: Details;
3857
+ /** Carrier errors. */
3858
+ carrierErrors?: CarrierErrors;
3859
+ /** Tax calculation error. */
3860
+ taxCalculationError?: Details;
3861
+ /** Coupon calculation error. */
3862
+ couponCalculationError?: Details;
3863
+ /** Gift card calculation error. */
3864
+ giftCardCalculationError?: Details;
3865
+ /** Order validation errors. */
3866
+ orderValidationErrors?: ApplicationError[];
3867
+ /**
3868
+ * Membership payment methods calculation errors
3869
+ * For example, will indicate that a line item that must be paid with membership payment doesn't have one or selected memberships are invalid
3870
+ */
3871
+ membershipError?: Details;
3872
+ /** Discount Rule calculation error. */
3873
+ discountsCalculationError?: Details;
3874
+ }
3875
+ /** @oneof */
3876
+ interface CalculationErrorsShippingCalculationErrorOneOf {
3877
+ /** General shipping calculation error. */
3878
+ generalShippingCalculationError?: Details;
3879
+ /** Carrier errors. */
3880
+ carrierErrors?: CarrierErrors;
3881
+ }
3882
+ interface Details extends DetailsKindOneOf {
3883
+ applicationError?: ApplicationError;
3884
+ validationError?: ValidationError;
3885
+ systemError?: SystemError;
3886
+ /**
3887
+ * deprecated in API's - to enable migration from rendering arbitrary tracing to rest response
3888
+ * @deprecated
3889
+ */
3890
+ tracing?: Record<string, string>;
3891
+ }
3892
+ /** @oneof */
3893
+ interface DetailsKindOneOf {
3894
+ applicationError?: ApplicationError;
3895
+ validationError?: ValidationError;
3896
+ systemError?: SystemError;
3897
+ }
3898
+ interface ApplicationError {
3899
+ /** Error code. */
3900
+ code?: string;
3901
+ /** Description of the error. */
3902
+ description?: string;
3903
+ /** Data related to the error. */
3904
+ data?: Record<string, any> | null;
3905
+ }
3906
+ /**
3907
+ * example result:
3908
+ * {
3909
+ * "fieldViolations": [
3910
+ * {
3911
+ * "field": "fieldA",
3912
+ * "description": "invalid music note. supported notes: [do,re,mi,fa,sol,la,ti]",
3913
+ * "violatedRule": "OTHER",
3914
+ * "ruleName": "INVALID_NOTE",
3915
+ * "data": {
3916
+ * "value": "FI"
3917
+ * }
3918
+ * },
3919
+ * {
3920
+ * "field": "fieldB",
3921
+ * "description": "field value out of range. supported range: [0-20]",
3922
+ * "violatedRule": "MAX",
3923
+ * "data": {
3924
+ * "threshold": 20
3925
+ * }
3926
+ * },
3927
+ * {
3928
+ * "field": "fieldC",
3929
+ * "description": "invalid phone number. provide a valid phone number of size: [7-12], supported characters: [0-9, +, -, (, )]",
3930
+ * "violatedRule": "FORMAT",
3931
+ * "data": {
3932
+ * "type": "PHONE"
3933
+ * }
3934
+ * }
3935
+ * ]
3936
+ * }
3937
+ */
3938
+ interface ValidationError {
3939
+ fieldViolations?: FieldViolation[];
3940
+ }
3941
+ declare enum RuleType {
3942
+ VALIDATION = "VALIDATION",
3943
+ OTHER = "OTHER",
3944
+ MAX = "MAX",
3945
+ MIN = "MIN",
3946
+ MAX_LENGTH = "MAX_LENGTH",
3947
+ MIN_LENGTH = "MIN_LENGTH",
3948
+ MAX_SIZE = "MAX_SIZE",
3949
+ MIN_SIZE = "MIN_SIZE",
3950
+ FORMAT = "FORMAT",
3951
+ DECIMAL_LTE = "DECIMAL_LTE",
3952
+ DECIMAL_GTE = "DECIMAL_GTE",
3953
+ DECIMAL_LT = "DECIMAL_LT",
3954
+ DECIMAL_GT = "DECIMAL_GT",
3955
+ DECIMAL_MAX_SCALE = "DECIMAL_MAX_SCALE",
3956
+ INVALID_ENUM_VALUE = "INVALID_ENUM_VALUE",
3957
+ REQUIRED_FIELD = "REQUIRED_FIELD",
3958
+ FIELD_NOT_ALLOWED = "FIELD_NOT_ALLOWED",
3959
+ ONE_OF_ALIGNMENT = "ONE_OF_ALIGNMENT"
3960
+ }
3961
+ interface FieldViolation {
3962
+ field?: string;
3963
+ description?: string;
3964
+ violatedRule?: RuleType;
3965
+ /** applicable when violated_rule=OTHER */
3966
+ ruleName?: string | null;
3967
+ data?: Record<string, any> | null;
3968
+ }
3969
+ interface SystemError {
3970
+ /** Error code. */
3971
+ errorCode?: string | null;
3972
+ }
3973
+ interface CarrierErrors {
3974
+ /** Carrier errors. */
3975
+ errors?: CarrierError[];
3976
+ }
3977
+ interface CarrierError {
3978
+ /** Carrier ID. */
3979
+ carrierId?: string;
3980
+ /** Error details. */
3981
+ error?: Details;
3982
+ }
3983
+ interface GiftCard$1 {
3984
+ /**
3985
+ * Gift Card ID.
3986
+ * @deprecated
3987
+ */
3988
+ _id?: string;
3989
+ /** Gift card obfuscated code. */
3990
+ obfuscatedCode?: string;
3991
+ /** Gift card value. */
3992
+ amount?: MultiCurrencyPrice$1;
3993
+ /** App ID of the gift card provider. */
3994
+ appId?: string;
3995
+ }
3996
+ interface V1AppliedDiscount extends V1AppliedDiscountDiscountSourceOneOf {
3997
+ /** Coupon details. */
3998
+ coupon?: V1Coupon;
3999
+ /** Merchant discount. */
4000
+ merchantDiscount?: V1MerchantDiscount;
4001
+ /** Discount rule */
4002
+ discountRule?: V1DiscountRule;
4003
+ /** Discount type. */
4004
+ discountType?: AppliedDiscountDiscountType;
4005
+ /**
4006
+ * IDs of line items the discount applies to.
4007
+ * @deprecated IDs of line items the discount applies to.
4008
+ * @replacedBy line_items_discounts
4009
+ * @targetRemovalDate 2024-06-01
4010
+ */
4011
+ lineItemIds?: string[];
4012
+ }
4013
+ /** @oneof */
4014
+ interface V1AppliedDiscountDiscountSourceOneOf {
4015
+ /** Coupon details. */
4016
+ coupon?: V1Coupon;
4017
+ /** Merchant discount. */
4018
+ merchantDiscount?: V1MerchantDiscount;
4019
+ /** Discount rule */
4020
+ discountRule?: V1DiscountRule;
4021
+ }
4022
+ declare enum AppliedDiscountDiscountType {
4023
+ GLOBAL = "GLOBAL",
4024
+ SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
4025
+ SHIPPING = "SHIPPING"
4026
+ }
4027
+ /** Coupon */
4028
+ interface V1Coupon {
4029
+ /** Coupon ID. */
4030
+ _id?: string;
4031
+ /** Coupon code. */
4032
+ code?: string;
4033
+ /** Coupon value. */
4034
+ amount?: MultiCurrencyPrice$1;
4035
+ /** Coupon name. */
4036
+ name?: string;
4037
+ }
4038
+ interface V1MerchantDiscount {
4039
+ /** Discount value. */
4040
+ amount?: MultiCurrencyPrice$1;
4041
+ /** Discount Percentage. Will be calculated from items price before other discounts. */
4042
+ percentage?: number | null;
4043
+ }
4044
+ interface V1DiscountRule {
4045
+ /** Discount rule ID */
4046
+ _id?: string;
4047
+ /** Discount rule name */
4048
+ name?: V1DiscountRuleName;
4049
+ /** Discount value. */
4050
+ amount?: MultiCurrencyPrice$1;
4051
+ }
4052
+ interface V1DiscountRuleName {
4053
+ /** Original discount rule name (in site's default language). */
4054
+ original?: string;
4055
+ /** Translated discount rule name according to buyer language. Defaults to `original` when not provided. */
4056
+ translated?: string | null;
4057
+ }
4058
+ interface V1LineItemDiscount {
4059
+ /** ID of line item the discount applies to. */
4060
+ _id?: string;
4061
+ /** Discount value. */
4062
+ totalDiscountAmount?: MultiCurrencyPrice$1;
4063
+ }
4064
+ interface TaxSummary {
4065
+ /**
4066
+ * Amount for which tax is calculated, added from line items.
4067
+ * @readonly
4068
+ */
4069
+ taxableAmount?: MultiCurrencyPrice$1;
4070
+ /**
4071
+ * Calculated tax, added from line items.
4072
+ * @readonly
4073
+ */
4074
+ totalTax?: MultiCurrencyPrice$1;
4075
+ /**
4076
+ * Tax calculator that was active when the order was created.
4077
+ * @deprecated
4078
+ */
4079
+ calculationDetails?: TaxCalculationDetails;
4080
+ }
4081
+ interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsOneOf {
4082
+ /** Reason the manual calculation was used. */
4083
+ manualRateReason?: ManualCalculationReason;
4084
+ /** Details of the fallback rate calculation. */
4085
+ autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails;
4086
+ /** Rate calculation type. */
4087
+ rateType?: RateType;
4088
+ }
4089
+ /** @oneof */
4090
+ interface TaxCalculationDetailsCalculationDetailsOneOf {
4091
+ /** Reason the manual calculation was used. */
4092
+ manualRateReason?: ManualCalculationReason;
4093
+ /** Details of the fallback rate calculation. */
4094
+ autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails;
4095
+ }
4096
+ declare enum RateType {
4097
+ /** no tax being collected for this request due to location of purchase */
4098
+ NO_TAX_COLLECTED = "NO_TAX_COLLECTED",
4099
+ /** manual rate used for calculation */
4100
+ MANUAL_RATE = "MANUAL_RATE",
4101
+ /** autotax rate used for calculation */
4102
+ AUTO_RATE = "AUTO_RATE",
4103
+ /** fallback rate used for calculation */
4104
+ FALLBACK_RATE = "FALLBACK_RATE"
4105
+ }
4106
+ declare enum ManualCalculationReason {
4107
+ /** user set calculator in Business Manager to be Manual */
4108
+ GLOBAL_SETTING_TO_MANUAL = "GLOBAL_SETTING_TO_MANUAL",
4109
+ /** specific region is on manual even though Global setting is Auto-tax */
4110
+ REGION_SETTING_TO_MANUAL = "REGION_SETTING_TO_MANUAL"
4111
+ }
4112
+ interface AutoTaxFallbackCalculationDetails {
4113
+ /** reason for fallback */
4114
+ fallbackReason?: FallbackReason;
4115
+ /** invalid request (i.e. address), timeout, internal error, license error, and others will be encoded here */
4116
+ error?: ApplicationError;
4117
+ }
4118
+ declare enum FallbackReason {
4119
+ /** auto-tax failed to be calculated */
4120
+ AUTO_TAX_FAILED = "AUTO_TAX_FAILED",
4121
+ /** auto-tax was temporarily deactivated on a system-level */
4122
+ AUTO_TAX_DEACTIVATED = "AUTO_TAX_DEACTIVATED"
4123
+ }
4124
+ /**
4125
+ * The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate.
4126
+ * Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
4127
+ */
4128
+ interface AggregatedTaxBreakdown {
4129
+ /** The name of the tax against which this tax amount was calculated. */
4130
+ taxName?: string;
4131
+ /** The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws. */
4132
+ taxType?: string;
4133
+ /** The name of the jurisdiction in which this tax detail applies. */
4134
+ jurisdiction?: string;
4135
+ /** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
4136
+ jurisdictionTypeEnum?: V1JurisdictionType;
4137
+ /** The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.000 signifies 200% tax. (Decimal value) */
4138
+ rate?: string;
4139
+ /** The sum of all the tax from line items that calculated by the tax identifiers. */
4140
+ aggregatedTaxAmount?: MultiCurrencyPrice$1;
4141
+ }
4142
+ interface CreatedBy extends CreatedByIdOneOf {
4143
+ /**
4144
+ * User ID - when the order was created by a Wix user on behalf of a buyer.
4145
+ * For example, via POS (point of service).
4146
+ */
4147
+ userId?: string;
4148
+ /** Member ID - when the order was created by a **logged in** site visitor. */
4149
+ memberId?: string;
4150
+ /** Visitor ID - when the order was created by a site visitor that was **not** logged in. */
4151
+ visitorId?: string;
4152
+ /** App ID - when the order was created by an external application or Wix service. */
4153
+ appId?: string;
4154
+ }
4155
+ /** @oneof */
4156
+ interface CreatedByIdOneOf {
4157
+ /**
4158
+ * User ID - when the order was created by a Wix user on behalf of a buyer.
4159
+ * For example, via POS (point of service).
4160
+ */
4161
+ userId?: string;
4162
+ /** Member ID - when the order was created by a **logged in** site visitor. */
4163
+ memberId?: string;
4164
+ /** Visitor ID - when the order was created by a site visitor that was **not** logged in. */
4165
+ visitorId?: string;
4166
+ /** App ID - when the order was created by an external application or Wix service. */
4167
+ appId?: string;
4168
+ }
4169
+ /** Reserved for internal use. */
4170
+ interface MembershipOptions {
4171
+ /**
4172
+ * Reserved for internal use.
4173
+ * @readonly
4174
+ */
4175
+ eligibleMemberships?: Membership[];
4176
+ /**
4177
+ * Reserved for internal use.
4178
+ * @readonly
4179
+ */
4180
+ invalidMemberships?: InvalidMembership[];
4181
+ /** Selected membership to apply to this checkout. */
4182
+ selectedMemberships?: SelectedMemberships;
4183
+ }
4184
+ interface Membership {
4185
+ /** Membership ID. */
4186
+ _id?: string;
4187
+ /** ID of the application providing this payment option. */
4188
+ appId?: string;
4189
+ /** The name of this membership. */
4190
+ name?: MembershipName;
4191
+ /** Line item IDs which are "paid" for by this membership. */
4192
+ lineItemIds?: string[];
4193
+ /** Optional - For a membership that has limited credits, information about credit usage. */
4194
+ credits?: MembershipPaymentCredits;
4195
+ /** Optional - TMembership expiry date. */
4196
+ expirationDate?: Date;
4197
+ /** Additional data about this membership. */
4198
+ additionalData?: Record<string, any> | null;
4199
+ }
4200
+ interface MembershipName {
4201
+ /** The name of this membership */
4202
+ original?: string;
4203
+ /** Optional - Translated name of this membership. Defaults to `original` when not provided. */
4204
+ translated?: string | null;
4205
+ }
4206
+ interface MembershipPaymentCredits {
4207
+ /** How much credit this membership has in total */
4208
+ total?: number;
4209
+ /** How much credit remained for this membership */
4210
+ remaining?: number;
4211
+ }
4212
+ interface InvalidMembership {
4213
+ /** Membership details. */
4214
+ membership?: Membership;
4215
+ /** Reason why this membership is invalid and cannot be used. */
4216
+ reason?: string;
4217
+ }
4218
+ interface SelectedMemberships {
4219
+ /** Selected memberships. */
4220
+ memberships?: SelectedMembership[];
4221
+ }
4222
+ interface SelectedMembership {
4223
+ /** Membership ID. */
4224
+ _id?: string;
4225
+ /** ID of the app providing this payment option. */
4226
+ appId?: string;
4227
+ /** IDs of the line items this membership applies to. */
4228
+ lineItemIds?: string[];
4229
+ }
4230
+ interface V1AdditionalFee {
4231
+ /** Additional fee's unique code (or ID) for future processing. */
4232
+ code?: string | null;
4233
+ /** Translated additional fee's name. */
4234
+ name?: string;
4235
+ /** Additional fee's price. */
4236
+ price?: MultiCurrencyPrice$1;
4237
+ /** Tax details. */
4238
+ taxDetails?: ItemTaxFullDetails$1;
4239
+ /** Provider's app id. */
4240
+ providerAppId?: string | null;
4241
+ /** Additional fee's price before tax. */
4242
+ priceBeforeTax?: MultiCurrencyPrice$1;
4243
+ /** Additional fee's price after tax. */
4244
+ priceAfterTax?: MultiCurrencyPrice$1;
4245
+ /**
4246
+ * Optional - Line items associated with this additional fee.
4247
+ * If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
4248
+ */
4249
+ lineItemIds?: string[];
4250
+ }
4251
+ interface ConversionInfo {
4252
+ /**
4253
+ * The site currency.
4254
+ * @readonly
4255
+ */
4256
+ siteCurrency?: string;
4257
+ /**
4258
+ * The rate used when converting from the site currency to the checkout currency.
4259
+ * @readonly
4260
+ */
4261
+ conversionRate?: string;
4262
+ }
4263
+ interface Violation$1 {
4264
+ /** Severity of the violation. The violations are shown on the cart and checkout pages. A warning is displayed as yellow, and allows a site visitor to proceed with caution. An error is displayed as red, and doesn't allow a site visitor to proceed with the eCommerce flow. */
4265
+ severity?: Severity$1;
4266
+ /** Target location on a checkout or cart page where the violation will be displayed. */
4267
+ target?: Target$1;
4268
+ /** Violation description. Can include rich text. Only HTTP or HTTPS links in the following format are allowed: `<a href="https://www.wix.com">Click me</a>`. */
4269
+ description?: string | null;
4270
+ }
4271
+ declare enum Severity$1 {
4272
+ /** The user is allowed to move forward in the flow. */
4273
+ WARNING = "WARNING",
4274
+ /**
4275
+ * The user is blocked from moving forward in the flow.
4276
+ * For example, if callerContext is CART - moving to checkout is blocked. if callerContext is CHECKOUT, placing an order is blocked.
4277
+ */
4278
+ ERROR = "ERROR"
4279
+ }
4280
+ interface Target$1 extends TargetTargetTypeOneOf$1 {
4281
+ /** General (other) violation. */
4282
+ other?: Other$1;
4283
+ /** Specific line item violation. */
4284
+ lineItem?: TargetLineItem$1;
4285
+ }
4286
+ /** @oneof */
4287
+ interface TargetTargetTypeOneOf$1 {
4288
+ /** General (other) violation. */
4289
+ other?: Other$1;
4290
+ /** Specific line item violation. */
4291
+ lineItem?: TargetLineItem$1;
4292
+ }
4293
+ /** Available locations on the webpage */
4294
+ declare enum NameInOther$1 {
4295
+ /** default location, in case no specific location is specified */
4296
+ OTHER_DEFAULT = "OTHER_DEFAULT"
4297
+ }
4298
+ /** Available locations on the line item */
4299
+ declare enum NameInLineItem$1 {
4300
+ /** default location, in case no specific location is specified */
4301
+ LINE_ITEM_DEFAULT = "LINE_ITEM_DEFAULT"
4302
+ }
4303
+ /** General (other) violation. */
4304
+ interface Other$1 {
4305
+ /** Location on a checkout or a cart page where a general (other) violation will be displayed. */
4306
+ name?: NameInOther$1;
4307
+ }
4308
+ /** Specific line item violation. */
4309
+ interface TargetLineItem$1 {
4310
+ /** Location on a checkout or a cart page where the specific line item violation will be displayed. */
4311
+ name?: NameInLineItem$1;
4312
+ /** ID of the line item containing the violation. */
4313
+ _id?: string | null;
4314
+ }
4315
+ interface CustomSettings {
4316
+ /**
4317
+ * Whether to restrict the option to add or remove a gift card on the checkout page.
4318
+ *
4319
+ * Default: `false`
4320
+ */
4321
+ lockGiftCard?: boolean;
4322
+ /**
4323
+ * Whether to restrict the option to add or remove a coupon code on the checkout page.
4324
+ *
4325
+ * Default: `false`
4326
+ */
4327
+ lockCouponCode?: boolean;
4328
+ /**
4329
+ * Whether to disable policy agreement checkout in the checkout page
4330
+ *
4331
+ * Default: `false`
4332
+ */
4333
+ disabledPolicyAgreementCheckbox?: boolean;
4334
+ /**
4335
+ * Whether to disable manual payment option for this checkout.
4336
+ *
4337
+ * Default: `false`
4338
+ */
4339
+ disabledManualPayment?: boolean;
4340
+ }
4341
+ interface CustomContentReference {
4342
+ /**
4343
+ * ID of the app providing the content.
4344
+ *
4345
+ * You can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).
4346
+ */
4347
+ appId?: string;
4348
+ /**
4349
+ * ID of the component within the app it belongs to.
4350
+ *
4351
+ * You can get your component's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).
4352
+ */
4353
+ componentId?: string;
4354
+ }
4355
+ interface ExternalReference$1 {
4356
+ /**
4357
+ * ID of the app associated with the purchase flow.
4358
+ * For example, the Wix Pay Links app ID.
4359
+ */
4360
+ appId?: string;
4361
+ /**
4362
+ * Reference to an external resource ID. Used to link the purchase flow to a specific entity in an external system.
4363
+ * For example, a Wix Pay Link ID.
4364
+ */
4365
+ resourceId?: string | null;
4366
+ }
4367
+ interface GetPaymentSettingsForCheckoutResponse {
4368
+ /** Blocked payment options. */
4369
+ blockedPaymentOptions?: PaymentOption[];
4370
+ }
4371
+ declare enum PaymentOption {
4372
+ UNKNOWN_PAYMENT_OPTION = "UNKNOWN_PAYMENT_OPTION",
4373
+ MANUAL = "MANUAL"
4374
+ }
4375
+ interface PaymentSettingsSPIConfig {
4376
+ /**
4377
+ * *Required.** Base URI where the endpoints are called. Wix eCommerce appends the endpoint path to the base URI.
4378
+ * For example, to call the Get Payment Settings endpoint at `https://my-payment-settings.com/v1/payment-settings`,
4379
+ * the base URI you provide here is `https://my-payment-settings.com/`.
4380
+ */
4381
+ deploymentUri?: string;
4382
+ /**
4383
+ * The value to set for `paymentSettings.requires3dSecure` if the service plugin call fails.
4384
+ *
4385
+ * Default: `false`
4386
+ */
4387
+ fallbackValueForRequires3dSecure?: boolean;
4388
+ /**
4389
+ * `true` if SPI implementer provides payments settings for checkout
4390
+ *
4391
+ * Default: `false`
4392
+ */
4393
+ providePaymentsSettingsForCheckout?: boolean;
4394
+ }
4395
+ /**
4396
+ * this message is not directly used by any service,
4397
+ * it exists to describe the expected parameters that SHOULD be provided to invoked Velo methods as part of open-platform.
4398
+ * e.g. SPIs, event-handlers, etc..
4399
+ * NOTE: this context object MUST be provided as the last argument in each Velo method signature.
4400
+ *
4401
+ * Example:
4402
+ * ```typescript
4403
+ * export function wixStores_onOrderCanceled({ event, metadata }: OrderCanceledEvent) {
4404
+ * ...
4405
+ * }
4406
+ * ```
4407
+ */
4408
+ interface Context$1 {
4409
+ /** A unique identifier of the request. You may print this ID to your logs to help with future debugging and easier correlation with Wix's logs. */
4410
+ requestId?: string | null;
4411
+ /** [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 3-letter currency code. */
4412
+ currency?: string | null;
4413
+ /** An object that describes the identity that triggered this request. */
4414
+ identity?: IdentificationData$1;
4415
+ /** A string representing a language and region in the format of `"xx-XX"`. First 2 letters represent the language code according to ISO 639-1. This is followed by a dash "-", and then a by 2 capital letters representing the region according to ISO 3166-2. For example, `"en-US"`. */
4416
+ languages?: string[];
4417
+ /** The service provider app's instance ID. */
4418
+ instanceId?: string | null;
4419
+ }
4420
+ declare enum IdentityType$1 {
4421
+ UNKNOWN = "UNKNOWN",
4422
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
4423
+ MEMBER = "MEMBER",
4424
+ WIX_USER = "WIX_USER",
4425
+ APP = "APP"
4426
+ }
4427
+ interface IdentificationData$1 extends IdentificationDataIdOneOf$1 {
4428
+ /** ID of a site visitor that has not logged in to the site. */
4429
+ anonymousVisitorId?: string;
4430
+ /** ID of a site visitor that has logged in to the site. */
4431
+ memberId?: string;
4432
+ /** ID of a Wix user (site owner, contributor, etc.). */
4433
+ wixUserId?: string;
4434
+ /** ID of an app. */
4435
+ appId?: string;
4436
+ /** @readonly */
4437
+ identityType?: IdentityType$1;
4438
+ }
4439
+ /** @oneof */
4440
+ interface IdentificationDataIdOneOf$1 {
4441
+ /** ID of a site visitor that has not logged in to the site. */
4442
+ anonymousVisitorId?: string;
4443
+ /** ID of a site visitor that has logged in to the site. */
4444
+ memberId?: string;
4445
+ /** ID of a Wix user (site owner, contributor, etc.). */
4446
+ wixUserId?: string;
4447
+ /** ID of an app. */
4448
+ appId?: string;
4449
+ }
4450
+
4451
+ interface GetPaymentSettingsEnvelope {
4452
+ request: GetPaymentSettingsRequest;
4453
+ metadata: Context$1;
4454
+ }
4455
+ interface GetPaymentSettingsForCheckoutEnvelope {
4456
+ request: GetPaymentSettingsForCheckoutRequest;
4457
+ metadata: Context$1;
4458
+ }
4459
+ declare const provideHandlers$3: ServicePluginDefinition<{
4460
+ /**
4461
+ *
4462
+ * This method retrieves payment settings from your app.
4463
+ *
4464
+ * Wix calls this method during the payment process. For example, when a customer inserts credit card details and places an order.
4465
+ * This method retrieves the payment settings to apply, and Wix passes on the settings to the payment provider. */
4466
+ getPaymentSettings(payload: GetPaymentSettingsEnvelope): GetPaymentSettingsResponse | Promise<GetPaymentSettingsResponse>;
4467
+ /**
4468
+ * Returns payment settings for provided Checkout entity. */
4469
+ getPaymentSettingsForCheckout(payload: GetPaymentSettingsForCheckoutEnvelope): GetPaymentSettingsForCheckoutResponse | Promise<GetPaymentSettingsForCheckoutResponse>;
3214
4470
  }>;
3215
4471
 
3216
4472
  declare function createServicePluginModule$1<T extends ServicePluginDefinition<any>>(servicePluginDefinition: T): BuildServicePluginDefinition<T> & T;
@@ -3223,22 +4479,42 @@ type context$1_ActivityContentOneOf = ActivityContentOneOf;
3223
4479
  type context$1_ActivityType = ActivityType;
3224
4480
  declare const context$1_ActivityType: typeof ActivityType;
3225
4481
  type context$1_AdditionalFee = AdditionalFee;
4482
+ type context$1_AggregatedTaxBreakdown = AggregatedTaxBreakdown;
4483
+ type context$1_ApiAddressWithContact = ApiAddressWithContact;
4484
+ type context$1_ApiItemTaxFullDetails = ApiItemTaxFullDetails;
4485
+ type context$1_ApiTaxSummary = ApiTaxSummary;
4486
+ type context$1_ApplicationError = ApplicationError;
4487
+ type context$1_AppliedDiscountDiscountType = AppliedDiscountDiscountType;
4488
+ declare const context$1_AppliedDiscountDiscountType: typeof AppliedDiscountDiscountType;
3226
4489
  type context$1_AttributionSource = AttributionSource;
3227
4490
  declare const context$1_AttributionSource: typeof AttributionSource;
3228
4491
  type context$1_AuthorizedPaymentCaptured = AuthorizedPaymentCaptured;
3229
4492
  type context$1_AuthorizedPaymentCreated = AuthorizedPaymentCreated;
3230
4493
  type context$1_AuthorizedPaymentVoided = AuthorizedPaymentVoided;
4494
+ type context$1_AutoTaxFallbackCalculationDetails = AutoTaxFallbackCalculationDetails;
3231
4495
  type context$1_Balance = Balance;
3232
4496
  type context$1_BalanceSummary = BalanceSummary;
3233
4497
  type context$1_BuyerInfo = BuyerInfo;
3234
4498
  type context$1_BuyerInfoIdOneOf = BuyerInfoIdOneOf;
4499
+ type context$1_CalculationErrors = CalculationErrors;
4500
+ type context$1_CalculationErrorsShippingCalculationErrorOneOf = CalculationErrorsShippingCalculationErrorOneOf;
4501
+ type context$1_CarrierError = CarrierError;
4502
+ type context$1_CarrierErrors = CarrierErrors;
4503
+ type context$1_CarrierServiceOption = CarrierServiceOption;
4504
+ type context$1_CatalogOverrideFields = CatalogOverrideFields;
3235
4505
  type context$1_ChannelInfo = ChannelInfo;
3236
4506
  type context$1_ChannelType = ChannelType;
3237
4507
  declare const context$1_ChannelType: typeof ChannelType;
4508
+ type context$1_ChargeType = ChargeType;
4509
+ declare const context$1_ChargeType: typeof ChargeType;
4510
+ type context$1_Checkout = Checkout;
3238
4511
  type context$1_Color = Color;
4512
+ type context$1_ConversionInfo = ConversionInfo;
3239
4513
  type context$1_CreatedBy = CreatedBy;
3240
- type context$1_CreatedByStringOneOf = CreatedByStringOneOf;
4514
+ type context$1_CreatedByIdOneOf = CreatedByIdOneOf;
3241
4515
  type context$1_CustomActivity = CustomActivity;
4516
+ type context$1_CustomContentReference = CustomContentReference;
4517
+ type context$1_CustomSettings = CustomSettings;
3242
4518
  type context$1_DeliveryLogistics = DeliveryLogistics;
3243
4519
  type context$1_DeliveryLogisticsAddressOneOf = DeliveryLogisticsAddressOneOf;
3244
4520
  type context$1_DeliveryTimeSlot = DeliveryTimeSlot;
@@ -3248,15 +4524,29 @@ type context$1_DescriptionLineName = DescriptionLineName;
3248
4524
  type context$1_DescriptionLineType = DescriptionLineType;
3249
4525
  declare const context$1_DescriptionLineType: typeof DescriptionLineType;
3250
4526
  type context$1_DescriptionLineValueOneOf = DescriptionLineValueOneOf;
4527
+ type context$1_Details = Details;
4528
+ type context$1_DetailsKindOneOf = DetailsKindOneOf;
3251
4529
  type context$1_DigitalFile = DigitalFile;
3252
4530
  type context$1_DiscountReason = DiscountReason;
3253
4531
  declare const context$1_DiscountReason: typeof DiscountReason;
3254
4532
  type context$1_DraftOrderChangesApplied = DraftOrderChangesApplied;
4533
+ type context$1_FallbackReason = FallbackReason;
4534
+ declare const context$1_FallbackReason: typeof FallbackReason;
4535
+ type context$1_FieldViolation = FieldViolation;
4536
+ type context$1_FileType = FileType;
4537
+ declare const context$1_FileType: typeof FileType;
3255
4538
  type context$1_FulfillmentStatus = FulfillmentStatus;
3256
4539
  declare const context$1_FulfillmentStatus: typeof FulfillmentStatus;
3257
4540
  type context$1_FulfillmentStatusesAggregate = FulfillmentStatusesAggregate;
4541
+ type context$1_GetPaymentSettingsForCheckoutRequest = GetPaymentSettingsForCheckoutRequest;
4542
+ type context$1_GetPaymentSettingsForCheckoutResponse = GetPaymentSettingsForCheckoutResponse;
3258
4543
  type context$1_GetPaymentSettingsRequest = GetPaymentSettingsRequest;
3259
4544
  type context$1_GetPaymentSettingsResponse = GetPaymentSettingsResponse;
4545
+ type context$1_Group = Group;
4546
+ type context$1_InvalidMembership = InvalidMembership;
4547
+ type context$1_ItemAvailabilityInfo = ItemAvailabilityInfo;
4548
+ type context$1_ItemAvailabilityStatus = ItemAvailabilityStatus;
4549
+ declare const context$1_ItemAvailabilityStatus: typeof ItemAvailabilityStatus;
3260
4550
  type context$1_LineItemAmount = LineItemAmount;
3261
4551
  type context$1_LineItemChanges = LineItemChanges;
3262
4552
  type context$1_LineItemDiscount = LineItemDiscount;
@@ -3271,6 +4561,12 @@ type context$1_LocationAndQuantity = LocationAndQuantity;
3271
4561
  type context$1_ManagedAdditionalFee = ManagedAdditionalFee;
3272
4562
  type context$1_ManagedDiscount = ManagedDiscount;
3273
4563
  type context$1_ManagedLineItem = ManagedLineItem;
4564
+ type context$1_ManualCalculationReason = ManualCalculationReason;
4565
+ declare const context$1_ManualCalculationReason: typeof ManualCalculationReason;
4566
+ type context$1_Membership = Membership;
4567
+ type context$1_MembershipName = MembershipName;
4568
+ type context$1_MembershipOptions = MembershipOptions;
4569
+ type context$1_MembershipPaymentCredits = MembershipPaymentCredits;
3274
4570
  type context$1_MerchantComment = MerchantComment;
3275
4571
  type context$1_MerchantDiscountMerchantDiscountReasonOneOf = MerchantDiscountMerchantDiscountReasonOneOf;
3276
4572
  type context$1_NewExchangeOrderCreated = NewExchangeOrderCreated;
@@ -3284,6 +4580,9 @@ type context$1_OrderStatus = OrderStatus;
3284
4580
  declare const context$1_OrderStatus: typeof OrderStatus;
3285
4581
  type context$1_OrderTaxBreakdown = OrderTaxBreakdown;
3286
4582
  type context$1_OrderTaxInfo = OrderTaxInfo;
4583
+ type context$1_OtherCharge = OtherCharge;
4584
+ type context$1_PaymentOption = PaymentOption;
4585
+ declare const context$1_PaymentOption: typeof PaymentOption;
3287
4586
  type context$1_PaymentOptionType = PaymentOptionType;
3288
4587
  declare const context$1_PaymentOptionType: typeof PaymentOptionType;
3289
4588
  type context$1_PaymentRefundFailed = PaymentRefundFailed;
@@ -3294,29 +4593,72 @@ type context$1_PaymentStatus = PaymentStatus;
3294
4593
  declare const context$1_PaymentStatus: typeof PaymentStatus;
3295
4594
  type context$1_PickupAddress = PickupAddress;
3296
4595
  type context$1_PickupDetails = PickupDetails;
4596
+ type context$1_PickupDetailsPickupMethod = PickupDetailsPickupMethod;
4597
+ declare const context$1_PickupDetailsPickupMethod: typeof PickupDetailsPickupMethod;
3297
4598
  type context$1_PickupMethod = PickupMethod;
3298
4599
  declare const context$1_PickupMethod: typeof PickupMethod;
3299
4600
  type context$1_PlainTextValue = PlainTextValue;
3300
4601
  type context$1_Price = Price;
3301
4602
  type context$1_PriceDescription = PriceDescription;
4603
+ type context$1_RateType = RateType;
4604
+ declare const context$1_RateType: typeof RateType;
3302
4605
  type context$1_RefundInitiated = RefundInitiated;
3303
4606
  type context$1_RefundedPayment = RefundedPayment;
3304
4607
  type context$1_RefundedPaymentKindOneOf = RefundedPaymentKindOneOf;
3305
4608
  type context$1_RegularPaymentRefund = RegularPaymentRefund;
4609
+ type context$1_RuleType = RuleType;
4610
+ declare const context$1_RuleType: typeof RuleType;
3306
4611
  type context$1_SavedPaymentMethod = SavedPaymentMethod;
4612
+ type context$1_Scope = Scope;
4613
+ type context$1_SecuredMedia = SecuredMedia;
4614
+ type context$1_SelectedCarrierServiceOptionOtherCharge = SelectedCarrierServiceOptionOtherCharge;
4615
+ type context$1_SelectedMembership = SelectedMembership;
4616
+ type context$1_SelectedMemberships = SelectedMemberships;
4617
+ type context$1_ServiceProperties = ServiceProperties;
3307
4618
  type context$1_ShippingInformation = ShippingInformation;
3308
4619
  type context$1_ShippingInformationChange = ShippingInformationChange;
4620
+ type context$1_ShippingOption = ShippingOption;
3309
4621
  type context$1_ShippingPrice = ShippingPrice;
3310
4622
  type context$1_ShippingRegion = ShippingRegion;
3311
4623
  type context$1_SubscriptionInfo = SubscriptionInfo;
4624
+ type context$1_SystemError = SystemError;
3312
4625
  type context$1_TagList = TagList;
3313
4626
  type context$1_Tags = Tags;
4627
+ type context$1_TaxCalculationDetails = TaxCalculationDetails;
4628
+ type context$1_TaxCalculationDetailsCalculationDetailsOneOf = TaxCalculationDetailsCalculationDetailsOneOf;
4629
+ type context$1_TaxRateBreakdown = TaxRateBreakdown;
3314
4630
  type context$1_TaxSummary = TaxSummary;
4631
+ type context$1_TaxableAddress = TaxableAddress;
4632
+ type context$1_TaxableAddressTaxableAddressDataOneOf = TaxableAddressTaxableAddressDataOneOf;
4633
+ type context$1_TaxableAddressType = TaxableAddressType;
4634
+ declare const context$1_TaxableAddressType: typeof TaxableAddressType;
3315
4635
  type context$1_TotalPriceChange = TotalPriceChange;
3316
4636
  type context$1_TranslatedValue = TranslatedValue;
4637
+ type context$1_V1AdditionalFee = V1AdditionalFee;
4638
+ type context$1_V1AppliedDiscount = V1AppliedDiscount;
4639
+ type context$1_V1AppliedDiscountDiscountSourceOneOf = V1AppliedDiscountDiscountSourceOneOf;
4640
+ type context$1_V1BuyerInfo = V1BuyerInfo;
4641
+ type context$1_V1BuyerInfoIdOneOf = V1BuyerInfoIdOneOf;
4642
+ type context$1_V1Coupon = V1Coupon;
4643
+ type context$1_V1CreatedBy = V1CreatedBy;
4644
+ type context$1_V1CreatedByStringOneOf = V1CreatedByStringOneOf;
4645
+ type context$1_V1DeliveryLogistics = V1DeliveryLogistics;
4646
+ type context$1_V1DeliveryTimeSlot = V1DeliveryTimeSlot;
4647
+ type context$1_V1DiscountRule = V1DiscountRule;
4648
+ type context$1_V1DiscountRuleName = V1DiscountRuleName;
4649
+ type context$1_V1JurisdictionType = V1JurisdictionType;
4650
+ declare const context$1_V1JurisdictionType: typeof V1JurisdictionType;
4651
+ type context$1_V1LineItemDiscount = V1LineItemDiscount;
4652
+ type context$1_V1MerchantDiscount = V1MerchantDiscount;
4653
+ type context$1_V1PickupDetails = V1PickupDetails;
4654
+ type context$1_V1PriceSummary = V1PriceSummary;
3317
4655
  type context$1_V1ShippingInformation = V1ShippingInformation;
4656
+ type context$1_V1ShippingPrice = V1ShippingPrice;
4657
+ type context$1_V1ShippingRegion = V1ShippingRegion;
4658
+ type context$1_V1SubscriptionSettings = V1SubscriptionSettings;
4659
+ type context$1_ValidationError = ValidationError;
3318
4660
  declare namespace context$1 {
3319
- export { type context$1_Activity as Activity, type context$1_ActivityContentOneOf as ActivityContentOneOf, context$1_ActivityType as ActivityType, type context$1_AdditionalFee as AdditionalFee, type Address$1 as Address, type AddressLocation$1 as AddressLocation, type AddressWithContact$1 as AddressWithContact, type AppliedDiscount$1 as AppliedDiscount, type AppliedDiscountDiscountSourceOneOf$1 as AppliedDiscountDiscountSourceOneOf, context$1_AttributionSource as AttributionSource, type context$1_AuthorizedPaymentCaptured as AuthorizedPaymentCaptured, type context$1_AuthorizedPaymentCreated as AuthorizedPaymentCreated, type context$1_AuthorizedPaymentVoided as AuthorizedPaymentVoided, type context$1_Balance as Balance, type context$1_BalanceSummary as BalanceSummary, type context$1_BuyerInfo as BuyerInfo, type context$1_BuyerInfoIdOneOf as BuyerInfoIdOneOf, type CatalogReference$1 as CatalogReference, type context$1_ChannelInfo as ChannelInfo, context$1_ChannelType as ChannelType, type context$1_Color as Color, type Context$1 as Context, type Coupon$1 as Coupon, type context$1_CreatedBy as CreatedBy, type context$1_CreatedByStringOneOf as CreatedByStringOneOf, type context$1_CustomActivity as CustomActivity, type CustomField$1 as CustomField, type context$1_DeliveryLogistics as DeliveryLogistics, type context$1_DeliveryLogisticsAddressOneOf as DeliveryLogisticsAddressOneOf, type context$1_DeliveryTimeSlot as DeliveryTimeSlot, type context$1_DescriptionLine as DescriptionLine, type context$1_DescriptionLineDescriptionLineValueOneOf as DescriptionLineDescriptionLineValueOneOf, type context$1_DescriptionLineName as DescriptionLineName, context$1_DescriptionLineType as DescriptionLineType, type context$1_DescriptionLineValueOneOf as DescriptionLineValueOneOf, type context$1_DigitalFile as DigitalFile, context$1_DiscountReason as DiscountReason, type DiscountRule$1 as DiscountRule, type DiscountRuleName$1 as DiscountRuleName, DiscountType$1 as DiscountType, type context$1_DraftOrderChangesApplied as DraftOrderChangesApplied, type ExtendedFields$1 as ExtendedFields, context$1_FulfillmentStatus as FulfillmentStatus, type context$1_FulfillmentStatusesAggregate as FulfillmentStatusesAggregate, type FullAddressContactDetails$1 as FullAddressContactDetails, type context$1_GetPaymentSettingsRequest as GetPaymentSettingsRequest, type context$1_GetPaymentSettingsResponse as GetPaymentSettingsResponse, type IdentificationData$1 as IdentificationData, type IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, IdentityType$1 as IdentityType, type ItemTaxFullDetails$1 as ItemTaxFullDetails, type ItemType$1 as ItemType, ItemTypeItemType$1 as ItemTypeItemType, type ItemTypeItemTypeDataOneOf$1 as ItemTypeItemTypeDataOneOf, JurisdictionType$1 as JurisdictionType, type context$1_LineItemAmount as LineItemAmount, type context$1_LineItemChanges as LineItemChanges, type context$1_LineItemDiscount as LineItemDiscount, type context$1_LineItemExchangeData as LineItemExchangeData, type context$1_LineItemPriceChange as LineItemPriceChange, type context$1_LineItemQuantityChange as LineItemQuantityChange, context$1_LineItemQuantityChangeType as LineItemQuantityChangeType, type context$1_LineItemTaxBreakdown as LineItemTaxBreakdown, type context$1_LineItemTaxInfo as LineItemTaxInfo, type context$1_LocationAndQuantity as LocationAndQuantity, type context$1_ManagedAdditionalFee as ManagedAdditionalFee, type context$1_ManagedDiscount as ManagedDiscount, type context$1_ManagedLineItem as ManagedLineItem, type context$1_MerchantComment as MerchantComment, type MerchantDiscount$1 as MerchantDiscount, type context$1_MerchantDiscountMerchantDiscountReasonOneOf as MerchantDiscountMerchantDiscountReasonOneOf, type context$1_NewExchangeOrderCreated as NewExchangeOrderCreated, type context$1_Order as Order, type context$1_OrderChange as OrderChange, type context$1_OrderChangeValueOneOf as OrderChangeValueOneOf, type context$1_OrderCreatedFromExchange as OrderCreatedFromExchange, type context$1_OrderLineItem as OrderLineItem, type context$1_OrderRefunded as OrderRefunded, context$1_OrderStatus as OrderStatus, type context$1_OrderTaxBreakdown as OrderTaxBreakdown, type context$1_OrderTaxInfo as OrderTaxInfo, context$1_PaymentOptionType as PaymentOptionType, type context$1_PaymentRefundFailed as PaymentRefundFailed, type context$1_PaymentRefunded as PaymentRefunded, type context$1_PaymentSettings as PaymentSettings, type context$1_PaymentSettingsSPIConfig as PaymentSettingsSPIConfig, context$1_PaymentStatus as PaymentStatus, type PhysicalProperties$1 as PhysicalProperties, type context$1_PickupAddress as PickupAddress, type context$1_PickupDetails as PickupDetails, context$1_PickupMethod as PickupMethod, type context$1_PlainTextValue as PlainTextValue, type context$1_Price as Price, type context$1_PriceDescription as PriceDescription, type PriceSummary$1 as PriceSummary, type ProductName$1 as ProductName, type context$1_RefundInitiated as RefundInitiated, type context$1_RefundedPayment as RefundedPayment, type context$1_RefundedPaymentKindOneOf as RefundedPaymentKindOneOf, type context$1_RegularPaymentRefund as RegularPaymentRefund, type context$1_SavedPaymentMethod as SavedPaymentMethod, type context$1_ShippingInformation as ShippingInformation, type context$1_ShippingInformationChange as ShippingInformationChange, type context$1_ShippingPrice as ShippingPrice, type context$1_ShippingRegion as ShippingRegion, type StreetAddress$1 as StreetAddress, SubscriptionFrequency$1 as SubscriptionFrequency, type context$1_SubscriptionInfo as SubscriptionInfo, type SubscriptionSettings$1 as SubscriptionSettings, type context$1_TagList as TagList, type context$1_Tags as Tags, type context$1_TaxSummary as TaxSummary, type context$1_TotalPriceChange as TotalPriceChange, type context$1_TranslatedValue as TranslatedValue, type context$1_V1ShippingInformation as V1ShippingInformation, type VatId$1 as VatId, VatType$1 as VatType, WeightUnit$1 as WeightUnit, type _publicProvideHandlersType$1 as _publicProvideHandlersType, provideHandlers$2 as provideHandlers, provideHandlers$3 as publicProvideHandlers };
4661
+ export { type context$1_Activity as Activity, type context$1_ActivityContentOneOf as ActivityContentOneOf, context$1_ActivityType as ActivityType, type context$1_AdditionalFee as AdditionalFee, type Address$1 as Address, type AddressLocation$1 as AddressLocation, type AddressWithContact$1 as AddressWithContact, type context$1_AggregatedTaxBreakdown as AggregatedTaxBreakdown, type context$1_ApiAddressWithContact as ApiAddressWithContact, type context$1_ApiItemTaxFullDetails as ApiItemTaxFullDetails, type context$1_ApiTaxSummary as ApiTaxSummary, type context$1_ApplicationError as ApplicationError, type AppliedDiscount$1 as AppliedDiscount, type AppliedDiscountDiscountSourceOneOf$1 as AppliedDiscountDiscountSourceOneOf, context$1_AppliedDiscountDiscountType as AppliedDiscountDiscountType, context$1_AttributionSource as AttributionSource, type context$1_AuthorizedPaymentCaptured as AuthorizedPaymentCaptured, type context$1_AuthorizedPaymentCreated as AuthorizedPaymentCreated, type context$1_AuthorizedPaymentVoided as AuthorizedPaymentVoided, type context$1_AutoTaxFallbackCalculationDetails as AutoTaxFallbackCalculationDetails, type context$1_Balance as Balance, type context$1_BalanceSummary as BalanceSummary, type context$1_BuyerInfo as BuyerInfo, type context$1_BuyerInfoIdOneOf as BuyerInfoIdOneOf, type context$1_CalculationErrors as CalculationErrors, type context$1_CalculationErrorsShippingCalculationErrorOneOf as CalculationErrorsShippingCalculationErrorOneOf, type context$1_CarrierError as CarrierError, type context$1_CarrierErrors as CarrierErrors, type context$1_CarrierServiceOption as CarrierServiceOption, type context$1_CatalogOverrideFields as CatalogOverrideFields, type CatalogReference$1 as CatalogReference, type context$1_ChannelInfo as ChannelInfo, context$1_ChannelType as ChannelType, context$1_ChargeType as ChargeType, type context$1_Checkout as Checkout, type context$1_Color as Color, type Context$1 as Context, type context$1_ConversionInfo as ConversionInfo, type Coupon$1 as Coupon, type context$1_CreatedBy as CreatedBy, type context$1_CreatedByIdOneOf as CreatedByIdOneOf, type context$1_CustomActivity as CustomActivity, type context$1_CustomContentReference as CustomContentReference, type CustomField$1 as CustomField, type context$1_CustomSettings as CustomSettings, type context$1_DeliveryLogistics as DeliveryLogistics, type context$1_DeliveryLogisticsAddressOneOf as DeliveryLogisticsAddressOneOf, type context$1_DeliveryTimeSlot as DeliveryTimeSlot, type Description$1 as Description, type context$1_DescriptionLine as DescriptionLine, type context$1_DescriptionLineDescriptionLineValueOneOf as DescriptionLineDescriptionLineValueOneOf, type context$1_DescriptionLineName as DescriptionLineName, context$1_DescriptionLineType as DescriptionLineType, type context$1_DescriptionLineValueOneOf as DescriptionLineValueOneOf, type context$1_Details as Details, type context$1_DetailsKindOneOf as DetailsKindOneOf, type context$1_DigitalFile as DigitalFile, context$1_DiscountReason as DiscountReason, type DiscountRule$1 as DiscountRule, type DiscountRuleName$1 as DiscountRuleName, DiscountType$1 as DiscountType, type context$1_DraftOrderChangesApplied as DraftOrderChangesApplied, type ExtendedFields$1 as ExtendedFields, type ExternalReference$1 as ExternalReference, context$1_FallbackReason as FallbackReason, type context$1_FieldViolation as FieldViolation, context$1_FileType as FileType, context$1_FulfillmentStatus as FulfillmentStatus, type context$1_FulfillmentStatusesAggregate as FulfillmentStatusesAggregate, type FullAddressContactDetails$1 as FullAddressContactDetails, type context$1_GetPaymentSettingsForCheckoutRequest as GetPaymentSettingsForCheckoutRequest, type context$1_GetPaymentSettingsForCheckoutResponse as GetPaymentSettingsForCheckoutResponse, type context$1_GetPaymentSettingsRequest as GetPaymentSettingsRequest, type context$1_GetPaymentSettingsResponse as GetPaymentSettingsResponse, type GiftCard$1 as GiftCard, type context$1_Group as Group, type IdentificationData$1 as IdentificationData, type IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, IdentityType$1 as IdentityType, type context$1_InvalidMembership as InvalidMembership, type context$1_ItemAvailabilityInfo as ItemAvailabilityInfo, context$1_ItemAvailabilityStatus as ItemAvailabilityStatus, type ItemTaxFullDetails$1 as ItemTaxFullDetails, type ItemType$1 as ItemType, ItemTypeItemType$1 as ItemTypeItemType, type ItemTypeItemTypeDataOneOf$1 as ItemTypeItemTypeDataOneOf, JurisdictionType$1 as JurisdictionType, type LineItem$1 as LineItem, type context$1_LineItemAmount as LineItemAmount, type context$1_LineItemChanges as LineItemChanges, type context$1_LineItemDiscount as LineItemDiscount, type context$1_LineItemExchangeData as LineItemExchangeData, type context$1_LineItemPriceChange as LineItemPriceChange, type context$1_LineItemQuantityChange as LineItemQuantityChange, context$1_LineItemQuantityChangeType as LineItemQuantityChangeType, type context$1_LineItemTaxBreakdown as LineItemTaxBreakdown, type context$1_LineItemTaxInfo as LineItemTaxInfo, type context$1_LocationAndQuantity as LocationAndQuantity, type context$1_ManagedAdditionalFee as ManagedAdditionalFee, type context$1_ManagedDiscount as ManagedDiscount, type context$1_ManagedLineItem as ManagedLineItem, context$1_ManualCalculationReason as ManualCalculationReason, type context$1_Membership as Membership, type context$1_MembershipName as MembershipName, type context$1_MembershipOptions as MembershipOptions, type context$1_MembershipPaymentCredits as MembershipPaymentCredits, type context$1_MerchantComment as MerchantComment, type MerchantDiscount$1 as MerchantDiscount, type context$1_MerchantDiscountMerchantDiscountReasonOneOf as MerchantDiscountMerchantDiscountReasonOneOf, type MultiCurrencyPrice$1 as MultiCurrencyPrice, NameInLineItem$1 as NameInLineItem, NameInOther$1 as NameInOther, type context$1_NewExchangeOrderCreated as NewExchangeOrderCreated, type context$1_Order as Order, type context$1_OrderChange as OrderChange, type context$1_OrderChangeValueOneOf as OrderChangeValueOneOf, type context$1_OrderCreatedFromExchange as OrderCreatedFromExchange, type context$1_OrderLineItem as OrderLineItem, type context$1_OrderRefunded as OrderRefunded, context$1_OrderStatus as OrderStatus, type context$1_OrderTaxBreakdown as OrderTaxBreakdown, type context$1_OrderTaxInfo as OrderTaxInfo, type Other$1 as Other, type context$1_OtherCharge as OtherCharge, context$1_PaymentOption as PaymentOption, context$1_PaymentOptionType as PaymentOptionType, type context$1_PaymentRefundFailed as PaymentRefundFailed, type context$1_PaymentRefunded as PaymentRefunded, type context$1_PaymentSettings as PaymentSettings, type context$1_PaymentSettingsSPIConfig as PaymentSettingsSPIConfig, context$1_PaymentStatus as PaymentStatus, type PhysicalProperties$1 as PhysicalProperties, type context$1_PickupAddress as PickupAddress, type context$1_PickupDetails as PickupDetails, context$1_PickupDetailsPickupMethod as PickupDetailsPickupMethod, context$1_PickupMethod as PickupMethod, type context$1_PlainTextValue as PlainTextValue, type context$1_Price as Price, type context$1_PriceDescription as PriceDescription, type PriceSummary$1 as PriceSummary, type ProductName$1 as ProductName, context$1_RateType as RateType, type context$1_RefundInitiated as RefundInitiated, type context$1_RefundedPayment as RefundedPayment, type context$1_RefundedPaymentKindOneOf as RefundedPaymentKindOneOf, type context$1_RegularPaymentRefund as RegularPaymentRefund, context$1_RuleType as RuleType, type context$1_SavedPaymentMethod as SavedPaymentMethod, type context$1_Scope as Scope, type context$1_SecuredMedia as SecuredMedia, type SelectedCarrierServiceOption$1 as SelectedCarrierServiceOption, type context$1_SelectedCarrierServiceOptionOtherCharge as SelectedCarrierServiceOptionOtherCharge, type SelectedCarrierServiceOptionPrices$1 as SelectedCarrierServiceOptionPrices, type context$1_SelectedMembership as SelectedMembership, type context$1_SelectedMemberships as SelectedMemberships, type context$1_ServiceProperties as ServiceProperties, Severity$1 as Severity, type ShippingInfo$1 as ShippingInfo, type context$1_ShippingInformation as ShippingInformation, type context$1_ShippingInformationChange as ShippingInformationChange, type context$1_ShippingOption as ShippingOption, type context$1_ShippingPrice as ShippingPrice, type context$1_ShippingRegion as ShippingRegion, type StreetAddress$1 as StreetAddress, SubscriptionFrequency$1 as SubscriptionFrequency, type context$1_SubscriptionInfo as SubscriptionInfo, type SubscriptionOptionInfo$1 as SubscriptionOptionInfo, type SubscriptionSettings$1 as SubscriptionSettings, type context$1_SystemError as SystemError, type context$1_TagList as TagList, type context$1_Tags as Tags, type Target$1 as Target, type TargetLineItem$1 as TargetLineItem, type TargetTargetTypeOneOf$1 as TargetTargetTypeOneOf, type TaxBreakdown$1 as TaxBreakdown, type context$1_TaxCalculationDetails as TaxCalculationDetails, type context$1_TaxCalculationDetailsCalculationDetailsOneOf as TaxCalculationDetailsCalculationDetailsOneOf, type context$1_TaxRateBreakdown as TaxRateBreakdown, type context$1_TaxSummary as TaxSummary, type context$1_TaxableAddress as TaxableAddress, type context$1_TaxableAddressTaxableAddressDataOneOf as TaxableAddressTaxableAddressDataOneOf, context$1_TaxableAddressType as TaxableAddressType, type Title$1 as Title, type context$1_TotalPriceChange as TotalPriceChange, type context$1_TranslatedValue as TranslatedValue, type context$1_V1AdditionalFee as V1AdditionalFee, type context$1_V1AppliedDiscount as V1AppliedDiscount, type context$1_V1AppliedDiscountDiscountSourceOneOf as V1AppliedDiscountDiscountSourceOneOf, type context$1_V1BuyerInfo as V1BuyerInfo, type context$1_V1BuyerInfoIdOneOf as V1BuyerInfoIdOneOf, type context$1_V1Coupon as V1Coupon, type context$1_V1CreatedBy as V1CreatedBy, type context$1_V1CreatedByStringOneOf as V1CreatedByStringOneOf, type context$1_V1DeliveryLogistics as V1DeliveryLogistics, type context$1_V1DeliveryTimeSlot as V1DeliveryTimeSlot, type context$1_V1DiscountRule as V1DiscountRule, type context$1_V1DiscountRuleName as V1DiscountRuleName, context$1_V1JurisdictionType as V1JurisdictionType, type context$1_V1LineItemDiscount as V1LineItemDiscount, type context$1_V1MerchantDiscount as V1MerchantDiscount, type context$1_V1PickupDetails as V1PickupDetails, type context$1_V1PriceSummary as V1PriceSummary, type context$1_V1ShippingInformation as V1ShippingInformation, type context$1_V1ShippingPrice as V1ShippingPrice, type context$1_V1ShippingRegion as V1ShippingRegion, type context$1_V1SubscriptionSettings as V1SubscriptionSettings, type context$1_ValidationError as ValidationError, type VatId$1 as VatId, VatType$1 as VatType, type Violation$1 as Violation, WeightUnit$1 as WeightUnit, type _publicProvideHandlersType$1 as _publicProvideHandlersType, provideHandlers$2 as provideHandlers, provideHandlers$3 as publicProvideHandlers };
3320
4662
  }
3321
4663
 
3322
4664
  interface GetValidationViolationsRequest {