@wix/auto_sdk_ecom_payment-settings 1.0.32 → 1.0.34

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (69) hide show
  1. package/build/{cjs/src/service-plugins-types.d.ts → index.d.mts} +282 -255
  2. package/build/{internal/cjs/src/service-plugins-types.d.ts → index.d.ts} +282 -255
  3. package/build/index.js +562 -0
  4. package/build/index.js.map +1 -0
  5. package/build/index.mjs +501 -0
  6. package/build/index.mjs.map +1 -0
  7. package/build/{es/src/service-plugins-types.d.ts → internal/index.d.mts} +282 -255
  8. package/build/internal/{es/src/service-plugins-types.d.ts → index.d.ts} +282 -255
  9. package/build/internal/index.js +562 -0
  10. package/build/internal/index.js.map +1 -0
  11. package/build/internal/index.mjs +501 -0
  12. package/build/internal/index.mjs.map +1 -0
  13. package/package.json +12 -11
  14. package/build/cjs/index.d.ts +0 -2
  15. package/build/cjs/index.js +0 -19
  16. package/build/cjs/index.js.map +0 -1
  17. package/build/cjs/index.typings.d.ts +0 -13
  18. package/build/cjs/index.typings.js +0 -18
  19. package/build/cjs/index.typings.js.map +0 -1
  20. package/build/cjs/src/interfaces-ecommerce-v1-payment-settings-provider.context.d.ts +0 -5
  21. package/build/cjs/src/interfaces-ecommerce-v1-payment-settings-provider.context.js +0 -9
  22. package/build/cjs/src/interfaces-ecommerce-v1-payment-settings-provider.context.js.map +0 -1
  23. package/build/cjs/src/interfaces-ecommerce-v1-payment-settings-provider.public.d.ts +0 -22
  24. package/build/cjs/src/interfaces-ecommerce-v1-payment-settings-provider.public.js +0 -161
  25. package/build/cjs/src/interfaces-ecommerce-v1-payment-settings-provider.public.js.map +0 -1
  26. package/build/cjs/src/service-plugins-types.js +0 -419
  27. package/build/cjs/src/service-plugins-types.js.map +0 -1
  28. package/build/es/index.d.ts +0 -2
  29. package/build/es/index.js +0 -3
  30. package/build/es/index.js.map +0 -1
  31. package/build/es/index.typings.d.ts +0 -13
  32. package/build/es/index.typings.js +0 -2
  33. package/build/es/index.typings.js.map +0 -1
  34. package/build/es/src/interfaces-ecommerce-v1-payment-settings-provider.context.d.ts +0 -5
  35. package/build/es/src/interfaces-ecommerce-v1-payment-settings-provider.context.js +0 -6
  36. package/build/es/src/interfaces-ecommerce-v1-payment-settings-provider.context.js.map +0 -1
  37. package/build/es/src/interfaces-ecommerce-v1-payment-settings-provider.public.d.ts +0 -22
  38. package/build/es/src/interfaces-ecommerce-v1-payment-settings-provider.public.js +0 -158
  39. package/build/es/src/interfaces-ecommerce-v1-payment-settings-provider.public.js.map +0 -1
  40. package/build/es/src/service-plugins-types.js +0 -416
  41. package/build/es/src/service-plugins-types.js.map +0 -1
  42. package/build/internal/cjs/index.d.ts +0 -2
  43. package/build/internal/cjs/index.js +0 -19
  44. package/build/internal/cjs/index.js.map +0 -1
  45. package/build/internal/cjs/index.typings.d.ts +0 -13
  46. package/build/internal/cjs/index.typings.js +0 -18
  47. package/build/internal/cjs/index.typings.js.map +0 -1
  48. package/build/internal/cjs/src/interfaces-ecommerce-v1-payment-settings-provider.context.d.ts +0 -5
  49. package/build/internal/cjs/src/interfaces-ecommerce-v1-payment-settings-provider.context.js +0 -9
  50. package/build/internal/cjs/src/interfaces-ecommerce-v1-payment-settings-provider.context.js.map +0 -1
  51. package/build/internal/cjs/src/interfaces-ecommerce-v1-payment-settings-provider.public.d.ts +0 -22
  52. package/build/internal/cjs/src/interfaces-ecommerce-v1-payment-settings-provider.public.js +0 -161
  53. package/build/internal/cjs/src/interfaces-ecommerce-v1-payment-settings-provider.public.js.map +0 -1
  54. package/build/internal/cjs/src/service-plugins-types.js +0 -419
  55. package/build/internal/cjs/src/service-plugins-types.js.map +0 -1
  56. package/build/internal/es/index.d.ts +0 -2
  57. package/build/internal/es/index.js +0 -3
  58. package/build/internal/es/index.js.map +0 -1
  59. package/build/internal/es/index.typings.d.ts +0 -13
  60. package/build/internal/es/index.typings.js +0 -2
  61. package/build/internal/es/index.typings.js.map +0 -1
  62. package/build/internal/es/src/interfaces-ecommerce-v1-payment-settings-provider.context.d.ts +0 -5
  63. package/build/internal/es/src/interfaces-ecommerce-v1-payment-settings-provider.context.js +0 -6
  64. package/build/internal/es/src/interfaces-ecommerce-v1-payment-settings-provider.context.js.map +0 -1
  65. package/build/internal/es/src/interfaces-ecommerce-v1-payment-settings-provider.public.d.ts +0 -22
  66. package/build/internal/es/src/interfaces-ecommerce-v1-payment-settings-provider.public.js +0 -158
  67. package/build/internal/es/src/interfaces-ecommerce-v1-payment-settings-provider.public.js.map +0 -1
  68. package/build/internal/es/src/service-plugins-types.js +0 -416
  69. package/build/internal/es/src/service-plugins-types.js.map +0 -1
@@ -1,8 +1,10 @@
1
- export interface GetPaymentSettingsRequest {
1
+ import { ServicePluginDefinition, BuildServicePluginDefinition } from '@wix/sdk-types';
2
+
3
+ interface GetPaymentSettingsRequest {
2
4
  /** Order. */
3
5
  order?: Order;
4
6
  }
5
- export interface Order {
7
+ interface Order {
6
8
  /**
7
9
  * Order ID.
8
10
  * @format GUID
@@ -175,7 +177,7 @@ export interface Order {
175
177
  */
176
178
  payAfterFreeTrial?: PriceSummary;
177
179
  }
178
- export interface OrderLineItem {
180
+ interface OrderLineItem {
179
181
  /**
180
182
  * Line item ID.
181
183
  * @immutable
@@ -294,7 +296,7 @@ export interface OrderLineItem {
294
296
  */
295
297
  extendedFields?: ExtendedFields;
296
298
  }
297
- export interface ProductName {
299
+ interface ProductName {
298
300
  /**
299
301
  * __Required.__ Item 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).
300
302
  *
@@ -316,7 +318,7 @@ export interface ProductName {
316
318
  translated?: string | null;
317
319
  }
318
320
  /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
319
- export interface CatalogReference {
321
+ interface CatalogReference {
320
322
  /**
321
323
  * ID of the item within the catalog it belongs to.
322
324
  * @minLength 1
@@ -342,7 +344,7 @@ export interface CatalogReference {
342
344
  */
343
345
  options?: Record<string, any> | null;
344
346
  }
345
- export interface Price {
347
+ interface Price {
346
348
  /**
347
349
  * Amount.
348
350
  * @decimalValue options { gte:0, lte:1000000000000000 }
@@ -354,7 +356,7 @@ export interface Price {
354
356
  */
355
357
  formattedAmount?: string;
356
358
  }
357
- export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
359
+ interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
358
360
  /** Description line plain text value. */
359
361
  plainText?: PlainTextValue;
360
362
  /** Description line color value. */
@@ -363,16 +365,16 @@ export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionL
363
365
  name?: DescriptionLineName;
364
366
  }
365
367
  /** @oneof */
366
- export interface DescriptionLineValueOneOf {
368
+ interface DescriptionLineValueOneOf {
367
369
  /** Description line plain text value. */
368
370
  plainText?: PlainTextValue;
369
371
  /** Description line color value. */
370
372
  colorInfo?: Color;
371
373
  }
372
374
  /** @oneof */
373
- export interface DescriptionLineDescriptionLineValueOneOf {
375
+ interface DescriptionLineDescriptionLineValueOneOf {
374
376
  }
375
- export interface DescriptionLineName {
377
+ interface DescriptionLineName {
376
378
  /**
377
379
  * Description line 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).
378
380
  * @maxLength 100
@@ -386,7 +388,7 @@ export interface DescriptionLineName {
386
388
  */
387
389
  translated?: string | null;
388
390
  }
389
- export interface PlainTextValue {
391
+ interface PlainTextValue {
390
392
  /**
391
393
  * Description line plain text value 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).
392
394
  * @maxLength 600
@@ -400,7 +402,7 @@ export interface PlainTextValue {
400
402
  */
401
403
  translated?: string | null;
402
404
  }
403
- export interface Color {
405
+ interface Color {
404
406
  /**
405
407
  * Description line color 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).
406
408
  * @maxLength 500
@@ -416,7 +418,7 @@ export interface Color {
416
418
  /** HEX or RGB color code for display. */
417
419
  code?: string | null;
418
420
  }
419
- export declare enum DescriptionLineType {
421
+ declare enum DescriptionLineType {
420
422
  /** Unrecognized type. */
421
423
  UNRECOGNISED = "UNRECOGNISED",
422
424
  /** Plain text type. */
@@ -424,7 +426,7 @@ export declare enum DescriptionLineType {
424
426
  /** Color type. */
425
427
  COLOR = "COLOR"
426
428
  }
427
- export interface FocalPoint {
429
+ interface FocalPoint {
428
430
  /** X-coordinate of the focal point. */
429
431
  x?: number;
430
432
  /** Y-coordinate of the focal point. */
@@ -434,7 +436,7 @@ export interface FocalPoint {
434
436
  /** crop by width */
435
437
  width?: number | null;
436
438
  }
437
- export interface PhysicalProperties {
439
+ interface PhysicalProperties {
438
440
  /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
439
441
  weight?: number | null;
440
442
  /**
@@ -445,20 +447,20 @@ export interface PhysicalProperties {
445
447
  /** Whether this line item is shippable. */
446
448
  shippable?: boolean;
447
449
  }
448
- export interface ItemType extends ItemTypeItemTypeDataOneOf {
450
+ interface ItemType extends ItemTypeItemTypeDataOneOf {
449
451
  /** Preset item type. */
450
452
  preset?: ItemTypeItemType;
451
453
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
452
454
  custom?: string;
453
455
  }
454
456
  /** @oneof */
455
- export interface ItemTypeItemTypeDataOneOf {
457
+ interface ItemTypeItemTypeDataOneOf {
456
458
  /** Preset item type. */
457
459
  preset?: ItemTypeItemType;
458
460
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
459
461
  custom?: string;
460
462
  }
461
- export declare enum ItemTypeItemType {
463
+ declare enum ItemTypeItemType {
462
464
  UNRECOGNISED = "UNRECOGNISED",
463
465
  PHYSICAL = "PHYSICAL",
464
466
  DIGITAL = "DIGITAL",
@@ -466,7 +468,7 @@ export declare enum ItemTypeItemType {
466
468
  SERVICE = "SERVICE"
467
469
  }
468
470
  /** Type of selected payment option for catalog item */
469
- export declare enum PaymentOptionType {
471
+ declare enum PaymentOptionType {
470
472
  /** The entire payment for this item happens as part of the checkout. */
471
473
  FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
472
474
  /** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
@@ -478,7 +480,7 @@ export declare enum PaymentOptionType {
478
480
  /** 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`. */
479
481
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
480
482
  }
481
- export interface ItemTaxFullDetails {
483
+ interface ItemTaxFullDetails {
482
484
  /** Taxable amount of this line item. */
483
485
  taxableAmount?: Price;
484
486
  /**
@@ -489,7 +491,7 @@ export interface ItemTaxFullDetails {
489
491
  /** The calculated tax, based on the `taxableAmount` and `taxRate`. */
490
492
  totalTax?: Price;
491
493
  }
492
- export interface LineItemTaxInfo {
494
+ interface LineItemTaxInfo {
493
495
  /** Calculated tax, based on `taxable_amount` and `tax_rate`. */
494
496
  taxAmount?: Price;
495
497
  /** Amount for which tax is calculated. */
@@ -517,7 +519,7 @@ export interface LineItemTaxInfo {
517
519
  * TaxBreakdown represents tax information for a line item.
518
520
  * It holds the tax amount and the tax rate for each tax authority that apply on the line item.
519
521
  */
520
- export interface LineItemTaxBreakdown {
522
+ interface LineItemTaxBreakdown {
521
523
  /**
522
524
  * Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec".
523
525
  * @maxLength 200
@@ -550,7 +552,7 @@ export interface LineItemTaxBreakdown {
550
552
  taxableAmount?: Price;
551
553
  }
552
554
  /** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
553
- export declare enum JurisdictionType {
555
+ declare enum JurisdictionType {
554
556
  UNDEFINED = "UNDEFINED",
555
557
  COUNTRY = "COUNTRY",
556
558
  STATE = "STATE",
@@ -558,7 +560,7 @@ export declare enum JurisdictionType {
558
560
  CITY = "CITY",
559
561
  SPECIAL = "SPECIAL"
560
562
  }
561
- export interface DigitalFile {
563
+ interface DigitalFile {
562
564
  /**
563
565
  * ID of the secure file in media.
564
566
  * @minLength 1
@@ -578,7 +580,7 @@ export interface DigitalFile {
578
580
  */
579
581
  expirationDate?: Date | null;
580
582
  }
581
- export interface SubscriptionInfo {
583
+ interface SubscriptionInfo {
582
584
  /**
583
585
  * Subscription ID.
584
586
  * @format GUID
@@ -616,7 +618,7 @@ export interface SubscriptionInfo {
616
618
  */
617
619
  chargesDescription?: string | null;
618
620
  }
619
- export interface SubscriptionTitle {
621
+ interface SubscriptionTitle {
620
622
  /**
621
623
  * 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).
622
624
  * @minLength 1
@@ -632,7 +634,7 @@ export interface SubscriptionTitle {
632
634
  */
633
635
  translated?: string | null;
634
636
  }
635
- export interface SubscriptionDescription {
637
+ interface SubscriptionDescription {
636
638
  /**
637
639
  * Subscription option description.
638
640
  * @maxLength 500
@@ -644,7 +646,7 @@ export interface SubscriptionDescription {
644
646
  */
645
647
  translated?: string | null;
646
648
  }
647
- export interface SubscriptionSettings {
649
+ interface SubscriptionSettings {
648
650
  /** Frequency of recurring payment. */
649
651
  frequency?: SubscriptionFrequency;
650
652
  /**
@@ -666,14 +668,14 @@ export interface SubscriptionSettings {
666
668
  freeTrialPeriod?: FreeTrialPeriod;
667
669
  }
668
670
  /** Frequency unit of recurring payment */
669
- export declare enum SubscriptionFrequency {
671
+ declare enum SubscriptionFrequency {
670
672
  UNDEFINED = "UNDEFINED",
671
673
  DAY = "DAY",
672
674
  WEEK = "WEEK",
673
675
  MONTH = "MONTH",
674
676
  YEAR = "YEAR"
675
677
  }
676
- export interface FreeTrialPeriod {
678
+ interface FreeTrialPeriod {
677
679
  /** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
678
680
  frequency?: SubscriptionFrequency;
679
681
  /**
@@ -683,20 +685,20 @@ export interface FreeTrialPeriod {
683
685
  */
684
686
  interval?: number;
685
687
  }
686
- export interface BillingAdjustment {
688
+ interface BillingAdjustment {
687
689
  /** The type of adjustment. */
688
690
  type?: AdjustmentType;
689
691
  /** Summary of the prorated adjustment amount. */
690
692
  priceSummary?: BillingAdjustmentPriceSummary;
691
693
  }
692
- export declare enum AdjustmentType {
694
+ declare enum AdjustmentType {
693
695
  UNKNOWN_ADJUSTMENT_TYPE = "UNKNOWN_ADJUSTMENT_TYPE",
694
696
  /** Adjustment increases the total amount due to changes like covering extra billing days. Typically results in an additional fee. */
695
697
  EXTRA_CHARGE = "EXTRA_CHARGE",
696
698
  /** Adjustment reduces the total amount due to changes like covering fewer billing days. Typically results in a credit or discount. */
697
699
  CREDIT = "CREDIT"
698
700
  }
699
- export interface BillingAdjustmentPriceSummary {
701
+ interface BillingAdjustmentPriceSummary {
700
702
  /** Subtotal of adjustment, before tax. */
701
703
  subtotal?: Price;
702
704
  /** Tax on adjustment. */
@@ -704,7 +706,7 @@ export interface BillingAdjustmentPriceSummary {
704
706
  /** Total price after tax. */
705
707
  total?: Price;
706
708
  }
707
- export interface PriceDescription {
709
+ interface PriceDescription {
708
710
  /**
709
711
  * __Required.__ Price description 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).
710
712
  * @minLength 1
@@ -720,7 +722,7 @@ export interface PriceDescription {
720
722
  */
721
723
  translated?: string | null;
722
724
  }
723
- export interface LocationAndQuantity {
725
+ interface LocationAndQuantity {
724
726
  /**
725
727
  * Location id in the associated owner app.
726
728
  * @format GUID
@@ -746,22 +748,22 @@ export interface LocationAndQuantity {
746
748
  */
747
749
  name?: string | null;
748
750
  }
749
- export interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
751
+ interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
750
752
  /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
751
753
  addressType?: TaxableAddressType;
752
754
  }
753
755
  /** @oneof */
754
- export interface TaxableAddressTaxableAddressDataOneOf {
756
+ interface TaxableAddressTaxableAddressDataOneOf {
755
757
  /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
756
758
  addressType?: TaxableAddressType;
757
759
  }
758
- export declare enum TaxableAddressType {
760
+ declare enum TaxableAddressType {
759
761
  UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
760
762
  BUSINESS = "BUSINESS",
761
763
  BILLING = "BILLING",
762
764
  SHIPPING = "SHIPPING"
763
765
  }
764
- export interface ExtendedFields {
766
+ interface ExtendedFields {
765
767
  /**
766
768
  * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
767
769
  * The value of each key is structured according to the schema defined when the extended fields were configured.
@@ -772,7 +774,7 @@ export interface ExtendedFields {
772
774
  */
773
775
  namespaces?: Record<string, Record<string, any>>;
774
776
  }
775
- export interface V1ModifierGroup {
777
+ interface V1ModifierGroup {
776
778
  /**
777
779
  * Modifier group id.
778
780
  * @minLength 1
@@ -788,7 +790,7 @@ export interface V1ModifierGroup {
788
790
  */
789
791
  modifiers?: V1ItemModifier[];
790
792
  }
791
- export interface TranslatableString {
793
+ interface TranslatableString {
792
794
  /**
793
795
  * __Required.__ String 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).
794
796
  *
@@ -809,7 +811,7 @@ export interface TranslatableString {
809
811
  */
810
812
  translated?: string | null;
811
813
  }
812
- export interface V1ItemModifier {
814
+ interface V1ItemModifier {
813
815
  /**
814
816
  * Modifier ID.
815
817
  * @minLength 1
@@ -830,7 +832,7 @@ export interface V1ItemModifier {
830
832
  price?: Price;
831
833
  }
832
834
  /** Buyer Info */
833
- export interface V1BuyerInfo extends V1BuyerInfoIdOneOf {
835
+ interface V1BuyerInfo extends V1BuyerInfoIdOneOf {
834
836
  /**
835
837
  * Visitor ID (if site visitor is not a member).
836
838
  * @format GUID
@@ -853,7 +855,7 @@ export interface V1BuyerInfo extends V1BuyerInfoIdOneOf {
853
855
  email?: string | null;
854
856
  }
855
857
  /** @oneof */
856
- export interface V1BuyerInfoIdOneOf {
858
+ interface V1BuyerInfoIdOneOf {
857
859
  /**
858
860
  * Visitor ID (if site visitor is not a member).
859
861
  * @format GUID
@@ -865,7 +867,7 @@ export interface V1BuyerInfoIdOneOf {
865
867
  */
866
868
  memberId?: string;
867
869
  }
868
- export declare enum PaymentStatus {
870
+ declare enum PaymentStatus {
869
871
  UNSPECIFIED = "UNSPECIFIED",
870
872
  /**
871
873
  * `NOT_PAID` can apply to an order made online, but not yet paid. In such cases `order.status` will be `INITIALIZED`.
@@ -906,7 +908,7 @@ export declare enum PaymentStatus {
906
908
  */
907
909
  DECLINED = "DECLINED"
908
910
  }
909
- export declare enum FulfillmentStatus {
911
+ declare enum FulfillmentStatus {
910
912
  /** None of the order items are fulfilled or the order was manually marked as unfulfilled. */
911
913
  NOT_FULFILLED = "NOT_FULFILLED",
912
914
  /**
@@ -917,7 +919,7 @@ export declare enum FulfillmentStatus {
917
919
  /** Some, but not all, of the order items are fulfilled. */
918
920
  PARTIALLY_FULFILLED = "PARTIALLY_FULFILLED"
919
921
  }
920
- export declare enum WeightUnit {
922
+ declare enum WeightUnit {
921
923
  /** Weight unit can't be classified due to an error. */
922
924
  UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
923
925
  /** Kilograms. */
@@ -925,7 +927,7 @@ export declare enum WeightUnit {
925
927
  /** Pounds. */
926
928
  LB = "LB"
927
929
  }
928
- export interface CurrencyConversionDetails {
930
+ interface CurrencyConversionDetails {
929
931
  /**
930
932
  * Currency used for the pricing of this order, in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format.
931
933
  *
@@ -943,7 +945,7 @@ export interface CurrencyConversionDetails {
943
945
  */
944
946
  conversionRate?: string | null;
945
947
  }
946
- export interface PriceSummary {
948
+ interface PriceSummary {
947
949
  /** Subtotal of all the line items, before discounts and before tax. */
948
950
  subtotal?: Price;
949
951
  /** Total shipping price, before discounts and before tax. */
@@ -958,14 +960,14 @@ export interface PriceSummary {
958
960
  totalAdditionalFees?: Price;
959
961
  }
960
962
  /** Billing Info and shipping details */
961
- export interface ApiAddressWithContact {
963
+ interface ApiAddressWithContact {
962
964
  /** Address. */
963
965
  address?: Address;
964
966
  /** Contact details. */
965
967
  contactDetails?: FullAddressContactDetails;
966
968
  }
967
969
  /** Physical address */
968
- export interface Address {
970
+ interface Address {
969
971
  /**
970
972
  * Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
971
973
  * @format COUNTRY
@@ -1009,20 +1011,20 @@ export interface Address {
1009
1011
  */
1010
1012
  subdivisionFullname?: string | null;
1011
1013
  }
1012
- export interface StreetAddress {
1014
+ interface StreetAddress {
1013
1015
  /** Street number. */
1014
1016
  number?: string;
1015
1017
  /** Street name. */
1016
1018
  name?: string;
1017
1019
  }
1018
- export interface AddressLocation {
1020
+ interface AddressLocation {
1019
1021
  /** Address latitude. */
1020
1022
  latitude?: number | null;
1021
1023
  /** Address longitude. */
1022
1024
  longitude?: number | null;
1023
1025
  }
1024
1026
  /** Full contact details for an address */
1025
- export interface FullAddressContactDetails {
1027
+ interface FullAddressContactDetails {
1026
1028
  /**
1027
1029
  * First name.
1028
1030
  * @maxLength 100
@@ -1046,7 +1048,7 @@ export interface FullAddressContactDetails {
1046
1048
  /** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
1047
1049
  vatId?: VatId;
1048
1050
  }
1049
- export interface VatId {
1051
+ interface VatId {
1050
1052
  /** Customer's tax ID. */
1051
1053
  _id?: string;
1052
1054
  /**
@@ -1059,14 +1061,14 @@ export interface VatId {
1059
1061
  type?: VatType;
1060
1062
  }
1061
1063
  /** tax info types */
1062
- export declare enum VatType {
1064
+ declare enum VatType {
1063
1065
  UNSPECIFIED = "UNSPECIFIED",
1064
1066
  /** CPF - for individual tax payers. */
1065
1067
  CPF = "CPF",
1066
1068
  /** CNPJ - for corporations */
1067
1069
  CNPJ = "CNPJ"
1068
1070
  }
1069
- export interface V1ShippingInformation {
1071
+ interface V1ShippingInformation {
1070
1072
  /**
1071
1073
  * App Def Id of external provider which was a source of shipping info
1072
1074
  * @minLength 1
@@ -1092,7 +1094,7 @@ export interface V1ShippingInformation {
1092
1094
  /** Shipping region. */
1093
1095
  region?: ShippingRegion;
1094
1096
  }
1095
- export interface DeliveryLogistics extends DeliveryLogisticsAddressOneOf {
1097
+ interface DeliveryLogistics extends DeliveryLogisticsAddressOneOf {
1096
1098
  /** Shipping address and contact details. */
1097
1099
  shippingDestination?: ApiAddressWithContact;
1098
1100
  /** Pickup details. */
@@ -1116,20 +1118,20 @@ export interface DeliveryLogistics extends DeliveryLogisticsAddressOneOf {
1116
1118
  deliveryTimeSlot?: DeliveryTimeSlot;
1117
1119
  }
1118
1120
  /** @oneof */
1119
- export interface DeliveryLogisticsAddressOneOf {
1121
+ interface DeliveryLogisticsAddressOneOf {
1120
1122
  /** Shipping address and contact details. */
1121
1123
  shippingDestination?: ApiAddressWithContact;
1122
1124
  /** Pickup details. */
1123
1125
  pickupDetails?: PickupDetails;
1124
1126
  }
1125
- export interface PickupDetails {
1127
+ interface PickupDetails {
1126
1128
  /** Pickup address. */
1127
1129
  address?: PickupAddress;
1128
1130
  /** Pickup method */
1129
1131
  pickupMethod?: PickupMethod;
1130
1132
  }
1131
1133
  /** Physical address */
1132
- export interface PickupAddress {
1134
+ interface PickupAddress {
1133
1135
  /**
1134
1136
  * Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
1135
1137
  * @format COUNTRY
@@ -1173,18 +1175,18 @@ export interface PickupAddress {
1173
1175
  */
1174
1176
  subdivisionFullname?: string | null;
1175
1177
  }
1176
- export declare enum PickupMethod {
1178
+ declare enum PickupMethod {
1177
1179
  UNKNOWN_METHOD = "UNKNOWN_METHOD",
1178
1180
  STORE_PICKUP = "STORE_PICKUP",
1179
1181
  PICKUP_POINT = "PICKUP_POINT"
1180
1182
  }
1181
- export interface DeliveryTimeSlot {
1183
+ interface DeliveryTimeSlot {
1182
1184
  /** Delivery slot starting time. */
1183
1185
  from?: Date | null;
1184
1186
  /** Delivery slot ending time. */
1185
1187
  to?: Date | null;
1186
1188
  }
1187
- export interface ShippingPrice {
1189
+ interface ShippingPrice {
1188
1190
  /** Shipping price for display purposes. */
1189
1191
  price?: Price;
1190
1192
  /**
@@ -1205,14 +1207,14 @@ export interface ShippingPrice {
1205
1207
  */
1206
1208
  discount?: Price;
1207
1209
  }
1208
- export interface ShippingRegion {
1210
+ interface ShippingRegion {
1209
1211
  /**
1210
1212
  * Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`.
1211
1213
  * @maxLength 100
1212
1214
  */
1213
1215
  name?: string | null;
1214
1216
  }
1215
- export declare enum OrderStatus {
1217
+ declare enum OrderStatus {
1216
1218
  /** Order created, but not yet approved or canceled. */
1217
1219
  INITIALIZED = "INITIALIZED",
1218
1220
  /**
@@ -1237,14 +1239,14 @@ export declare enum OrderStatus {
1237
1239
  */
1238
1240
  REJECTED = "REJECTED"
1239
1241
  }
1240
- export interface TaxSummary {
1242
+ interface TaxSummary {
1241
1243
  /**
1242
1244
  * Total tax.
1243
1245
  * @readonly
1244
1246
  */
1245
1247
  totalTax?: Price;
1246
1248
  }
1247
- export interface OrderTaxInfo {
1249
+ interface OrderTaxInfo {
1248
1250
  /** Calculated tax, added from line items. */
1249
1251
  totalTax?: Price;
1250
1252
  /**
@@ -1264,7 +1266,7 @@ export interface OrderTaxInfo {
1264
1266
  * 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.
1265
1267
  * Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
1266
1268
  */
1267
- export interface OrderTaxBreakdown {
1269
+ interface OrderTaxBreakdown {
1268
1270
  /**
1269
1271
  * The name of the tax against which this tax amount was calculated.
1270
1272
  * @maxLength 200
@@ -1291,7 +1293,7 @@ export interface OrderTaxBreakdown {
1291
1293
  /** The sum of all the tax from line items that calculated by the tax identifiers. */
1292
1294
  aggregatedTaxAmount?: Price;
1293
1295
  }
1294
- export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1296
+ interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1295
1297
  /** Applied coupon info. */
1296
1298
  coupon?: Coupon;
1297
1299
  /** Merchant discount. */
@@ -1324,7 +1326,7 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1324
1326
  _id?: string | null;
1325
1327
  }
1326
1328
  /** @oneof */
1327
- export interface AppliedDiscountDiscountSourceOneOf {
1329
+ interface AppliedDiscountDiscountSourceOneOf {
1328
1330
  /** Applied coupon info. */
1329
1331
  coupon?: Coupon;
1330
1332
  /** Merchant discount. */
@@ -1332,13 +1334,13 @@ export interface AppliedDiscountDiscountSourceOneOf {
1332
1334
  /** Automatic Discount */
1333
1335
  discountRule?: DiscountRule;
1334
1336
  }
1335
- export declare enum DiscountType {
1337
+ declare enum DiscountType {
1336
1338
  GLOBAL = "GLOBAL",
1337
1339
  SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
1338
1340
  SHIPPING = "SHIPPING"
1339
1341
  }
1340
1342
  /** Coupon */
1341
- export interface Coupon {
1343
+ interface Coupon {
1342
1344
  /** Coupon ID. */
1343
1345
  _id?: string;
1344
1346
  /** Coupon code. */
@@ -1348,7 +1350,7 @@ export interface Coupon {
1348
1350
  /** Coupon value. */
1349
1351
  amount?: Price;
1350
1352
  }
1351
- export interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
1353
+ interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
1352
1354
  /**
1353
1355
  * Pre-defined discount reason (optional).
1354
1356
  * * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
@@ -1363,7 +1365,7 @@ export interface MerchantDiscount extends MerchantDiscountMerchantDiscountReason
1363
1365
  amount?: Price;
1364
1366
  }
1365
1367
  /** @oneof */
1366
- export interface MerchantDiscountMerchantDiscountReasonOneOf {
1368
+ interface MerchantDiscountMerchantDiscountReasonOneOf {
1367
1369
  /**
1368
1370
  * Pre-defined discount reason (optional).
1369
1371
  * * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
@@ -1375,12 +1377,12 @@ export interface MerchantDiscountMerchantDiscountReasonOneOf {
1375
1377
  */
1376
1378
  description?: string | null;
1377
1379
  }
1378
- export declare enum DiscountReason {
1380
+ declare enum DiscountReason {
1379
1381
  UNSPECIFIED = "UNSPECIFIED",
1380
1382
  EXCHANGED_ITEMS = "EXCHANGED_ITEMS",
1381
1383
  BILLING_ADJUSTMENT = "BILLING_ADJUSTMENT"
1382
1384
  }
1383
- export interface DiscountRule {
1385
+ interface DiscountRule {
1384
1386
  /**
1385
1387
  * Discount rule ID
1386
1388
  * @format GUID
@@ -1391,7 +1393,7 @@ export interface DiscountRule {
1391
1393
  /** Discount value. */
1392
1394
  amount?: Price;
1393
1395
  }
1394
- export interface DiscountRuleName {
1396
+ interface DiscountRuleName {
1395
1397
  /**
1396
1398
  * Original discount rule name (in site's default language).
1397
1399
  * @minLength 1
@@ -1405,7 +1407,7 @@ export interface DiscountRuleName {
1405
1407
  */
1406
1408
  translated?: string | null;
1407
1409
  }
1408
- export interface LineItemDiscount {
1410
+ interface LineItemDiscount {
1409
1411
  /**
1410
1412
  * ID of line item the discount applies to.
1411
1413
  * @format GUID
@@ -1414,7 +1416,7 @@ export interface LineItemDiscount {
1414
1416
  /** Total discount for this line item. */
1415
1417
  totalDiscount?: Price;
1416
1418
  }
1417
- export interface Activity extends ActivityContentOneOf {
1419
+ interface Activity extends ActivityContentOneOf {
1418
1420
  /** Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`. */
1419
1421
  customActivity?: CustomActivity;
1420
1422
  /** Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`. */
@@ -1442,7 +1444,7 @@ export interface Activity extends ActivityContentOneOf {
1442
1444
  type?: ActivityType;
1443
1445
  }
1444
1446
  /** @oneof */
1445
- export interface ActivityContentOneOf {
1447
+ interface ActivityContentOneOf {
1446
1448
  /** Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`. */
1447
1449
  customActivity?: CustomActivity;
1448
1450
  /** Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`. */
@@ -1450,7 +1452,7 @@ export interface ActivityContentOneOf {
1450
1452
  /** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
1451
1453
  orderRefunded?: OrderRefunded;
1452
1454
  }
1453
- export interface CustomActivity {
1455
+ interface CustomActivity {
1454
1456
  /**
1455
1457
  * ID of the app that created the custom activity.
1456
1458
  * @format GUID
@@ -1465,7 +1467,7 @@ export interface CustomActivity {
1465
1467
  additionalData?: Record<string, string>;
1466
1468
  }
1467
1469
  /** Store owner added a comment */
1468
- export interface MerchantComment {
1470
+ interface MerchantComment {
1469
1471
  /**
1470
1472
  * Merchant comment message.
1471
1473
  * @minLength 1
@@ -1473,7 +1475,7 @@ export interface MerchantComment {
1473
1475
  */
1474
1476
  message?: string;
1475
1477
  }
1476
- export interface OrderRefunded {
1478
+ interface OrderRefunded {
1477
1479
  /** Whether order was refunded manually. For example, via payment provider or using cash. */
1478
1480
  manual?: boolean;
1479
1481
  /** Refund amount. */
@@ -1484,14 +1486,14 @@ export interface OrderRefunded {
1484
1486
  */
1485
1487
  reason?: string;
1486
1488
  }
1487
- export interface OrderCreatedFromExchange {
1489
+ interface OrderCreatedFromExchange {
1488
1490
  /**
1489
1491
  * ID of the original order for which the exchange happened.
1490
1492
  * @format GUID
1491
1493
  */
1492
1494
  originalOrderId?: string;
1493
1495
  }
1494
- export interface NewExchangeOrderCreated {
1496
+ interface NewExchangeOrderCreated {
1495
1497
  /**
1496
1498
  * ID of the new order created as a result of an exchange of items.
1497
1499
  * @format GUID
@@ -1504,7 +1506,7 @@ export interface NewExchangeOrderCreated {
1504
1506
  */
1505
1507
  lineItems?: LineItemExchangeData[];
1506
1508
  }
1507
- export interface LineItemExchangeData {
1509
+ interface LineItemExchangeData {
1508
1510
  /**
1509
1511
  * ID of the exchanged line item.
1510
1512
  * @format GUID
@@ -1517,7 +1519,7 @@ export interface LineItemExchangeData {
1517
1519
  */
1518
1520
  quantity?: number;
1519
1521
  }
1520
- export interface DraftOrderChangesApplied {
1522
+ interface DraftOrderChangesApplied {
1521
1523
  /** Draft order id. */
1522
1524
  draftOrderId?: string;
1523
1525
  /**
@@ -1528,7 +1530,7 @@ export interface DraftOrderChangesApplied {
1528
1530
  /** Changes applied to order. */
1529
1531
  changes?: OrderChange[];
1530
1532
  }
1531
- export interface OrderChange extends OrderChangeValueOneOf {
1533
+ interface OrderChange extends OrderChangeValueOneOf {
1532
1534
  lineItemChanged?: LineItemChanges;
1533
1535
  lineItemAdded?: ManagedLineItem;
1534
1536
  lineItemRemoved?: ManagedLineItem;
@@ -1540,7 +1542,7 @@ export interface OrderChange extends OrderChangeValueOneOf {
1540
1542
  shippingInformationChanged?: ShippingInformationChange;
1541
1543
  }
1542
1544
  /** @oneof */
1543
- export interface OrderChangeValueOneOf {
1545
+ interface OrderChangeValueOneOf {
1544
1546
  lineItemChanged?: LineItemChanges;
1545
1547
  lineItemAdded?: ManagedLineItem;
1546
1548
  lineItemRemoved?: ManagedLineItem;
@@ -1551,7 +1553,7 @@ export interface OrderChangeValueOneOf {
1551
1553
  totalPriceChanged?: TotalPriceChange;
1552
1554
  shippingInformationChanged?: ShippingInformationChange;
1553
1555
  }
1554
- export interface LineItemChanges {
1556
+ interface LineItemChanges {
1555
1557
  /**
1556
1558
  * Line item ID.
1557
1559
  * @format GUID
@@ -1564,7 +1566,7 @@ export interface LineItemChanges {
1564
1566
  /** Item price change. */
1565
1567
  price?: LineItemPriceChange;
1566
1568
  }
1567
- export interface LineItemQuantityChange {
1569
+ interface LineItemQuantityChange {
1568
1570
  /**
1569
1571
  * Item quantity before update.
1570
1572
  * @max 1000000
@@ -1584,19 +1586,19 @@ export interface LineItemQuantityChange {
1584
1586
  /** Type of quantity change: increase or decrease. */
1585
1587
  deltaType?: LineItemQuantityChangeType;
1586
1588
  }
1587
- export declare enum LineItemQuantityChangeType {
1589
+ declare enum LineItemQuantityChangeType {
1588
1590
  /** Quantity increased. */
1589
1591
  QUANTITY_INCREASED = "QUANTITY_INCREASED",
1590
1592
  /** Quantity decreased. */
1591
1593
  QUANTITY_DECREASED = "QUANTITY_DECREASED"
1592
1594
  }
1593
- export interface LineItemPriceChange {
1595
+ interface LineItemPriceChange {
1594
1596
  /** Item price before update. */
1595
1597
  originalPrice?: Price;
1596
1598
  /** Item price after update. */
1597
1599
  newPrice?: Price;
1598
1600
  }
1599
- export interface ManagedLineItem {
1601
+ interface ManagedLineItem {
1600
1602
  /**
1601
1603
  * Line item ID.
1602
1604
  * @format GUID
@@ -1611,7 +1613,7 @@ export interface ManagedLineItem {
1611
1613
  */
1612
1614
  quantity?: number;
1613
1615
  }
1614
- export interface ManagedDiscount {
1616
+ interface ManagedDiscount {
1615
1617
  /**
1616
1618
  * Discount id.
1617
1619
  * @format GUID
@@ -1624,7 +1626,7 @@ export interface ManagedDiscount {
1624
1626
  /** Discount amount. */
1625
1627
  totalAmount?: Price;
1626
1628
  }
1627
- export interface TranslatedValue {
1629
+ interface TranslatedValue {
1628
1630
  /**
1629
1631
  * Value in site default language.
1630
1632
  * @minLength 1
@@ -1636,7 +1638,7 @@ export interface TranslatedValue {
1636
1638
  */
1637
1639
  translated?: string | null;
1638
1640
  }
1639
- export interface LineItemAmount {
1641
+ interface LineItemAmount {
1640
1642
  /**
1641
1643
  * Order line item id
1642
1644
  * @format GUID
@@ -1647,7 +1649,7 @@ export interface LineItemAmount {
1647
1649
  /** Amount associated with this item. (Discount amount for item / additional fee amount for item) */
1648
1650
  amount?: Price;
1649
1651
  }
1650
- export interface ManagedAdditionalFee {
1652
+ interface ManagedAdditionalFee {
1651
1653
  /**
1652
1654
  * Additional fee id.
1653
1655
  * @format GUID
@@ -1660,19 +1662,19 @@ export interface ManagedAdditionalFee {
1660
1662
  /** Additional fee amount. */
1661
1663
  totalAmount?: Price;
1662
1664
  }
1663
- export interface TotalPriceChange {
1665
+ interface TotalPriceChange {
1664
1666
  /** Order’s total price after discounts and tax. Before update */
1665
1667
  originalTotal?: Price;
1666
1668
  /** Order’s total price after discounts and tax. After update */
1667
1669
  newTotal?: Price;
1668
1670
  }
1669
- export interface ShippingInformationChange {
1671
+ interface ShippingInformationChange {
1670
1672
  /** Order’s Shipping Information. Before update */
1671
1673
  originalShippingInfo?: ShippingInformation;
1672
1674
  /** Order’s Shipping Information. After update */
1673
1675
  newShippingInfo?: ShippingInformation;
1674
1676
  }
1675
- export interface ShippingInformation {
1677
+ interface ShippingInformation {
1676
1678
  /** Order’s shipping price. */
1677
1679
  total?: Price;
1678
1680
  /**
@@ -1682,7 +1684,7 @@ export interface ShippingInformation {
1682
1684
  shippingTitle?: string;
1683
1685
  }
1684
1686
  /** Payment method is saved for order */
1685
- export interface SavedPaymentMethod {
1687
+ interface SavedPaymentMethod {
1686
1688
  /**
1687
1689
  * Payment method name
1688
1690
  * @minLength 1
@@ -1696,7 +1698,7 @@ export interface SavedPaymentMethod {
1696
1698
  */
1697
1699
  description?: string | null;
1698
1700
  }
1699
- export interface AuthorizedPaymentCreated {
1701
+ interface AuthorizedPaymentCreated {
1700
1702
  /**
1701
1703
  * Payment ID of payment associated with this activity
1702
1704
  * @format GUID
@@ -1715,7 +1717,7 @@ export interface AuthorizedPaymentCreated {
1715
1717
  */
1716
1718
  brand?: string | null;
1717
1719
  }
1718
- export interface AuthorizedPaymentCaptured {
1720
+ interface AuthorizedPaymentCaptured {
1719
1721
  /**
1720
1722
  * Payment ID of payment associated with this activity
1721
1723
  * @format GUID
@@ -1734,7 +1736,7 @@ export interface AuthorizedPaymentCaptured {
1734
1736
  */
1735
1737
  brand?: string | null;
1736
1738
  }
1737
- export interface AuthorizedPaymentVoided {
1739
+ interface AuthorizedPaymentVoided {
1738
1740
  /**
1739
1741
  * Payment ID of payment associated with this activity
1740
1742
  * @format GUID
@@ -1753,7 +1755,7 @@ export interface AuthorizedPaymentVoided {
1753
1755
  */
1754
1756
  brand?: string | null;
1755
1757
  }
1756
- export interface RefundInitiated {
1758
+ interface RefundInitiated {
1757
1759
  /**
1758
1760
  * Refund ID.
1759
1761
  * @format GUID
@@ -1769,11 +1771,11 @@ export interface RefundInitiated {
1769
1771
  payments?: RefundedPayment[];
1770
1772
  /**
1771
1773
  * Reason for refund.
1772
- * @maxLength 100
1774
+ * @maxLength 200
1773
1775
  */
1774
1776
  reason?: string | null;
1775
1777
  }
1776
- export interface RefundedPayment extends RefundedPaymentKindOneOf {
1778
+ interface RefundedPayment extends RefundedPaymentKindOneOf {
1777
1779
  /** Regular payment refund. */
1778
1780
  regular?: RegularPaymentRefund;
1779
1781
  /** Gift card payment refund. */
@@ -1789,7 +1791,7 @@ export interface RefundedPayment extends RefundedPaymentKindOneOf {
1789
1791
  externalRefund?: boolean;
1790
1792
  }
1791
1793
  /** @oneof */
1792
- export interface RefundedPaymentKindOneOf {
1794
+ interface RefundedPaymentKindOneOf {
1793
1795
  /** Regular payment refund. */
1794
1796
  regular?: RegularPaymentRefund;
1795
1797
  /** Gift card payment refund. */
@@ -1797,7 +1799,7 @@ export interface RefundedPaymentKindOneOf {
1797
1799
  /** Membership payment refund. */
1798
1800
  membership?: MembershipPaymentRefund;
1799
1801
  }
1800
- export interface RegularPaymentRefund {
1802
+ interface RegularPaymentRefund {
1801
1803
  /** Refund amount */
1802
1804
  amount?: Price;
1803
1805
  /**
@@ -1811,7 +1813,7 @@ export interface RegularPaymentRefund {
1811
1813
  */
1812
1814
  brand?: string | null;
1813
1815
  }
1814
- export interface GiftCardPaymentRefund {
1816
+ interface GiftCardPaymentRefund {
1815
1817
  /**
1816
1818
  * Gift card payment ID
1817
1819
  * @minLength 1
@@ -1821,7 +1823,7 @@ export interface GiftCardPaymentRefund {
1821
1823
  /** Refund amount */
1822
1824
  amount?: Price;
1823
1825
  }
1824
- export interface MembershipPaymentRefund {
1826
+ interface MembershipPaymentRefund {
1825
1827
  /**
1826
1828
  * Membership ID
1827
1829
  * @minLength 1
@@ -1829,7 +1831,7 @@ export interface MembershipPaymentRefund {
1829
1831
  */
1830
1832
  membershipId?: string | null;
1831
1833
  }
1832
- export interface PaymentRefunded {
1834
+ interface PaymentRefunded {
1833
1835
  /**
1834
1836
  * Refund ID.
1835
1837
  * @format GUID
@@ -1838,7 +1840,7 @@ export interface PaymentRefunded {
1838
1840
  /** Details about the refunded payment. */
1839
1841
  payment?: RefundedPayment;
1840
1842
  }
1841
- export interface PaymentRefundFailed {
1843
+ interface PaymentRefundFailed {
1842
1844
  /**
1843
1845
  * Refund ID.
1844
1846
  * @format GUID
@@ -1847,7 +1849,7 @@ export interface PaymentRefundFailed {
1847
1849
  /** Details about the failed payment refund. */
1848
1850
  payment?: RefundedPayment;
1849
1851
  }
1850
- export interface RefundedAsStoreCredit {
1852
+ interface RefundedAsStoreCredit {
1851
1853
  /** Refund amount */
1852
1854
  amount?: Price;
1853
1855
  /**
@@ -1856,7 +1858,7 @@ export interface RefundedAsStoreCredit {
1856
1858
  */
1857
1859
  reason?: string | null;
1858
1860
  }
1859
- export interface PaymentPending extends PaymentPendingPaymentDetailsOneOf {
1861
+ interface PaymentPending extends PaymentPendingPaymentDetailsOneOf {
1860
1862
  /** Regular payment. */
1861
1863
  regular?: RegularPayment;
1862
1864
  /**
@@ -1866,22 +1868,22 @@ export interface PaymentPending extends PaymentPendingPaymentDetailsOneOf {
1866
1868
  paymentId?: string;
1867
1869
  }
1868
1870
  /** @oneof */
1869
- export interface PaymentPendingPaymentDetailsOneOf {
1871
+ interface PaymentPendingPaymentDetailsOneOf {
1870
1872
  /** Regular payment. */
1871
1873
  regular?: RegularPayment;
1872
1874
  }
1873
- export interface RegularPayment extends RegularPaymentPaymentMethodDetailsOneOf {
1875
+ interface RegularPayment extends RegularPaymentPaymentMethodDetailsOneOf {
1874
1876
  /** Whether regular card used */
1875
1877
  creditCardDetails?: CreditCardDetails;
1876
1878
  /** Payment amount */
1877
1879
  amount?: Price;
1878
1880
  }
1879
1881
  /** @oneof */
1880
- export interface RegularPaymentPaymentMethodDetailsOneOf {
1882
+ interface RegularPaymentPaymentMethodDetailsOneOf {
1881
1883
  /** Whether regular card used */
1882
1884
  creditCardDetails?: CreditCardDetails;
1883
1885
  }
1884
- export interface CreditCardDetails {
1886
+ interface CreditCardDetails {
1885
1887
  /**
1886
1888
  * The last 4 digits of the card number.
1887
1889
  * @maxLength 4
@@ -1893,7 +1895,7 @@ export interface CreditCardDetails {
1893
1895
  */
1894
1896
  brand?: string | null;
1895
1897
  }
1896
- export interface PaymentCanceled extends PaymentCanceledPaymentDetailsOneOf {
1898
+ interface PaymentCanceled extends PaymentCanceledPaymentDetailsOneOf {
1897
1899
  /** Regular payment. */
1898
1900
  regular?: RegularPayment;
1899
1901
  /**
@@ -1903,11 +1905,11 @@ export interface PaymentCanceled extends PaymentCanceledPaymentDetailsOneOf {
1903
1905
  paymentId?: string;
1904
1906
  }
1905
1907
  /** @oneof */
1906
- export interface PaymentCanceledPaymentDetailsOneOf {
1908
+ interface PaymentCanceledPaymentDetailsOneOf {
1907
1909
  /** Regular payment. */
1908
1910
  regular?: RegularPayment;
1909
1911
  }
1910
- export interface PaymentDeclined extends PaymentDeclinedPaymentDetailsOneOf {
1912
+ interface PaymentDeclined extends PaymentDeclinedPaymentDetailsOneOf {
1911
1913
  /** Regular payment. */
1912
1914
  regular?: RegularPayment;
1913
1915
  /**
@@ -1917,11 +1919,11 @@ export interface PaymentDeclined extends PaymentDeclinedPaymentDetailsOneOf {
1917
1919
  paymentId?: string;
1918
1920
  }
1919
1921
  /** @oneof */
1920
- export interface PaymentDeclinedPaymentDetailsOneOf {
1922
+ interface PaymentDeclinedPaymentDetailsOneOf {
1921
1923
  /** Regular payment. */
1922
1924
  regular?: RegularPayment;
1923
1925
  }
1924
- export interface ReceiptCreated extends ReceiptCreatedReceiptInfoOneOf {
1926
+ interface ReceiptCreated extends ReceiptCreatedReceiptInfoOneOf {
1925
1927
  /** Receipt created by Wix */
1926
1928
  wixReceipt?: WixReceipt;
1927
1929
  /** Receipt created by an external system. */
@@ -1933,13 +1935,13 @@ export interface ReceiptCreated extends ReceiptCreatedReceiptInfoOneOf {
1933
1935
  paymentId?: string;
1934
1936
  }
1935
1937
  /** @oneof */
1936
- export interface ReceiptCreatedReceiptInfoOneOf {
1938
+ interface ReceiptCreatedReceiptInfoOneOf {
1937
1939
  /** Receipt created by Wix */
1938
1940
  wixReceipt?: WixReceipt;
1939
1941
  /** Receipt created by an external system. */
1940
1942
  externalReceipt?: ExternalReceipt;
1941
1943
  }
1942
- export interface WixReceipt {
1944
+ interface WixReceipt {
1943
1945
  /**
1944
1946
  * Receipt ID
1945
1947
  * @format GUID
@@ -1952,7 +1954,7 @@ export interface WixReceipt {
1952
1954
  */
1953
1955
  displayNumber?: string | null;
1954
1956
  }
1955
- export interface ExternalReceipt {
1957
+ interface ExternalReceipt {
1956
1958
  /**
1957
1959
  * Receipt ID
1958
1960
  * @maxLength 100
@@ -1965,7 +1967,7 @@ export interface ExternalReceipt {
1965
1967
  */
1966
1968
  displayNumber?: string | null;
1967
1969
  }
1968
- export interface ReceiptSent extends ReceiptSentReceiptInfoOneOf {
1970
+ interface ReceiptSent extends ReceiptSentReceiptInfoOneOf {
1969
1971
  /** Receipt created by Wix */
1970
1972
  wixReceipt?: WixReceipt;
1971
1973
  /** Receipt created by an external system. */
@@ -1977,13 +1979,13 @@ export interface ReceiptSent extends ReceiptSentReceiptInfoOneOf {
1977
1979
  paymentId?: string;
1978
1980
  }
1979
1981
  /** @oneof */
1980
- export interface ReceiptSentReceiptInfoOneOf {
1982
+ interface ReceiptSentReceiptInfoOneOf {
1981
1983
  /** Receipt created by Wix */
1982
1984
  wixReceipt?: WixReceipt;
1983
1985
  /** Receipt created by an external system. */
1984
1986
  externalReceipt?: ExternalReceipt;
1985
1987
  }
1986
- export declare enum ActivityType {
1988
+ declare enum ActivityType {
1987
1989
  ORDER_REFUNDED = "ORDER_REFUNDED",
1988
1990
  ORDER_PLACED = "ORDER_PLACED",
1989
1991
  ORDER_PAID = "ORDER_PAID",
@@ -2020,11 +2022,11 @@ export declare enum ActivityType {
2020
2022
  /** @documentationMaturity preview */
2021
2023
  ORDER_REJECTED = "ORDER_REJECTED"
2022
2024
  }
2023
- export declare enum AttributionSource {
2025
+ declare enum AttributionSource {
2024
2026
  UNSPECIFIED = "UNSPECIFIED",
2025
2027
  FACEBOOK_ADS = "FACEBOOK_ADS"
2026
2028
  }
2027
- export interface V1CreatedBy extends V1CreatedByStringOneOf {
2029
+ interface V1CreatedBy extends V1CreatedByStringOneOf {
2028
2030
  /**
2029
2031
  * User ID - when the order was created by a Wix user on behalf of a buyer.
2030
2032
  * For example, via POS (point of service).
@@ -2048,7 +2050,7 @@ export interface V1CreatedBy extends V1CreatedByStringOneOf {
2048
2050
  appId?: string;
2049
2051
  }
2050
2052
  /** @oneof */
2051
- export interface V1CreatedByStringOneOf {
2053
+ interface V1CreatedByStringOneOf {
2052
2054
  /**
2053
2055
  * User ID - when the order was created by a Wix user on behalf of a buyer.
2054
2056
  * For example, via POS (point of service).
@@ -2071,7 +2073,7 @@ export interface V1CreatedByStringOneOf {
2071
2073
  */
2072
2074
  appId?: string;
2073
2075
  }
2074
- export interface ChannelInfo {
2076
+ interface ChannelInfo {
2075
2077
  /** Sales channel that submitted the order. */
2076
2078
  type?: ChannelType;
2077
2079
  /**
@@ -2085,7 +2087,7 @@ export interface ChannelInfo {
2085
2087
  */
2086
2088
  externalOrderUrl?: string | null;
2087
2089
  }
2088
- export declare enum ChannelType {
2090
+ declare enum ChannelType {
2089
2091
  /** Unspecified sales channel. This value is not supported. */
2090
2092
  UNSPECIFIED = "UNSPECIFIED",
2091
2093
  /** A web client. */
@@ -2119,7 +2121,7 @@ export declare enum ChannelType {
2119
2121
  /** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
2120
2122
  FAIRE_COM = "FAIRE_COM"
2121
2123
  }
2122
- export interface CustomField {
2124
+ interface CustomField {
2123
2125
  /** Custom field value. */
2124
2126
  value?: any;
2125
2127
  /**
@@ -2135,7 +2137,7 @@ export interface CustomField {
2135
2137
  */
2136
2138
  translatedTitle?: string | null;
2137
2139
  }
2138
- export interface BalanceSummary {
2140
+ interface BalanceSummary {
2139
2141
  /**
2140
2142
  * Current amount left to pay.
2141
2143
  * @readonly
@@ -2171,7 +2173,7 @@ export interface BalanceSummary {
2171
2173
  * + PARTIALLY_PAID : price_summary.total_price - pay_now.total_price
2172
2174
  * + PENDING, REFUNDED, PARTIALLY_REFUNDED, PAID : 0
2173
2175
  */
2174
- export interface Balance {
2176
+ interface Balance {
2175
2177
  /**
2176
2178
  * Balance amount.
2177
2179
  *
@@ -2186,7 +2188,7 @@ export interface Balance {
2186
2188
  */
2187
2189
  formattedAmount?: string;
2188
2190
  }
2189
- export interface AdditionalFee {
2191
+ interface AdditionalFee {
2190
2192
  /**
2191
2193
  * Additional fee's unique code for future processing.
2192
2194
  * @minLength 1
@@ -2225,7 +2227,7 @@ export interface AdditionalFee {
2225
2227
  */
2226
2228
  lineItemIds?: string[];
2227
2229
  }
2228
- export interface FulfillmentStatusesAggregate {
2230
+ interface FulfillmentStatusesAggregate {
2229
2231
  /** Unique string values based on Fulfillment entities statuses */
2230
2232
  statuses?: string[] | null;
2231
2233
  }
@@ -2251,13 +2253,13 @@ export interface FulfillmentStatusesAggregate {
2251
2253
  * }
2252
2254
  * }
2253
2255
  */
2254
- export interface Tags {
2256
+ interface Tags {
2255
2257
  /** Tags that require an additional permission in order to access them, normally not given to site members or visitors. */
2256
2258
  privateTags?: TagList;
2257
2259
  /** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
2258
2260
  tags?: TagList;
2259
2261
  }
2260
- export interface TagList {
2262
+ interface TagList {
2261
2263
  /**
2262
2264
  * List of tag IDs
2263
2265
  * @maxSize 100
@@ -2265,7 +2267,7 @@ export interface TagList {
2265
2267
  */
2266
2268
  tagIds?: string[];
2267
2269
  }
2268
- export interface Location {
2270
+ interface Location {
2269
2271
  /**
2270
2272
  * Location ID.
2271
2273
  * Learn more about the [Wix Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
@@ -2280,11 +2282,11 @@ export interface Location {
2280
2282
  */
2281
2283
  name?: string;
2282
2284
  }
2283
- export interface GetPaymentSettingsResponse {
2285
+ interface GetPaymentSettingsResponse {
2284
2286
  /** Retrieved payment settings. */
2285
2287
  paymentSettings?: PaymentSettings;
2286
2288
  }
2287
- export interface PaymentSettings {
2289
+ interface PaymentSettings {
2288
2290
  /**
2289
2291
  * Whether to apply [3D Secure](https://support.wix.com/en/article/about-3d-secure-3ds-payments-with-third-party-payment-providers) during the payment process.
2290
2292
  *
@@ -2294,11 +2296,11 @@ export interface PaymentSettings {
2294
2296
  */
2295
2297
  requires3dSecure?: boolean | null;
2296
2298
  }
2297
- export interface GetPaymentSettingsForCheckoutRequest {
2299
+ interface GetPaymentSettingsForCheckoutRequest {
2298
2300
  /** Checkout. */
2299
2301
  checkout?: Checkout;
2300
2302
  }
2301
- export interface Checkout {
2303
+ interface Checkout {
2302
2304
  /**
2303
2305
  * Checkout ID.
2304
2306
  * @format GUID
@@ -2495,7 +2497,7 @@ export interface Checkout {
2495
2497
  */
2496
2498
  paymentCurrency?: string;
2497
2499
  }
2498
- export interface LineItem {
2500
+ interface LineItem {
2499
2501
  /**
2500
2502
  * Line item ID.
2501
2503
  * @format GUID
@@ -2697,7 +2699,7 @@ export interface LineItem {
2697
2699
  */
2698
2700
  modifiersTotalPrice?: MultiCurrencyPrice;
2699
2701
  }
2700
- export interface MultiCurrencyPrice {
2702
+ interface MultiCurrencyPrice {
2701
2703
  /**
2702
2704
  * Amount.
2703
2705
  * @decimalValue options { gte:0, lte:1000000000000000 }
@@ -2720,7 +2722,7 @@ export interface MultiCurrencyPrice {
2720
2722
  */
2721
2723
  formattedConvertedAmount?: string;
2722
2724
  }
2723
- export interface V1ItemTaxFullDetails {
2725
+ interface V1ItemTaxFullDetails {
2724
2726
  /** Amount for which tax is calculated. */
2725
2727
  taxableAmount?: MultiCurrencyPrice;
2726
2728
  /**
@@ -2737,7 +2739,7 @@ export interface V1ItemTaxFullDetails {
2737
2739
  */
2738
2740
  rateBreakdown?: TaxRateBreakdown[];
2739
2741
  }
2740
- export interface TaxRateBreakdown {
2742
+ interface TaxRateBreakdown {
2741
2743
  /**
2742
2744
  * Name of tax against which the calculation was performed.
2743
2745
  * @maxLength 100
@@ -2755,7 +2757,7 @@ export interface TaxRateBreakdown {
2755
2757
  * TaxBreakdown represents tax information for a line item.
2756
2758
  * It holds the tax amount and the tax rate for each tax authority that apply on the line item.
2757
2759
  */
2758
- export interface TaxBreakdown {
2760
+ interface TaxBreakdown {
2759
2761
  /**
2760
2762
  * The name of the jurisdiction to which this tax detail applies. For example, "New York" or "Quebec".
2761
2763
  * @maxLength 200
@@ -2787,7 +2789,7 @@ export interface TaxBreakdown {
2787
2789
  jurisdictionType?: V1JurisdictionType;
2788
2790
  }
2789
2791
  /** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
2790
- export declare enum V1JurisdictionType {
2792
+ declare enum V1JurisdictionType {
2791
2793
  UNDEFINED = "UNDEFINED",
2792
2794
  COUNTRY = "COUNTRY",
2793
2795
  STATE = "STATE",
@@ -2795,13 +2797,13 @@ export declare enum V1JurisdictionType {
2795
2797
  CITY = "CITY",
2796
2798
  SPECIAL = "SPECIAL"
2797
2799
  }
2798
- export interface ItemAvailabilityInfo {
2800
+ interface ItemAvailabilityInfo {
2799
2801
  /** Item availability status. */
2800
2802
  status?: ItemAvailabilityStatus;
2801
2803
  /** Quantity available. */
2802
2804
  quantityAvailable?: number | null;
2803
2805
  }
2804
- export declare enum ItemAvailabilityStatus {
2806
+ declare enum ItemAvailabilityStatus {
2805
2807
  AVAILABLE = "AVAILABLE",
2806
2808
  /** Item does not exist. */
2807
2809
  NOT_FOUND = "NOT_FOUND",
@@ -2810,19 +2812,19 @@ export declare enum ItemAvailabilityStatus {
2810
2812
  /** Available quantity is less than requested. */
2811
2813
  PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
2812
2814
  }
2813
- export interface Scope {
2815
+ interface Scope {
2814
2816
  /** Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans) */
2815
2817
  namespace?: string;
2816
2818
  /** Coupon scope's applied group (e.g., event or ticket in Wix Events) */
2817
2819
  group?: Group;
2818
2820
  }
2819
- export interface Group {
2821
+ interface Group {
2820
2822
  /** 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). */
2821
2823
  name?: string;
2822
2824
  /** Item ID (when the coupon scope is limited to just one item). */
2823
2825
  entityId?: string | null;
2824
2826
  }
2825
- export interface SubscriptionOptionInfo {
2827
+ interface SubscriptionOptionInfo {
2826
2828
  /** Subscription option settings. */
2827
2829
  subscriptionSettings?: V1SubscriptionSettings;
2828
2830
  /** Subscription option title. */
@@ -2830,7 +2832,7 @@ export interface SubscriptionOptionInfo {
2830
2832
  /** Subscription option description. */
2831
2833
  description?: Description;
2832
2834
  }
2833
- export interface V1SubscriptionSettings {
2835
+ interface V1SubscriptionSettings {
2834
2836
  /** Frequency of recurring payment. */
2835
2837
  frequency?: SubscriptionFrequency;
2836
2838
  /**
@@ -2857,7 +2859,7 @@ export interface V1SubscriptionSettings {
2857
2859
  */
2858
2860
  freeTrialPeriod?: V1FreeTrialPeriod;
2859
2861
  }
2860
- export interface V1FreeTrialPeriod {
2862
+ interface V1FreeTrialPeriod {
2861
2863
  /** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
2862
2864
  frequency?: SubscriptionFrequency;
2863
2865
  /**
@@ -2867,7 +2869,7 @@ export interface V1FreeTrialPeriod {
2867
2869
  */
2868
2870
  interval?: number;
2869
2871
  }
2870
- export interface Title {
2872
+ interface Title {
2871
2873
  /**
2872
2874
  * 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).
2873
2875
  * @minLength 1
@@ -2883,7 +2885,7 @@ export interface Title {
2883
2885
  */
2884
2886
  translated?: string | null;
2885
2887
  }
2886
- export interface Description {
2888
+ interface Description {
2887
2889
  /**
2888
2890
  * Subscription option description.
2889
2891
  * @maxLength 500
@@ -2895,7 +2897,7 @@ export interface Description {
2895
2897
  */
2896
2898
  translated?: string | null;
2897
2899
  }
2898
- export interface SecuredMedia {
2900
+ interface SecuredMedia {
2899
2901
  /**
2900
2902
  * Media ID in Wix Media Manager.
2901
2903
  * @minLength 1
@@ -2911,7 +2913,7 @@ export interface SecuredMedia {
2911
2913
  /** File type. */
2912
2914
  fileType?: FileType;
2913
2915
  }
2914
- export declare enum FileType {
2916
+ declare enum FileType {
2915
2917
  UNSPECIFIED = "UNSPECIFIED",
2916
2918
  SECURE_PICTURE = "SECURE_PICTURE",
2917
2919
  SECURE_VIDEO = "SECURE_VIDEO",
@@ -2919,7 +2921,7 @@ export declare enum FileType {
2919
2921
  SECURE_MUSIC = "SECURE_MUSIC",
2920
2922
  SECURE_ARCHIVE = "SECURE_ARCHIVE"
2921
2923
  }
2922
- export interface ServiceProperties {
2924
+ interface ServiceProperties {
2923
2925
  /**
2924
2926
  * 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.
2925
2927
  * For example, the start time of a class.
@@ -2932,7 +2934,7 @@ export interface ServiceProperties {
2932
2934
  */
2933
2935
  numberOfParticipants?: number | null;
2934
2936
  }
2935
- export interface CatalogOverrideFields {
2937
+ interface CatalogOverrideFields {
2936
2938
  /** Item name. */
2937
2939
  productName?: ProductName;
2938
2940
  /**
@@ -2969,7 +2971,7 @@ export interface CatalogOverrideFields {
2969
2971
  */
2970
2972
  savePaymentMethod?: boolean | null;
2971
2973
  }
2972
- export interface PaymentOption {
2974
+ interface PaymentOption {
2973
2975
  /**
2974
2976
  * Type of selected payment option for current item.
2975
2977
  *
@@ -2977,7 +2979,7 @@ export interface PaymentOption {
2977
2979
  */
2978
2980
  value?: PaymentOptionType;
2979
2981
  }
2980
- export interface Policy {
2982
+ interface Policy {
2981
2983
  /**
2982
2984
  * Policy title - should be translated
2983
2985
  * @minLength 1
@@ -2991,7 +2993,7 @@ export interface Policy {
2991
2993
  */
2992
2994
  content?: string;
2993
2995
  }
2994
- export interface ModifierGroup {
2996
+ interface ModifierGroup {
2995
2997
  /**
2996
2998
  * Modifier group id.
2997
2999
  * @minLength 1
@@ -3007,7 +3009,7 @@ export interface ModifierGroup {
3007
3009
  */
3008
3010
  modifiers?: ItemModifier[];
3009
3011
  }
3010
- export interface ItemModifier {
3012
+ interface ItemModifier {
3011
3013
  /**
3012
3014
  * Modifier ID.
3013
3015
  * @minLength 1
@@ -3028,13 +3030,13 @@ export interface ItemModifier {
3028
3030
  price?: MultiCurrencyPrice;
3029
3031
  }
3030
3032
  /** Billing Info and shipping details */
3031
- export interface AddressWithContact {
3033
+ interface AddressWithContact {
3032
3034
  /** Address. */
3033
3035
  address?: Address;
3034
3036
  /** Contact details. */
3035
3037
  contactDetails?: FullAddressContactDetails;
3036
3038
  }
3037
- export interface ShippingInfo {
3039
+ interface ShippingInfo {
3038
3040
  /** Shipping address and contact details. */
3039
3041
  shippingDestination?: AddressWithContact;
3040
3042
  /** Selected option out of the options allowed for the `region`. */
@@ -3050,7 +3052,7 @@ export interface ShippingInfo {
3050
3052
  */
3051
3053
  carrierServiceOptions?: CarrierServiceOption[];
3052
3054
  }
3053
- export interface SelectedCarrierServiceOption {
3055
+ interface SelectedCarrierServiceOption {
3054
3056
  /**
3055
3057
  * Unique identifier of selected option. For example, "usps_std_overnight".
3056
3058
  * @maxLength 100
@@ -3098,7 +3100,7 @@ export interface SelectedCarrierServiceOption {
3098
3100
  /** If the delivery solution is a partial and doesn't apply to all items. */
3099
3101
  partial?: boolean | null;
3100
3102
  }
3101
- export interface V1DeliveryLogistics {
3103
+ interface V1DeliveryLogistics {
3102
3104
  /**
3103
3105
  * Expected delivery time, in free text. For example, "3-5 business days".
3104
3106
  * @maxLength 500
@@ -3112,7 +3114,7 @@ export interface V1DeliveryLogistics {
3112
3114
  /** Pickup details. */
3113
3115
  pickupDetails?: V1PickupDetails;
3114
3116
  }
3115
- export interface V1PickupDetails {
3117
+ interface V1PickupDetails {
3116
3118
  /** Pickup address. */
3117
3119
  address?: Address;
3118
3120
  /**
@@ -3123,18 +3125,18 @@ export interface V1PickupDetails {
3123
3125
  /** Pickup method */
3124
3126
  pickupMethod?: PickupDetailsPickupMethod;
3125
3127
  }
3126
- export declare enum PickupDetailsPickupMethod {
3128
+ declare enum PickupDetailsPickupMethod {
3127
3129
  UNKNOWN_METHOD = "UNKNOWN_METHOD",
3128
3130
  STORE_PICKUP = "STORE_PICKUP",
3129
3131
  PICKUP_POINT = "PICKUP_POINT"
3130
3132
  }
3131
- export interface V1DeliveryTimeSlot {
3133
+ interface V1DeliveryTimeSlot {
3132
3134
  /** starting time of the delivery time slot */
3133
3135
  from?: Date | null;
3134
3136
  /** ending time of the delivery time slot */
3135
3137
  to?: Date | null;
3136
3138
  }
3137
- export interface SelectedCarrierServiceOptionPrices {
3139
+ interface SelectedCarrierServiceOptionPrices {
3138
3140
  /** Total shipping price, after discount and after tax. */
3139
3141
  totalPriceAfterTax?: MultiCurrencyPrice;
3140
3142
  /** Total price of shipping after discounts (when relevant), and before tax. */
@@ -3146,7 +3148,7 @@ export interface SelectedCarrierServiceOptionPrices {
3146
3148
  /** Shipping price before discount and before tax. */
3147
3149
  price?: MultiCurrencyPrice;
3148
3150
  }
3149
- export interface SelectedCarrierServiceOptionOtherCharge {
3151
+ interface SelectedCarrierServiceOptionOtherCharge {
3150
3152
  /** Type of additional cost. */
3151
3153
  type?: ChargeType;
3152
3154
  /**
@@ -3157,11 +3159,11 @@ export interface SelectedCarrierServiceOptionOtherCharge {
3157
3159
  /** Price of added charge. */
3158
3160
  cost?: SelectedCarrierServiceOptionPrices;
3159
3161
  }
3160
- export declare enum ChargeType {
3162
+ declare enum ChargeType {
3161
3163
  HANDLING_FEE = "HANDLING_FEE",
3162
3164
  INSURANCE = "INSURANCE"
3163
3165
  }
3164
- export interface DeliveryAllocation {
3166
+ interface DeliveryAllocation {
3165
3167
  /** The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers */
3166
3168
  deliveryCarrier?: Carrier;
3167
3169
  /** The delivery region that are relevant for this delivery solution. */
@@ -3169,7 +3171,7 @@ export interface DeliveryAllocation {
3169
3171
  /** Populated if the delivery solution is a partially supplied by this carrier. */
3170
3172
  applicableLineItems?: ApplicableLineItems;
3171
3173
  }
3172
- export interface Carrier {
3174
+ interface Carrier {
3173
3175
  /**
3174
3176
  * The carrier app id
3175
3177
  * @format GUID
@@ -3181,7 +3183,7 @@ export interface Carrier {
3181
3183
  */
3182
3184
  code?: string;
3183
3185
  }
3184
- export interface Region {
3186
+ interface Region {
3185
3187
  /**
3186
3188
  * The delivery region id.
3187
3189
  * @format GUID
@@ -3193,7 +3195,7 @@ export interface Region {
3193
3195
  */
3194
3196
  name?: string | null;
3195
3197
  }
3196
- export interface ApplicableLineItems {
3198
+ interface ApplicableLineItems {
3197
3199
  /**
3198
3200
  * Line items that the delivery solution is for.
3199
3201
  * @maxSize 300
@@ -3202,7 +3204,7 @@ export interface ApplicableLineItems {
3202
3204
  */
3203
3205
  lineItemIds?: string[];
3204
3206
  }
3205
- export interface V1ShippingRegion {
3207
+ interface V1ShippingRegion {
3206
3208
  /**
3207
3209
  * Shipping region ID.
3208
3210
  * @format GUID
@@ -3215,7 +3217,7 @@ export interface V1ShippingRegion {
3215
3217
  */
3216
3218
  name?: string;
3217
3219
  }
3218
- export interface CarrierServiceOption {
3220
+ interface CarrierServiceOption {
3219
3221
  /**
3220
3222
  * Carrier ID.
3221
3223
  * @format GUID
@@ -3224,7 +3226,7 @@ export interface CarrierServiceOption {
3224
3226
  /** Shipping options offered by this carrier for this request. */
3225
3227
  shippingOptions?: ShippingOption[];
3226
3228
  }
3227
- export interface ShippingOption {
3229
+ interface ShippingOption {
3228
3230
  /**
3229
3231
  * Unique code of provided shipping option like "usps_std_overnight".
3230
3232
  * For legacy calculators this would be the UUID of the option.
@@ -3249,13 +3251,13 @@ export interface ShippingOption {
3249
3251
  /** If the delivery solution is a partial and doesn't apply to all items. */
3250
3252
  partial?: boolean | null;
3251
3253
  }
3252
- export interface V1ShippingPrice {
3254
+ interface V1ShippingPrice {
3253
3255
  /** Shipping price. */
3254
3256
  price?: MultiCurrencyPrice;
3255
3257
  /** Other costs such as insurance, handling & packaging for fragile items, etc. */
3256
3258
  otherCharges?: OtherCharge[];
3257
3259
  }
3258
- export interface OtherCharge {
3260
+ interface OtherCharge {
3259
3261
  /** Type of additional cost. */
3260
3262
  type?: ChargeType;
3261
3263
  /** Price of added cost. */
@@ -3266,7 +3268,7 @@ export interface OtherCharge {
3266
3268
  */
3267
3269
  details?: string | null;
3268
3270
  }
3269
- export interface BuyerInfo extends BuyerInfoIdOneOf {
3271
+ interface BuyerInfo extends BuyerInfoIdOneOf {
3270
3272
  /**
3271
3273
  * Visitor ID (if site visitor is **not** a member).
3272
3274
  * @format GUID
@@ -3292,7 +3294,7 @@ export interface BuyerInfo extends BuyerInfoIdOneOf {
3292
3294
  email?: string | null;
3293
3295
  }
3294
3296
  /** @oneof */
3295
- export interface BuyerInfoIdOneOf {
3297
+ interface BuyerInfoIdOneOf {
3296
3298
  /**
3297
3299
  * Visitor ID (if site visitor is **not** a member).
3298
3300
  * @format GUID
@@ -3306,7 +3308,7 @@ export interface BuyerInfoIdOneOf {
3306
3308
  */
3307
3309
  memberId?: string;
3308
3310
  }
3309
- export interface V1PriceSummary {
3311
+ interface V1PriceSummary {
3310
3312
  /** Subtotal of all line items, before discounts and before tax. */
3311
3313
  subtotal?: MultiCurrencyPrice;
3312
3314
  /** Total shipping price, before discounts and before tax. */
@@ -3320,7 +3322,7 @@ export interface V1PriceSummary {
3320
3322
  /** Total additional fees price before tax. */
3321
3323
  additionalFees?: MultiCurrencyPrice;
3322
3324
  }
3323
- export interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
3325
+ interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
3324
3326
  /** General shipping calculation error. */
3325
3327
  generalShippingCalculationError?: Details;
3326
3328
  /** Carrier errors. */
@@ -3342,13 +3344,13 @@ export interface CalculationErrors extends CalculationErrorsShippingCalculationE
3342
3344
  discountsCalculationError?: Details;
3343
3345
  }
3344
3346
  /** @oneof */
3345
- export interface CalculationErrorsShippingCalculationErrorOneOf {
3347
+ interface CalculationErrorsShippingCalculationErrorOneOf {
3346
3348
  /** General shipping calculation error. */
3347
3349
  generalShippingCalculationError?: Details;
3348
3350
  /** Carrier errors. */
3349
3351
  carrierErrors?: CarrierErrors;
3350
3352
  }
3351
- export interface Details extends DetailsKindOneOf {
3353
+ interface Details extends DetailsKindOneOf {
3352
3354
  applicationError?: ApplicationError;
3353
3355
  validationError?: ValidationError;
3354
3356
  systemError?: SystemError;
@@ -3359,12 +3361,12 @@ export interface Details extends DetailsKindOneOf {
3359
3361
  tracing?: Record<string, string>;
3360
3362
  }
3361
3363
  /** @oneof */
3362
- export interface DetailsKindOneOf {
3364
+ interface DetailsKindOneOf {
3363
3365
  applicationError?: ApplicationError;
3364
3366
  validationError?: ValidationError;
3365
3367
  systemError?: SystemError;
3366
3368
  }
3367
- export interface ApplicationError {
3369
+ interface ApplicationError {
3368
3370
  /** Error code. */
3369
3371
  code?: string;
3370
3372
  /** Description of the error. */
@@ -3404,10 +3406,10 @@ export interface ApplicationError {
3404
3406
  * ]
3405
3407
  * }
3406
3408
  */
3407
- export interface ValidationError {
3409
+ interface ValidationError {
3408
3410
  fieldViolations?: FieldViolation[];
3409
3411
  }
3410
- export declare enum RuleType {
3412
+ declare enum RuleType {
3411
3413
  VALIDATION = "VALIDATION",
3412
3414
  OTHER = "OTHER",
3413
3415
  MAX = "MAX",
@@ -3430,7 +3432,7 @@ export declare enum RuleType {
3430
3432
  EXACT_SIZE = "EXACT_SIZE",
3431
3433
  REQUIRED_ONE_OF_FIELD = "REQUIRED_ONE_OF_FIELD"
3432
3434
  }
3433
- export interface FieldViolation {
3435
+ interface FieldViolation {
3434
3436
  field?: string;
3435
3437
  description?: string;
3436
3438
  violatedRule?: RuleType;
@@ -3438,21 +3440,21 @@ export interface FieldViolation {
3438
3440
  ruleName?: string | null;
3439
3441
  data?: Record<string, any> | null;
3440
3442
  }
3441
- export interface SystemError {
3443
+ interface SystemError {
3442
3444
  /** Error code. */
3443
3445
  errorCode?: string | null;
3444
3446
  }
3445
- export interface CarrierErrors {
3447
+ interface CarrierErrors {
3446
3448
  /** Carrier errors. */
3447
3449
  errors?: CarrierError[];
3448
3450
  }
3449
- export interface CarrierError {
3451
+ interface CarrierError {
3450
3452
  /** Carrier ID. */
3451
3453
  carrierId?: string;
3452
3454
  /** Error details. */
3453
3455
  error?: Details;
3454
3456
  }
3455
- export interface GiftCard {
3457
+ interface GiftCard {
3456
3458
  /**
3457
3459
  * Gift Card ID.
3458
3460
  * @deprecated
@@ -3475,7 +3477,7 @@ export interface GiftCard {
3475
3477
  */
3476
3478
  externalId?: string | null;
3477
3479
  }
3478
- export interface V1AppliedDiscount extends V1AppliedDiscountDiscountSourceOneOf {
3480
+ interface V1AppliedDiscount extends V1AppliedDiscountDiscountSourceOneOf {
3479
3481
  /** Coupon details. */
3480
3482
  coupon?: V1Coupon;
3481
3483
  /** Merchant discount. */
@@ -3494,7 +3496,7 @@ export interface V1AppliedDiscount extends V1AppliedDiscountDiscountSourceOneOf
3494
3496
  lineItemIds?: string[];
3495
3497
  }
3496
3498
  /** @oneof */
3497
- export interface V1AppliedDiscountDiscountSourceOneOf {
3499
+ interface V1AppliedDiscountDiscountSourceOneOf {
3498
3500
  /** Coupon details. */
3499
3501
  coupon?: V1Coupon;
3500
3502
  /** Merchant discount. */
@@ -3502,13 +3504,13 @@ export interface V1AppliedDiscountDiscountSourceOneOf {
3502
3504
  /** Discount rule */
3503
3505
  discountRule?: V1DiscountRule;
3504
3506
  }
3505
- export declare enum AppliedDiscountDiscountType {
3507
+ declare enum AppliedDiscountDiscountType {
3506
3508
  GLOBAL = "GLOBAL",
3507
3509
  SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
3508
3510
  SHIPPING = "SHIPPING"
3509
3511
  }
3510
3512
  /** Coupon */
3511
- export interface V1Coupon {
3513
+ interface V1Coupon {
3512
3514
  /** Coupon ID. */
3513
3515
  _id?: string;
3514
3516
  /** Coupon code. */
@@ -3518,7 +3520,7 @@ export interface V1Coupon {
3518
3520
  /** Coupon name. */
3519
3521
  name?: string;
3520
3522
  }
3521
- export interface V1MerchantDiscount {
3523
+ interface V1MerchantDiscount {
3522
3524
  /** Discount value. */
3523
3525
  amount?: MultiCurrencyPrice;
3524
3526
  /**
@@ -3528,7 +3530,7 @@ export interface V1MerchantDiscount {
3528
3530
  */
3529
3531
  percentage?: number | null;
3530
3532
  }
3531
- export interface V1DiscountRule {
3533
+ interface V1DiscountRule {
3532
3534
  /**
3533
3535
  * Discount rule ID
3534
3536
  * @format GUID
@@ -3539,7 +3541,7 @@ export interface V1DiscountRule {
3539
3541
  /** Discount value. */
3540
3542
  amount?: MultiCurrencyPrice;
3541
3543
  }
3542
- export interface V1DiscountRuleName {
3544
+ interface V1DiscountRuleName {
3543
3545
  /**
3544
3546
  * Original discount rule name (in site's default language).
3545
3547
  * @minLength 1
@@ -3553,7 +3555,7 @@ export interface V1DiscountRuleName {
3553
3555
  */
3554
3556
  translated?: string | null;
3555
3557
  }
3556
- export interface V1LineItemDiscount {
3558
+ interface V1LineItemDiscount {
3557
3559
  /**
3558
3560
  * ID of line item the discount applies to.
3559
3561
  * @format GUID
@@ -3562,7 +3564,7 @@ export interface V1LineItemDiscount {
3562
3564
  /** Discount value. */
3563
3565
  totalDiscountAmount?: MultiCurrencyPrice;
3564
3566
  }
3565
- export interface V1TaxSummary {
3567
+ interface V1TaxSummary {
3566
3568
  /**
3567
3569
  * Amount for which tax is calculated, added from line items.
3568
3570
  * @readonly
@@ -3579,7 +3581,7 @@ export interface V1TaxSummary {
3579
3581
  */
3580
3582
  calculationDetails?: TaxCalculationDetails;
3581
3583
  }
3582
- export interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsOneOf {
3584
+ interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsOneOf {
3583
3585
  /** Reason the manual calculation was used. */
3584
3586
  manualRateReason?: ManualCalculationReason;
3585
3587
  /** Details of the fallback rate calculation. */
@@ -3588,13 +3590,13 @@ export interface TaxCalculationDetails extends TaxCalculationDetailsCalculationD
3588
3590
  rateType?: RateType;
3589
3591
  }
3590
3592
  /** @oneof */
3591
- export interface TaxCalculationDetailsCalculationDetailsOneOf {
3593
+ interface TaxCalculationDetailsCalculationDetailsOneOf {
3592
3594
  /** Reason the manual calculation was used. */
3593
3595
  manualRateReason?: ManualCalculationReason;
3594
3596
  /** Details of the fallback rate calculation. */
3595
3597
  autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails;
3596
3598
  }
3597
- export declare enum RateType {
3599
+ declare enum RateType {
3598
3600
  /** no tax being collected for this request due to location of purchase */
3599
3601
  NO_TAX_COLLECTED = "NO_TAX_COLLECTED",
3600
3602
  /** manual rate used for calculation */
@@ -3604,19 +3606,19 @@ export declare enum RateType {
3604
3606
  /** fallback rate used for calculation */
3605
3607
  FALLBACK_RATE = "FALLBACK_RATE"
3606
3608
  }
3607
- export declare enum ManualCalculationReason {
3609
+ declare enum ManualCalculationReason {
3608
3610
  /** user set calculator in Business Manager to be Manual */
3609
3611
  GLOBAL_SETTING_TO_MANUAL = "GLOBAL_SETTING_TO_MANUAL",
3610
3612
  /** specific region is on manual even though Global setting is Auto-tax */
3611
3613
  REGION_SETTING_TO_MANUAL = "REGION_SETTING_TO_MANUAL"
3612
3614
  }
3613
- export interface AutoTaxFallbackCalculationDetails {
3615
+ interface AutoTaxFallbackCalculationDetails {
3614
3616
  /** reason for fallback */
3615
3617
  fallbackReason?: FallbackReason;
3616
3618
  /** invalid request (i.e. address), timeout, internal error, license error, and others will be encoded here */
3617
3619
  error?: ApplicationError;
3618
3620
  }
3619
- export declare enum FallbackReason {
3621
+ declare enum FallbackReason {
3620
3622
  /** auto-tax failed to be calculated */
3621
3623
  AUTO_TAX_FAILED = "AUTO_TAX_FAILED",
3622
3624
  /** auto-tax was temporarily deactivated on a system-level */
@@ -3626,7 +3628,7 @@ export declare enum FallbackReason {
3626
3628
  * 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.
3627
3629
  * Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
3628
3630
  */
3629
- export interface AggregatedTaxBreakdown {
3631
+ interface AggregatedTaxBreakdown {
3630
3632
  /**
3631
3633
  * The name of the tax against which this tax amount was calculated.
3632
3634
  * @maxLength 200
@@ -3652,7 +3654,7 @@ export interface AggregatedTaxBreakdown {
3652
3654
  /** The sum of all the tax from line items that calculated by the tax identifiers. */
3653
3655
  aggregatedTaxAmount?: MultiCurrencyPrice;
3654
3656
  }
3655
- export interface CreatedBy extends CreatedByIdOneOf {
3657
+ interface CreatedBy extends CreatedByIdOneOf {
3656
3658
  /**
3657
3659
  * User ID. When the order was created by a Wix user on behalf of a buyer.
3658
3660
  * For example, via POS (point of service).
@@ -3676,7 +3678,7 @@ export interface CreatedBy extends CreatedByIdOneOf {
3676
3678
  appId?: string;
3677
3679
  }
3678
3680
  /** @oneof */
3679
- export interface CreatedByIdOneOf {
3681
+ interface CreatedByIdOneOf {
3680
3682
  /**
3681
3683
  * User ID. When the order was created by a Wix user on behalf of a buyer.
3682
3684
  * For example, via POS (point of service).
@@ -3700,7 +3702,7 @@ export interface CreatedByIdOneOf {
3700
3702
  appId?: string;
3701
3703
  }
3702
3704
  /** Reserved for internal use. */
3703
- export interface MembershipOptions {
3705
+ interface MembershipOptions {
3704
3706
  /**
3705
3707
  * Reserved for internal use.
3706
3708
  * @readonly
@@ -3716,7 +3718,7 @@ export interface MembershipOptions {
3716
3718
  /** Selected membership to apply to this checkout. */
3717
3719
  selectedMemberships?: SelectedMemberships;
3718
3720
  }
3719
- export interface Membership {
3721
+ interface Membership {
3720
3722
  /**
3721
3723
  * Membership ID.
3722
3724
  * @minLength 1
@@ -3745,7 +3747,7 @@ export interface Membership {
3745
3747
  /** Additional data about this membership. */
3746
3748
  additionalData?: Record<string, any> | null;
3747
3749
  }
3748
- export interface MembershipName {
3750
+ interface MembershipName {
3749
3751
  /**
3750
3752
  * Membership name.
3751
3753
  * @maxLength 100
@@ -3757,7 +3759,7 @@ export interface MembershipName {
3757
3759
  */
3758
3760
  translated?: string | null;
3759
3761
  }
3760
- export interface MembershipPaymentCredits {
3762
+ interface MembershipPaymentCredits {
3761
3763
  /**
3762
3764
  * Membership's total amount of credits.
3763
3765
  * @min 1
@@ -3766,7 +3768,7 @@ export interface MembershipPaymentCredits {
3766
3768
  /** Membership's remaining amount of credits. */
3767
3769
  remaining?: number;
3768
3770
  }
3769
- export interface InvalidMembership {
3771
+ interface InvalidMembership {
3770
3772
  /** Membership details. */
3771
3773
  membership?: Membership;
3772
3774
  /**
@@ -3776,14 +3778,14 @@ export interface InvalidMembership {
3776
3778
  */
3777
3779
  reason?: string;
3778
3780
  }
3779
- export interface SelectedMemberships {
3781
+ interface SelectedMemberships {
3780
3782
  /**
3781
3783
  * Selected memberships.
3782
3784
  * @maxSize 300
3783
3785
  */
3784
3786
  memberships?: SelectedMembership[];
3785
3787
  }
3786
- export interface SelectedMembership {
3788
+ interface SelectedMembership {
3787
3789
  /**
3788
3790
  * Membership ID.
3789
3791
  * @minLength 1
@@ -3804,7 +3806,7 @@ export interface SelectedMembership {
3804
3806
  */
3805
3807
  lineItemIds?: string[];
3806
3808
  }
3807
- export interface V1AdditionalFee {
3809
+ interface V1AdditionalFee {
3808
3810
  /**
3809
3811
  * Additional fee's unique code (or ID) for future processing.
3810
3812
  * @minLength 1
@@ -3840,7 +3842,7 @@ export interface V1AdditionalFee {
3840
3842
  /** the source the additional fee was added from */
3841
3843
  source?: AdditionalFeeSource;
3842
3844
  }
3843
- export declare enum AdditionalFeeSource {
3845
+ declare enum AdditionalFeeSource {
3844
3846
  UNKNOWN_ADDITIONAL_FEE_SOURCE = "UNKNOWN_ADDITIONAL_FEE_SOURCE",
3845
3847
  /** The additional fee was added by an additional fee service plugin */
3846
3848
  SERVICE_PLUGIN = "SERVICE_PLUGIN",
@@ -3851,7 +3853,7 @@ export declare enum AdditionalFeeSource {
3851
3853
  /** The additional fee was added by the shipping provider */
3852
3854
  SHIPPING = "SHIPPING"
3853
3855
  }
3854
- export interface ConversionInfo {
3856
+ interface ConversionInfo {
3855
3857
  /**
3856
3858
  * The site currency.
3857
3859
  * @readonly
@@ -3865,7 +3867,7 @@ export interface ConversionInfo {
3865
3867
  */
3866
3868
  conversionRate?: string;
3867
3869
  }
3868
- export interface Violation {
3870
+ interface Violation {
3869
3871
  /** 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. */
3870
3872
  severity?: Severity;
3871
3873
  /** Target location on a checkout or cart page where the violation will be displayed. */
@@ -3877,7 +3879,7 @@ export interface Violation {
3877
3879
  */
3878
3880
  description?: string | null;
3879
3881
  }
3880
- export declare enum Severity {
3882
+ declare enum Severity {
3881
3883
  /** The user is allowed to move forward in the flow. */
3882
3884
  WARNING = "WARNING",
3883
3885
  /**
@@ -3886,48 +3888,48 @@ export declare enum Severity {
3886
3888
  */
3887
3889
  ERROR = "ERROR"
3888
3890
  }
3889
- export interface Target extends TargetTargetTypeOneOf {
3891
+ interface Target extends TargetTargetTypeOneOf {
3890
3892
  /** General (other) violation. */
3891
3893
  other?: Other;
3892
3894
  /** Specific line item violation. */
3893
3895
  lineItem?: TargetLineItem;
3894
3896
  }
3895
3897
  /** @oneof */
3896
- export interface TargetTargetTypeOneOf {
3898
+ interface TargetTargetTypeOneOf {
3897
3899
  /** General (other) violation. */
3898
3900
  other?: Other;
3899
3901
  /** Specific line item violation. */
3900
3902
  lineItem?: TargetLineItem;
3901
3903
  }
3902
3904
  /** Available locations on the webpage */
3903
- export declare enum NameInOther {
3905
+ declare enum NameInOther {
3904
3906
  /** Default location, in case no specific location is specified. */
3905
3907
  OTHER_DEFAULT = "OTHER_DEFAULT"
3906
3908
  }
3907
3909
  /** Available locations on the line item */
3908
- export declare enum NameInLineItem {
3910
+ declare enum NameInLineItem {
3909
3911
  /** Default location, in case no specific location is specified. */
3910
3912
  LINE_ITEM_DEFAULT = "LINE_ITEM_DEFAULT"
3911
3913
  }
3912
- export declare enum SuggestedFix {
3914
+ declare enum SuggestedFix {
3913
3915
  /** No suggested fix is specified. The user should refer to the violation description to resolve the issue. */
3914
3916
  UNKNOWN_SUGGESTED_FIX = "UNKNOWN_SUGGESTED_FIX",
3915
3917
  /** The line item should be removed from the cart or checkout to resolve the violation. */
3916
3918
  REMOVE_LINE_ITEM = "REMOVE_LINE_ITEM"
3917
3919
  }
3918
3920
  /** General (other) violation. */
3919
- export interface Other {
3921
+ interface Other {
3920
3922
  /** Location on a checkout or a cart page where a general (other) violation will be displayed. */
3921
3923
  name?: NameInOther;
3922
3924
  }
3923
3925
  /** Specific line item violation. */
3924
- export interface TargetLineItem {
3926
+ interface TargetLineItem {
3925
3927
  /** Location on a checkout or a cart page where the specific line item violation will be displayed. */
3926
3928
  name?: NameInLineItem;
3927
3929
  /** ID of the line item containing the violation. */
3928
3930
  _id?: string | null;
3929
3931
  }
3930
- export interface CustomSettings {
3932
+ interface CustomSettings {
3931
3933
  /**
3932
3934
  * Whether to restrict the option to add or remove a gift card on the checkout page.
3933
3935
  *
@@ -3953,7 +3955,7 @@ export interface CustomSettings {
3953
3955
  */
3954
3956
  disabledManualPayment?: boolean;
3955
3957
  }
3956
- export interface CustomContentReference {
3958
+ interface CustomContentReference {
3957
3959
  /**
3958
3960
  * ID of the app providing the content.
3959
3961
  *
@@ -3969,7 +3971,7 @@ export interface CustomContentReference {
3969
3971
  */
3970
3972
  componentId?: string;
3971
3973
  }
3972
- export interface ExternalReference {
3974
+ interface ExternalReference {
3973
3975
  /**
3974
3976
  * ID of the app associated with the purchase flow.
3975
3977
  * For example, the Wix Pay Links app ID.
@@ -3986,7 +3988,7 @@ export interface ExternalReference {
3986
3988
  */
3987
3989
  resourceId?: string | null;
3988
3990
  }
3989
- export interface SubscriptionCharges {
3991
+ interface SubscriptionCharges {
3990
3992
  /**
3991
3993
  * ids of the items the subscription is defined on
3992
3994
  * @format GUID
@@ -4006,7 +4008,7 @@ export interface SubscriptionCharges {
4006
4008
  */
4007
4009
  charges?: Charge[];
4008
4010
  }
4009
- export interface Charge {
4011
+ interface Charge {
4010
4012
  /** The cycle number from which the charge starts. */
4011
4013
  cycleFrom?: number;
4012
4014
  /** The number of cycles for which the charge is applicable. */
@@ -4016,15 +4018,15 @@ export interface Charge {
4016
4018
  /** The billing date from which the charge starts. */
4017
4019
  cycleBillingDate?: Date | null;
4018
4020
  }
4019
- export interface GetPaymentSettingsForCheckoutResponse {
4021
+ interface GetPaymentSettingsForCheckoutResponse {
4020
4022
  /** Blocked payment options. */
4021
4023
  blockedPaymentOptions?: V1PaymentOption[];
4022
4024
  }
4023
- export declare enum V1PaymentOption {
4025
+ declare enum V1PaymentOption {
4024
4026
  UNKNOWN_PAYMENT_OPTION = "UNKNOWN_PAYMENT_OPTION",
4025
4027
  MANUAL = "MANUAL"
4026
4028
  }
4027
- export interface PaymentSettingsSPIConfig {
4029
+ interface PaymentSettingsSPIConfig {
4028
4030
  /**
4029
4031
  * *Required.** Base URI where the endpoints are called. Wix eCommerce appends the endpoint path to the base URI.
4030
4032
  * For example, to call the Get Payment Settings endpoint at `https://my-payment-settings.com/v1/payment-settings`,
@@ -4057,7 +4059,7 @@ export interface PaymentSettingsSPIConfig {
4057
4059
  * }
4058
4060
  * ```
4059
4061
  */
4060
- export interface Context {
4062
+ interface Context {
4061
4063
  /** 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. */
4062
4064
  requestId?: string | null;
4063
4065
  /**
@@ -4075,14 +4077,14 @@ export interface Context {
4075
4077
  */
4076
4078
  instanceId?: string | null;
4077
4079
  }
4078
- export declare enum IdentityType {
4080
+ declare enum IdentityType {
4079
4081
  UNKNOWN = "UNKNOWN",
4080
4082
  ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
4081
4083
  MEMBER = "MEMBER",
4082
4084
  WIX_USER = "WIX_USER",
4083
4085
  APP = "APP"
4084
4086
  }
4085
- export interface IdentificationData extends IdentificationDataIdOneOf {
4087
+ interface IdentificationData extends IdentificationDataIdOneOf {
4086
4088
  /**
4087
4089
  * ID of a site visitor that has not logged in to the site.
4088
4090
  * @format GUID
@@ -4107,7 +4109,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
4107
4109
  identityType?: IdentityType;
4108
4110
  }
4109
4111
  /** @oneof */
4110
- export interface IdentificationDataIdOneOf {
4112
+ interface IdentificationDataIdOneOf {
4111
4113
  /**
4112
4114
  * ID of a site visitor that has not logged in to the site.
4113
4115
  * @format GUID
@@ -4129,3 +4131,28 @@ export interface IdentificationDataIdOneOf {
4129
4131
  */
4130
4132
  appId?: string;
4131
4133
  }
4134
+
4135
+ interface GetPaymentSettingsEnvelope {
4136
+ request: GetPaymentSettingsRequest;
4137
+ metadata: Context;
4138
+ }
4139
+ interface GetPaymentSettingsForCheckoutEnvelope {
4140
+ request: GetPaymentSettingsForCheckoutRequest;
4141
+ metadata: Context;
4142
+ }
4143
+ declare const provideHandlers$1: ServicePluginDefinition<{
4144
+ /**
4145
+ *
4146
+ * This method retrieves payment settings from your app.
4147
+ *
4148
+ * Wix calls this method during the payment process. For example, when a customer inserts credit card details and places an order.
4149
+ * This method retrieves the payment settings to apply, and Wix passes on the settings to the payment provider. */
4150
+ getPaymentSettings(payload: GetPaymentSettingsEnvelope): GetPaymentSettingsResponse | Promise<GetPaymentSettingsResponse>;
4151
+ /**
4152
+ * Returns payment settings for provided Checkout entity. */
4153
+ getPaymentSettingsForCheckout(payload: GetPaymentSettingsForCheckoutEnvelope): GetPaymentSettingsForCheckoutResponse | Promise<GetPaymentSettingsForCheckoutResponse>;
4154
+ }>;
4155
+
4156
+ declare const provideHandlers: BuildServicePluginDefinition<typeof provideHandlers$1>;
4157
+
4158
+ export { type Activity, type ActivityContentOneOf, ActivityType, type AdditionalFee, AdditionalFeeSource, type Address, type AddressLocation, type AddressWithContact, AdjustmentType, type AggregatedTaxBreakdown, type ApiAddressWithContact, type ApplicableLineItems, type ApplicationError, type AppliedDiscount, type AppliedDiscountDiscountSourceOneOf, AppliedDiscountDiscountType, AttributionSource, type AuthorizedPaymentCaptured, type AuthorizedPaymentCreated, type AuthorizedPaymentVoided, type AutoTaxFallbackCalculationDetails, type Balance, type BalanceSummary, type BillingAdjustment, type BillingAdjustmentPriceSummary, type BuyerInfo, type BuyerInfoIdOneOf, type CalculationErrors, type CalculationErrorsShippingCalculationErrorOneOf, type Carrier, type CarrierError, type CarrierErrors, type CarrierServiceOption, type CatalogOverrideFields, type CatalogReference, type ChannelInfo, ChannelType, type Charge, ChargeType, type Checkout, type Color, type Context, type ConversionInfo, type Coupon, type CreatedBy, type CreatedByIdOneOf, type CreditCardDetails, type CurrencyConversionDetails, type CustomActivity, type CustomContentReference, type CustomField, type CustomSettings, type DeliveryAllocation, type DeliveryLogistics, type DeliveryLogisticsAddressOneOf, type DeliveryTimeSlot, type Description, type DescriptionLine, type DescriptionLineDescriptionLineValueOneOf, type DescriptionLineName, DescriptionLineType, type DescriptionLineValueOneOf, type Details, type DetailsKindOneOf, type DigitalFile, DiscountReason, type DiscountRule, type DiscountRuleName, DiscountType, type DraftOrderChangesApplied, type ExtendedFields, type ExternalReceipt, type ExternalReference, FallbackReason, type FieldViolation, FileType, type FocalPoint, type FreeTrialPeriod, FulfillmentStatus, type FulfillmentStatusesAggregate, type FullAddressContactDetails, type GetPaymentSettingsForCheckoutRequest, type GetPaymentSettingsForCheckoutResponse, type GetPaymentSettingsRequest, type GetPaymentSettingsResponse, type GiftCard, type GiftCardPaymentRefund, type Group, type IdentificationData, type IdentificationDataIdOneOf, IdentityType, type InvalidMembership, type ItemAvailabilityInfo, ItemAvailabilityStatus, type ItemModifier, type ItemTaxFullDetails, type ItemType, ItemTypeItemType, type ItemTypeItemTypeDataOneOf, JurisdictionType, type LineItem, type LineItemAmount, type LineItemChanges, type LineItemDiscount, type LineItemExchangeData, type LineItemPriceChange, type LineItemQuantityChange, LineItemQuantityChangeType, type LineItemTaxBreakdown, type LineItemTaxInfo, type Location, type LocationAndQuantity, type ManagedAdditionalFee, type ManagedDiscount, type ManagedLineItem, ManualCalculationReason, type Membership, type MembershipName, type MembershipOptions, type MembershipPaymentCredits, type MembershipPaymentRefund, type MerchantComment, type MerchantDiscount, type MerchantDiscountMerchantDiscountReasonOneOf, type ModifierGroup, type MultiCurrencyPrice, NameInLineItem, NameInOther, type NewExchangeOrderCreated, type Order, type OrderChange, type OrderChangeValueOneOf, type OrderCreatedFromExchange, type OrderLineItem, type OrderRefunded, OrderStatus, type OrderTaxBreakdown, type OrderTaxInfo, type Other, type OtherCharge, type PaymentCanceled, type PaymentCanceledPaymentDetailsOneOf, type PaymentDeclined, type PaymentDeclinedPaymentDetailsOneOf, type PaymentOption, PaymentOptionType, type PaymentPending, type PaymentPendingPaymentDetailsOneOf, type PaymentRefundFailed, type PaymentRefunded, type PaymentSettings, type PaymentSettingsSPIConfig, PaymentStatus, type PhysicalProperties, type PickupAddress, type PickupDetails, PickupDetailsPickupMethod, PickupMethod, type PlainTextValue, type Policy, type Price, type PriceDescription, type PriceSummary, type ProductName, RateType, type ReceiptCreated, type ReceiptCreatedReceiptInfoOneOf, type ReceiptSent, type ReceiptSentReceiptInfoOneOf, type RefundInitiated, type RefundedAsStoreCredit, type RefundedPayment, type RefundedPaymentKindOneOf, type Region, type RegularPayment, type RegularPaymentPaymentMethodDetailsOneOf, type RegularPaymentRefund, RuleType, type SavedPaymentMethod, type Scope, type SecuredMedia, type SelectedCarrierServiceOption, type SelectedCarrierServiceOptionOtherCharge, type SelectedCarrierServiceOptionPrices, type SelectedMembership, type SelectedMemberships, type ServiceProperties, Severity, type ShippingInfo, type ShippingInformation, type ShippingInformationChange, type ShippingOption, type ShippingPrice, type ShippingRegion, type StreetAddress, type SubscriptionCharges, type SubscriptionDescription, SubscriptionFrequency, type SubscriptionInfo, type SubscriptionOptionInfo, type SubscriptionSettings, type SubscriptionTitle, SuggestedFix, type SystemError, type TagList, type Tags, type Target, type TargetLineItem, type TargetTargetTypeOneOf, type TaxBreakdown, type TaxCalculationDetails, type TaxCalculationDetailsCalculationDetailsOneOf, type TaxRateBreakdown, type TaxSummary, type TaxableAddress, type TaxableAddressTaxableAddressDataOneOf, TaxableAddressType, type Title, type TotalPriceChange, type TranslatableString, type TranslatedValue, type V1AdditionalFee, type V1AppliedDiscount, type V1AppliedDiscountDiscountSourceOneOf, type V1BuyerInfo, type V1BuyerInfoIdOneOf, type V1Coupon, type V1CreatedBy, type V1CreatedByStringOneOf, type V1DeliveryLogistics, type V1DeliveryTimeSlot, type V1DiscountRule, type V1DiscountRuleName, type V1FreeTrialPeriod, type V1ItemModifier, type V1ItemTaxFullDetails, V1JurisdictionType, type V1LineItemDiscount, type V1MerchantDiscount, type V1ModifierGroup, V1PaymentOption, type V1PickupDetails, type V1PriceSummary, type V1ShippingInformation, type V1ShippingPrice, type V1ShippingRegion, type V1SubscriptionSettings, type V1TaxSummary, type ValidationError, type VatId, VatType, type Violation, WeightUnit, type WixReceipt, provideHandlers, provideHandlers$1 as publicProvideHandlers };